Skip to content

Improvements to the model zoo's GUI tab #2431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexEMG merged 8 commits into from
Nov 7, 2023
Merged

Improvements to the model zoo's GUI tab #2431

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2bce680
Add more control widgets
jeylau Oct 31, 2023
58a7762
Move video adaptation to a separate thread
jeylau Oct 31, 2023
2e87686
Add help button showing the docstrings
jeylau Nov 1, 2023
4f456c1
Remove scale list box
jeylau Nov 3, 2023
8d2590d
Revert "Remove scale list box"
jeylau Nov 3, 2023
51107c0
Make help dialog scrollable
jeylau Nov 3, 2023
143e9ec
Add tooltip
jeylau Nov 3, 2023
6a9868d
Explain default values
jeylau Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 71 additions & 3 deletions deeplabcut/gui/tabs/modelzoo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,21 @@
#
# Licensed under GNU Lesser General Public License v3.0
#
import os
from functools import partial

import deeplabcut
from PySide6 import QtWidgets
from PySide6.QtCore import Qt, Signal, QTimer, QRegularExpression
from PySide6.QtGui import QRegularExpressionValidator
from PySide6.QtGui import QPixmap, QRegularExpressionValidator
from deeplabcut.gui.components import (
DefaultTab,
VideoSelectionWidget,
_create_label_widget,
_create_grid_layout,
)
from deeplabcut.gui import BASE_DIR
from deeplabcut.gui.utils import move_to_separate_thread
from deeplabcut.modelzoo.utils import parse_available_supermodels


Expand Down Expand Up @@ -65,17 +70,70 @@ def _set_page(self):
validator.validationChanged.connect(self._handle_validation_change)
self.scales_line.setValidator(validator)

tooltip_label = QtWidgets.QLabel()
tooltip_label.setPixmap(
QPixmap(os.path.join(BASE_DIR, "assets", "icons", "help2.png")).scaledToWidth(30)
)
tooltip_label.setToolTip(
"Approximate animal sizes in pixels, for spatial pyramid search. If left blank, defaults to video height +/- 50 pixels",
)

self.adapt_checkbox = QtWidgets.QCheckBox("Use video adaptation")
self.adapt_checkbox.setChecked(True)

pseudo_threshold_label = QtWidgets.QLabel("Pseudo-label confidence threshold")
self.pseudo_threshold_spinbox = QtWidgets.QDoubleSpinBox(
decimals=2,
minimum=0.01,
maximum=1.0,
singleStep=0.05,
value=0.1,
wrapping=True,
)
self.pseudo_threshold_spinbox.setMaximumWidth(300)

adapt_iter_label = QtWidgets.QLabel("Number of adaptation iterations")
self.adapt_iter_spinbox = QtWidgets.QSpinBox()
self.adapt_iter_spinbox.setRange(100, 10000)
self.adapt_iter_spinbox.setValue(1000)
self.adapt_iter_spinbox.setSingleStep(100)
self.adapt_iter_spinbox.setGroupSeparatorShown(True)
self.adapt_iter_spinbox.setMaximumWidth(300)

model_settings_layout.addWidget(section_title, 0, 0)
model_settings_layout.addWidget(model_combo_text, 1, 0)
model_settings_layout.addWidget(self.model_combo, 1, 1)
model_settings_layout.addWidget(scales_label, 2, 0)
model_settings_layout.addWidget(self.scales_line, 2, 1)
model_settings_layout.addWidget(tooltip_label, 2, 2)
model_settings_layout.addWidget(self.adapt_checkbox, 3, 0)
model_settings_layout.addWidget(pseudo_threshold_label, 4, 0)
model_settings_layout.addWidget(self.pseudo_threshold_spinbox, 4, 1)
model_settings_layout.addWidget(adapt_iter_label, 5, 0)
model_settings_layout.addWidget(self.adapt_iter_spinbox, 5, 1)
self.main_layout.addLayout(model_settings_layout)

self.run_button = QtWidgets.QPushButton("Run")
self.run_button.clicked.connect(self.run_video_adaptation)
self.main_layout.addWidget(self.run_button, alignment=Qt.AlignRight)

self.help_button = QtWidgets.QPushButton("Help")
self.help_button.clicked.connect(self.show_help_dialog)
self.main_layout.addWidget(self.help_button, alignment=Qt.AlignLeft)

def show_help_dialog(self):
dialog = QtWidgets.QDialog(self)
layout = QtWidgets.QVBoxLayout()
label = QtWidgets.QLabel(deeplabcut.video_inference_superanimal.__doc__, self)
scroll = QtWidgets.QScrollArea()
scroll.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOn)
scroll.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
scroll.setWidgetResizable(True)
scroll.setWidget(label)
layout.addWidget(scroll)
dialog.setLayout(layout)
dialog.exec_()

def _handle_validation_change(self, state):
if state == RegExpValidator.Invalid:
color = "red"
Expand Down Expand Up @@ -109,10 +167,20 @@ def run_video_adaptation(self):
supermodel_name = self.model_combo.currentText()
videotype = self.video_selection_widget.videotype_widget.currentText()

deeplabcut.video_inference_superanimal(
func = partial(
deeplabcut.video_inference_superanimal,
videos,
supermodel_name,
videotype=videotype,
video_adapt=True,
video_adapt=self.adapt_checkbox.isChecked(),
scale_list=scales,
pseudo_threshold=self.pseudo_threshold_spinbox.value(),
adapt_iterations=self.adapt_iter_spinbox.value(),
)

self.worker, self.thread = move_to_separate_thread(func)
self.worker.finished.connect(lambda: self.run_button.setEnabled(True))
self.worker.finished.connect(lambda: self.root._progress_bar.hide())
self.thread.start()
self.run_button.setEnabled(False)
self.root._progress_bar.show()