accusleepy 0.7.2__tar.gz → 0.8.0__tar.gz

{accusleepy-0.7.2 → accusleepy-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: accusleepy
-Version: 0.7.2
+Version: 0.8.0
 Summary: Python implementation of AccuSleep
 License: GPL-3.0-only
 Author: Zeke Barger
@@ -18,7 +18,7 @@ Requires-Dist: numpy (>=2.2.4,<3.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)
 Requires-Dist: pillow (>=11.1.0,<12.0.0)
 Requires-Dist: pre-commit (>=4.2.0,<5.0.0)
-Requires-Dist: pyside6 (==6.9.0)
+Requires-Dist: pyside6 (>=6.9.0,<6.9.3)
 Requires-Dist: scipy (>=1.15.2,<2.0.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: torch (>=2.8.0,<3.0.0)
@@ -74,10 +74,14 @@ to the [config file](accusleepy/config.json).
 
 [Guide to the manual scoring interface](accusleepy/gui/text/manual_scoring_guide.md)
 
+## Developer guide
+If you want to contribute to the project or modify the code for your own use,
+please consult the [developer guide](accusleepy/gui/text/dev_guide.md).
+
 ## Changelog
 
-- 0.7.2: Address issues with certain dependencies
-- 0.7.1: Bugfixes, code cleanup
+- 0.8.0: More configurable settings, visual improvements
+- 0.7.1-0.7.3: Bugfixes, code cleanup
 - 0.7.0: More settings can be configured in the UI
 - 0.6.0: Confidence scores can now be displayed and saved. Retraining your models is recommended
     since the new calibration feature will make the confidence scores more accurate.

{accusleepy-0.7.2 → accusleepy-0.8.0}/README.md

@@ -46,10 +46,14 @@ to the [config file](accusleepy/config.json).
 
 [Guide to the manual scoring interface](accusleepy/gui/text/manual_scoring_guide.md)
 
+## Developer guide
+If you want to contribute to the project or modify the code for your own use,
+please consult the [developer guide](accusleepy/gui/text/dev_guide.md).
+
 ## Changelog
 
-- 0.7.2: Address issues with certain dependencies
-- 0.7.1: Bugfixes, code cleanup
+- 0.8.0: More configurable settings, visual improvements
+- 0.7.1-0.7.3: Bugfixes, code cleanup
 - 0.7.0: More settings can be configured in the UI
 - 0.6.0: Confidence scores can now be displayed and saved. Retraining your models is recommended
     since the new calibration feature will make the confidence scores more accurate.

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/config.json

@@ -33,5 +33,7 @@
         "learning_rate": 0.001,
         "momentum": 0.9,
         "training_epochs": 6
-    }
+    },
+    "epochs_to_show": 5,
+    "autoscroll_state": false
 }

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/constants.py

@@ -67,6 +67,8 @@ DEFAULT_OVERWRITE_KEY = "default_overwrite_setting"
 EMG_FILTER_KEY = "emg_filter"
 # model training hyperparameters key
 HYPERPARAMETERS_KEY = "hyperparameters"
+EPOCHS_TO_SHOW_KEY = "epochs_to_show"
+AUTOSCROLL_KEY = "autoscroll_state"
 
 # default values
 # default UI settings
@@ -82,3 +84,6 @@ DEFAULT_BATCH_SIZE = 64
 DEFAULT_LEARNING_RATE = 1e-3
 DEFAULT_MOMENTUM = 0.9
 DEFAULT_TRAINING_EPOCHS = 6
+# default manual scoring settings
+DEFAULT_EPOCHS_TO_SHOW = 5
+DEFAULT_AUTOSCROLL_STATE = False

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/fileio.py

@@ -112,7 +112,15 @@ def save_labels(
 
 
 def load_config() -> tuple[
-    BrainStateSet, int | float, bool, bool, int | float, EMGFilter, Hyperparameters
+    BrainStateSet,
+    int | float,
+    bool,
+    bool,
+    int | float,
+    EMGFilter,
+    Hyperparameters,
+    int,
+    bool,
 ]:
     """Load configuration file with brain state options
 
@@ -122,7 +130,9 @@ def load_config() -> tuple[
         default confidence score output setting,
         default minimum bout length,
         EMG filter parameters,
-        model training hyperparameters
+        model training hyperparameters,
+        default epochs to show for manual scoring,
+        default autoscroll state for manual scoring
     """
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), c.CONFIG_FILE), "r"
@@ -158,6 +168,8 @@ def load_config() -> tuple[
                 },
             )
         ),
+        data.get(c.EPOCHS_TO_SHOW_KEY, c.DEFAULT_EPOCHS_TO_SHOW),
+        data.get(c.AUTOSCROLL_KEY, c.DEFAULT_AUTOSCROLL_STATE),
     )
 
 
@@ -169,6 +181,8 @@ def save_config(
     min_bout_length: int | float,
     emg_filter: EMGFilter,
     hyperparameters: Hyperparameters,
+    epochs_to_show: int,
+    autoscroll_state: bool,
 ) -> None:
     """Save configuration of brain state options to json file
 
@@ -181,6 +195,8 @@ def save_config(
     :param overwrite_setting: default setting for overwriting
         existing labels
     :param hyperparameters: model training hyperparameters
+    :param epochs_to_show: default epochs to show for manual scoring,
+    :param autoscroll_state: default autoscroll state for manual scoring
     """
     output_dict = brain_state_set.to_output_dict()
     output_dict.update({c.DEFAULT_EPOCH_LENGTH_KEY: default_epoch_length})
@@ -189,6 +205,8 @@ def save_config(
     output_dict.update({c.DEFAULT_MIN_BOUT_LENGTH_KEY: min_bout_length})
     output_dict.update({c.EMG_FILTER_KEY: emg_filter.__dict__})
     output_dict.update({c.HYPERPARAMETERS_KEY: hyperparameters.__dict__})
+    output_dict.update({c.EPOCHS_TO_SHOW_KEY: epochs_to_show})
+    output_dict.update({c.AUTOSCROLL_KEY: autoscroll_state})
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), c.CONFIG_FILE), "w"
     ) as f:

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/gui/main.py

@@ -81,6 +81,11 @@ from accusleepy.validation import (
 
 # note: functions using torch or scipy are lazily imported
 
+# on Windows, prevent dark mode from changing the visual style
+if os.name == "nt":
+    sys.argv += ["-platform", "windows:darkmode=0"]
+
+
 # relative path to user manual
 MAIN_GUIDE_FILE = os.path.normpath(r"text/main_guide.md")
 
@@ -116,6 +121,8 @@ class AccuSleepWindow(QMainWindow):
             self.min_bout_length,
             self.emg_filter,
             self.hyperparameters,
+            self.default_epochs_to_show,
+            self.default_autoscroll_state,
         ) = load_config()
 
         self.settings_widgets = None
@@ -1238,6 +1245,8 @@ class AccuSleepWindow(QMainWindow):
         self.ui.overwrite_default_checkbox.setChecked(self.only_overwrite_undefined)
         self.ui.confidence_setting_checkbox.setChecked(self.save_confidence_scores)
         self.ui.default_min_bout_length_spinbox.setValue(self.min_bout_length)
+        self.ui.epochs_to_show_spinbox.setValue(self.default_epochs_to_show)
+        self.ui.autoscroll_checkbox.setChecked(self.default_autoscroll_state)
         # EMG filter
         self.ui.emg_order_spinbox.setValue(self.emg_filter.order)
         self.ui.bp_lower_spinbox.setValue(self.emg_filter.bp_lower)
@@ -1439,6 +1448,8 @@ class AccuSleepWindow(QMainWindow):
                 momentum=self.hyperparameters.momentum,
                 training_epochs=self.hyperparameters.training_epochs,
             ),
+            epochs_to_show=self.ui.epochs_to_show_spinbox.value(),
+            autoscroll_state=self.ui.autoscroll_checkbox.isChecked(),
         )
         self.ui.save_config_status.setText("configuration saved")
 

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/gui/manual_scoring.py

@@ -140,10 +140,17 @@ class ManualScoringWindow(QDialog):
         self.setWindowTitle("AccuSleePy manual scoring window")
 
         # load set of valid brain states
-        self.brain_state_set, _, _, _, _, _, _ = load_config()
-
-        # initial setting for number of epochs to show in the lower plot
-        self.epochs_to_show = 5
+        (
+            self.brain_state_set,
+            _,
+            _,
+            _,
+            _,
+            _,
+            _,
+            self.epochs_to_show,
+            self.autoscroll_state,
+        ) = load_config()
 
         # find the set of y-axis locations of valid brain state labels
         self.label_display_options = convert_labels(
@@ -216,7 +223,11 @@ class ManualScoringWindow(QDialog):
         self.emg_signal_offset = 0
         self.roi_brain_state = 0
         self.label_roi_mode = False
-        self.autoscroll_state = False
+
+        # set autoscroll state and epochs to show, based on defaults
+        self.ui.autoscroll.setChecked(self.autoscroll_state)
+        self.ui.shownepochslabel.setText(str(self.epochs_to_show))
+
         # keep track of save state to warn user when they quit
         self.last_saved_labels = copy.deepcopy(self.labels)
 

{accusleepy-0.7.2 → accusleepy-0.8.0}/accusleepy/gui/primary_window.py

@@ -3,25 +3,13 @@
 ################################################################################
 ## Form generated from reading UI file 'primary_window.ui'
 ##
-## Created by: Qt User Interface Compiler version 6.9.1
+## Created by: Qt User Interface Compiler version 6.9.0
 ##
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################
 
-from PySide6.QtCore import (
-    QCoreApplication,
-    QMetaObject,
-    QRect,
-    QSize,
-    Qt,
-)
-from PySide6.QtGui import (
-    QBrush,
-    QColor,
-    QFont,
-    QIcon,
-    QPalette,
-)
+from PySide6.QtCore import QCoreApplication, QMetaObject, QRect, QSize, Qt
+from PySide6.QtGui import QBrush, QColor, QFont, QIcon, QPalette
 from PySide6.QtWidgets import (
     QCheckBox,
     QComboBox,
@@ -676,7 +664,6 @@ class Ui_PrimaryWindow(object):
             self.overwritecheckbox.sizePolicy().hasHeightForWidth()
         )
         self.overwritecheckbox.setSizePolicy(sizePolicy1)
-        self.overwritecheckbox.setStyleSheet("background-color: transparent;")
 
         self.classification_options_layout.addWidget(self.overwritecheckbox)
 
@@ -692,7 +679,6 @@ class Ui_PrimaryWindow(object):
             self.save_confidence_checkbox.sizePolicy().hasHeightForWidth()
         )
         self.save_confidence_checkbox.setSizePolicy(sizePolicy1)
-        self.save_confidence_checkbox.setStyleSheet("background-color: transparent;")
 
         self.classification_options_layout.addWidget(self.save_confidence_checkbox)
 
@@ -2238,20 +2224,25 @@ class Ui_PrimaryWindow(object):
         self.horizontalLayout_81.setSpacing(20)
         self.horizontalLayout_81.setObjectName("horizontalLayout_81")
         self.verticalLayout_6 = QVBoxLayout()
-        self.verticalLayout_6.setSpacing(10)
+        self.verticalLayout_6.setSpacing(20)
         self.verticalLayout_6.setObjectName("verticalLayout_6")
+        self.primary_defaults_groupbox = QGroupBox(self.ui_default_page)
+        self.primary_defaults_groupbox.setObjectName("primary_defaults_groupbox")
+        self.verticalLayout_4 = QVBoxLayout(self.primary_defaults_groupbox)
+        self.verticalLayout_4.setSpacing(10)
+        self.verticalLayout_4.setObjectName("verticalLayout_4")
         self.default_epoch_layout = QHBoxLayout()
         self.default_epoch_layout.setObjectName("default_epoch_layout")
         self.horizontalLayout_60 = QHBoxLayout()
         self.horizontalLayout_60.setObjectName("horizontalLayout_60")
-        self.label_17 = QLabel(self.ui_default_page)
+        self.label_17 = QLabel(self.primary_defaults_groupbox)
         self.label_17.setObjectName("label_17")
         sizePolicy1.setHeightForWidth(self.label_17.sizePolicy().hasHeightForWidth())
         self.label_17.setSizePolicy(sizePolicy1)
 
         self.horizontalLayout_60.addWidget(self.label_17)
 
-        self.default_epoch_input = QDoubleSpinBox(self.ui_default_page)
+        self.default_epoch_input = QDoubleSpinBox(self.primary_defaults_groupbox)
         self.default_epoch_input.setObjectName("default_epoch_input")
         sizePolicy1.setHeightForWidth(
             self.default_epoch_input.sizePolicy().hasHeightForWidth()
@@ -2270,13 +2261,13 @@ class Ui_PrimaryWindow(object):
 
         self.default_epoch_layout.addItem(self.horizontalSpacer_70)
 
-        self.verticalLayout_6.addLayout(self.default_epoch_layout)
+        self.verticalLayout_4.addLayout(self.default_epoch_layout)
 
         self.horizontalLayout_75 = QHBoxLayout()
         self.horizontalLayout_75.setObjectName("horizontalLayout_75")
         self.horizontalLayout_76 = QHBoxLayout()
         self.horizontalLayout_76.setObjectName("horizontalLayout_76")
-        self.overwrite_default_checkbox = QCheckBox(self.ui_default_page)
+        self.overwrite_default_checkbox = QCheckBox(self.primary_defaults_groupbox)
         self.overwrite_default_checkbox.setObjectName("overwrite_default_checkbox")
 
         self.horizontalLayout_76.addWidget(self.overwrite_default_checkbox)
@@ -2289,7 +2280,7 @@ class Ui_PrimaryWindow(object):
 
         self.horizontalLayout_75.addItem(self.horizontalSpacer_88)
 
-        self.verticalLayout_6.addLayout(self.horizontalLayout_75)
+        self.verticalLayout_4.addLayout(self.horizontalLayout_75)
 
         self.confidence_score_setting_layout = QHBoxLayout()
         self.confidence_score_setting_layout.setObjectName(
@@ -2297,7 +2288,7 @@ class Ui_PrimaryWindow(object):
         )
         self.horizontalLayout_62 = QHBoxLayout()
         self.horizontalLayout_62.setObjectName("horizontalLayout_62")
-        self.confidence_setting_checkbox = QCheckBox(self.ui_default_page)
+        self.confidence_setting_checkbox = QCheckBox(self.primary_defaults_groupbox)
         self.confidence_setting_checkbox.setObjectName("confidence_setting_checkbox")
         sizePolicy1.setHeightForWidth(
             self.confidence_setting_checkbox.sizePolicy().hasHeightForWidth()
@@ -2315,20 +2306,22 @@ class Ui_PrimaryWindow(object):
 
         self.confidence_score_setting_layout.addItem(self.horizontalSpacer_72)
 
-        self.verticalLayout_6.addLayout(self.confidence_score_setting_layout)
+        self.verticalLayout_4.addLayout(self.confidence_score_setting_layout)
 
         self.horizontalLayout_2 = QHBoxLayout()
         self.horizontalLayout_2.setObjectName("horizontalLayout_2")
         self.horizontalLayout_18 = QHBoxLayout()
         self.horizontalLayout_18.setObjectName("horizontalLayout_18")
-        self.label_19 = QLabel(self.ui_default_page)
+        self.label_19 = QLabel(self.primary_defaults_groupbox)
         self.label_19.setObjectName("label_19")
         sizePolicy1.setHeightForWidth(self.label_19.sizePolicy().hasHeightForWidth())
         self.label_19.setSizePolicy(sizePolicy1)
 
         self.horizontalLayout_18.addWidget(self.label_19)
 
-        self.default_min_bout_length_spinbox = QDoubleSpinBox(self.ui_default_page)
+        self.default_min_bout_length_spinbox = QDoubleSpinBox(
+            self.primary_defaults_groupbox
+        )
         self.default_min_bout_length_spinbox.setObjectName(
             "default_min_bout_length_spinbox"
         )
@@ -2349,7 +2342,68 @@ class Ui_PrimaryWindow(object):
 
         self.horizontalLayout_2.addItem(self.horizontalSpacer_90)
 
-        self.verticalLayout_6.addLayout(self.horizontalLayout_2)
+        self.verticalLayout_4.addLayout(self.horizontalLayout_2)
+
+        self.verticalLayout_6.addWidget(self.primary_defaults_groupbox)
+
+        self.manual_defaults_groupbox = QGroupBox(self.ui_default_page)
+        self.manual_defaults_groupbox.setObjectName("manual_defaults_groupbox")
+        self.verticalLayout_7 = QVBoxLayout(self.manual_defaults_groupbox)
+        self.verticalLayout_7.setSpacing(10)
+        self.verticalLayout_7.setObjectName("verticalLayout_7")
+        self.epochs_to_show_layout = QHBoxLayout()
+        self.epochs_to_show_layout.setObjectName("epochs_to_show_layout")
+        self.horizontalLayout_78 = QHBoxLayout()
+        self.horizontalLayout_78.setObjectName("horizontalLayout_78")
+        self.label_20 = QLabel(self.manual_defaults_groupbox)
+        self.label_20.setObjectName("label_20")
+        sizePolicy1.setHeightForWidth(self.label_20.sizePolicy().hasHeightForWidth())
+        self.label_20.setSizePolicy(sizePolicy1)
+
+        self.horizontalLayout_78.addWidget(self.label_20)
+
+        self.epochs_to_show_spinbox = QSpinBox(self.manual_defaults_groupbox)
+        self.epochs_to_show_spinbox.setObjectName("epochs_to_show_spinbox")
+        self.epochs_to_show_spinbox.setMinimum(3)
+        self.epochs_to_show_spinbox.setSingleStep(2)
+        self.epochs_to_show_spinbox.setValue(5)
+
+        self.horizontalLayout_78.addWidget(self.epochs_to_show_spinbox)
+
+        self.epochs_to_show_layout.addLayout(self.horizontalLayout_78)
+
+        self.horizontalSpacer_92 = QSpacerItem(
+            40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum
+        )
+
+        self.epochs_to_show_layout.addItem(self.horizontalSpacer_92)
+
+        self.verticalLayout_7.addLayout(self.epochs_to_show_layout)
+
+        self.autoscroll_layout = QHBoxLayout()
+        self.autoscroll_layout.setObjectName("autoscroll_layout")
+        self.horizontalLayout_77 = QHBoxLayout()
+        self.horizontalLayout_77.setObjectName("horizontalLayout_77")
+        self.autoscroll_checkbox = QCheckBox(self.manual_defaults_groupbox)
+        self.autoscroll_checkbox.setObjectName("autoscroll_checkbox")
+        sizePolicy1.setHeightForWidth(
+            self.autoscroll_checkbox.sizePolicy().hasHeightForWidth()
+        )
+        self.autoscroll_checkbox.setSizePolicy(sizePolicy1)
+
+        self.horizontalLayout_77.addWidget(self.autoscroll_checkbox)
+
+        self.autoscroll_layout.addLayout(self.horizontalLayout_77)
+
+        self.horizontalSpacer_91 = QSpacerItem(
+            10, 10, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum
+        )
+
+        self.autoscroll_layout.addItem(self.horizontalSpacer_91)
+
+        self.verticalLayout_7.addLayout(self.autoscroll_layout)
+
+        self.verticalLayout_6.addWidget(self.manual_defaults_groupbox)
 
         self.verticalSpacer_5 = QSpacerItem(
             5, 5, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding
@@ -3112,32 +3166,96 @@ class Ui_PrimaryWindow(object):
                 None,
             )
         )
+        self.primary_defaults_groupbox.setTitle(
+            QCoreApplication.translate("PrimaryWindow", "Primary window settings", None)
+        )
         self.label_17.setText(
             QCoreApplication.translate("PrimaryWindow", "Epoch length:", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.default_epoch_input.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow",
+                "This sets the temporal resolution for sleep scoring",
+                None,
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.default_epoch_input.setSuffix(
             QCoreApplication.translate("PrimaryWindow", " sec", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.overwrite_default_checkbox.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow",
+                "During automated scoring, only overwrite epochs with the undefined brain state",
+                None,
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.overwrite_default_checkbox.setText(
             QCoreApplication.translate(
                 "PrimaryWindow", "Only overwrite undefined epochs", None
             )
         )
+        # if QT_CONFIG(tooltip)
+        self.confidence_setting_checkbox.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow",
+                "Save the model's confidence scores in label files",
+                None,
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.confidence_setting_checkbox.setText(
             QCoreApplication.translate("PrimaryWindow", "Save confidence scores", None)
         )
         self.label_19.setText(
             QCoreApplication.translate("PrimaryWindow", "Minimum bout length:", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.default_min_bout_length_spinbox.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow",
+                "Minimum allowed duration for a bout of any brain state",
+                None,
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.default_min_bout_length_spinbox.setSuffix(
             QCoreApplication.translate("PrimaryWindow", " sec", None)
         )
+        self.manual_defaults_groupbox.setTitle(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Manual scoring window settings", None
+            )
+        )
+        self.label_20.setText(
+            QCoreApplication.translate("PrimaryWindow", "Epochs to show", None)
+        )
+        # if QT_CONFIG(tooltip)
+        self.epochs_to_show_spinbox.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Number of epochs to display in the lower plots", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
+        # if QT_CONFIG(tooltip)
+        self.autoscroll_checkbox.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow",
+                "After scoring each epoch, automatically advance to the next one",
+                None,
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
+        self.autoscroll_checkbox.setText(
+            QCoreApplication.translate("PrimaryWindow", "Auto scroll", None)
+        )
         self.ui_default_description_label.setText(
             QCoreApplication.translate(
                 "PrimaryWindow",
-                "These are the default values/settings that are shown in the primary UI window when it starts up.\n"
-                "\n"
-                'Changes here will not affect the **current** state of the controls in the "Sleep scoring" tab.',
+                "<html><head/><body><p>These are the default values/settings that are shown in the primary window and manual scoring window when they start up.</p><p>Changes here will not affect the **current** state of the controls in the &quot;Sleep scoring&quot; tab.</p></body></html>",
                 None,
             )
         )