accusleepy 0.9.2__tar.gz → 0.10.0__tar.gz

{accusleepy-0.9.2 → accusleepy-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: accusleepy
-Version: 0.9.2
+Version: 0.10.0
 Summary: Python implementation of AccuSleep
 License: GPL-3.0-only
 Author: Zeke Barger
@@ -20,7 +20,6 @@ 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,<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)
 Requires-Dist: torchvision (>=0.23.0,<1.0.0)
 Requires-Dist: tqdm (>=4.67.1,<5.0.0)
@@ -80,7 +79,8 @@ please consult the [developer guide](accusleepy/gui/text/dev_guide.md).
 
 ## Changelog
 
-- 0.8.1-0.9.2: Improved error handling and code quality
+- 0.10.0: Improved zoom behavior
+- 0.8.1-0.9.3: Improved error handling and code quality
 - 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

{accusleepy-0.9.2 → accusleepy-0.10.0}/README.md

@@ -52,7 +52,8 @@ please consult the [developer guide](accusleepy/gui/text/dev_guide.md).
 
 ## Changelog
 
-- 0.8.1-0.9.2: Improved error handling and code quality
+- 0.10.0: Improved zoom behavior
+- 0.8.1-0.9.3: Improved error handling and code quality
 - 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

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/config.json

@@ -35,5 +35,6 @@
         "training_epochs": 6
     },
     "epochs_to_show": 5,
-    "autoscroll_state": false
+    "autoscroll_state": false,
+    "delete_training_images": true
 }

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/constants.py

@@ -72,6 +72,7 @@ EMG_FILTER_KEY = "emg_filter"
 HYPERPARAMETERS_KEY = "hyperparameters"
 EPOCHS_TO_SHOW_KEY = "epochs_to_show"
 AUTOSCROLL_KEY = "autoscroll_state"
+DELETE_TRAINING_IMAGES_KEY = "delete_training_images"
 
 # default values
 # default UI settings
@@ -87,6 +88,7 @@ DEFAULT_BATCH_SIZE = 64
 DEFAULT_LEARNING_RATE = 1e-3
 DEFAULT_MOMENTUM = 0.9
 DEFAULT_TRAINING_EPOCHS = 6
+DEFAULT_DELETE_TRAINING_IMAGES_STATE = True
 # default manual scoring settings
 DEFAULT_EPOCHS_TO_SHOW = 5
 DEFAULT_AUTOSCROLL_STATE = False

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/fileio.py

@@ -1,11 +1,11 @@
 import json
 import os
 from dataclasses import dataclass
+from importlib.metadata import version, PackageNotFoundError
 
 import numpy as np
 import pandas as pd
 from PySide6.QtWidgets import QListWidgetItem
-import toml
 
 from accusleepy.brain_state_set import BRAIN_STATES_KEY, BrainState, BrainStateSet
 import accusleepy.constants as c
@@ -43,6 +43,7 @@ class AccuSleePyConfig:
     hyperparameters: Hyperparameters
     epochs_to_show: int
     autoscroll_state: bool
+    delete_training_images: bool
 
 
 @dataclass
@@ -139,7 +140,8 @@ def load_config() -> AccuSleePyConfig:
         EMG filter parameters,
         model training hyperparameters,
         default epochs to show for manual scoring,
-        default autoscroll state for manual scoring
+        default autoscroll state for manual scoring,
+        setting to delete training images automatically
     """
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), c.CONFIG_FILE), "r"
@@ -183,6 +185,9 @@ def load_config() -> AccuSleePyConfig:
         ),
         epochs_to_show=data.get(c.EPOCHS_TO_SHOW_KEY, c.DEFAULT_EPOCHS_TO_SHOW),
         autoscroll_state=data.get(c.AUTOSCROLL_KEY, c.DEFAULT_AUTOSCROLL_STATE),
+        delete_training_images=data.get(
+            c.DELETE_TRAINING_IMAGES_KEY, c.DEFAULT_DELETE_TRAINING_IMAGES_STATE
+        ),
     )
 
 
@@ -196,6 +201,7 @@ def save_config(
     hyperparameters: Hyperparameters,
     epochs_to_show: int,
     autoscroll_state: bool,
+    delete_training_images: bool,
 ) -> None:
     """Save configuration of brain state options to json file
 
@@ -210,6 +216,8 @@ def save_config(
     :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
+    :param delete_training_images: whether to automatically delete images
+        created for model training once training is complete
     """
     output_dict = brain_state_set.to_output_dict()
     output_dict.update({c.DEFAULT_EPOCH_LENGTH_KEY: default_epoch_length})
@@ -220,6 +228,7 @@ def save_config(
     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})
+    output_dict.update({c.DELETE_TRAINING_IMAGES_KEY: delete_training_images})
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), c.CONFIG_FILE), "w"
     ) as f:
@@ -267,13 +276,7 @@ def get_version() -> str:
 
     :return: AccuSleePy package version
     """
-    version = ""
-    toml_file = os.path.join(
-        os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
-        "pyproject.toml",
-    )
-    if os.path.isfile(toml_file):
-        toml_data = toml.load(toml_file)
-        if "project" in toml_data and "version" in toml_data["project"]:
-            version = toml_data["project"]["version"]
-    return version
+    try:
+        return version("accusleepy")
+    except PackageNotFoundError:
+        return ""

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/main.py

@@ -76,7 +76,6 @@ class TrainingSettings:
     """Settings for training a new model"""
 
     epochs_per_img: int = 9
-    delete_images: bool = True
     model_type: str = DEFAULT_MODEL_TYPE
     calibrate: bool = True
 
@@ -176,9 +175,6 @@ class AccuSleepWindow(QMainWindow):
         self.ui.image_number_input.valueChanged.connect(
             lambda v: setattr(self.training, "epochs_per_img", v)
         )
-        self.ui.delete_image_box.stateChanged.connect(
-            lambda v: setattr(self.training, "delete_images", bool(v))
-        )
         self.ui.calibrate_checkbox.stateChanged.connect(
             self.update_training_calibration
         )
@@ -304,7 +300,7 @@ class AccuSleepWindow(QMainWindow):
             emg_filter=self.config.emg_filter,
             hyperparameters=self.config.hyperparameters,
             model_filename=model_filename,
-            delete_images=self.training.delete_images,
+            delete_images=self.config.delete_training_images,
         )
 
         # Display results

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/manual_scoring.py

@@ -6,6 +6,7 @@
 
 import copy
 import os
+import time
 from dataclasses import dataclass
 from functools import partial
 from types import SimpleNamespace
@@ -82,9 +83,10 @@ UNDO_LIMIT = 1000
 # brightness scaling factors for the spectrogram
 BRIGHTER_SCALE_FACTOR = 0.96
 DIMMER_SCALE_FACTOR = 1.07
-# zoom factor for upper plots
-ZOOM_IN_FACTOR = 0.45
-ZOOM_OUT_FACTOR = 1.017
+# zoom factor for upper plots - larger values = bigger changes
+ZOOM_FACTOR = 0.1
+# interval in seconds between zoom events triggered by scrolling
+ZOOM_DELAY = 0.05
 
 
 @dataclass
@@ -352,8 +354,10 @@ class ManualScoringWindow(QDialog):
         )
         keypress_redo.activated.connect(self.redo)
 
-        # user input: clicks
+        # user input: mouse events
         self.ui.upperfigure.canvas.mpl_connect("button_press_event", self.click_to_jump)
+        self.ui.upperfigure.canvas.mpl_connect("scroll_event", self.scroll_zoom)
+        self.now_zooming = False  # impose timeout on zoom events
 
         # user input: buttons
         self.ui.savebutton.clicked.connect(self.save)
@@ -483,7 +487,7 @@ class ManualScoringWindow(QDialog):
 
     def closeEvent(self, event: QCloseEvent) -> None:
         """Check if there are unsaved changes before closing"""
-        if not all(self.labels == self.last_saved_labels):
+        if not np.array_equal(self.labels, self.last_saved_labels):
             result = QMessageBox.question(
                 self,
                 "Unsaved changes",
@@ -668,6 +672,8 @@ class ManualScoringWindow(QDialog):
             self.label_display_options,
         )
         self.update_figures()
+        # upper plot x limits might need to change
+        self.zoom_x(direction=None)
 
     def update_signal_offset(self, signal: str, direction: str) -> None:
         """Shift EEG or EMG up or down
@@ -713,39 +719,19 @@ class ManualScoringWindow(QDialog):
             (self.upper_left_epoch, self.upper_right_epoch + 1)
         )
 
-    def zoom_x(self, direction: str) -> None:
+    def zoom_x(self, direction: str | None) -> None:
         """Change upper figure x-axis zoom level
 
-        :param direction: in, out, or reset
+        :param direction: in, out, reset, or None
         """
-        epochs_shown = self.upper_right_epoch - self.upper_left_epoch + 1
-        if direction == ZOOM_IN:
-            self.upper_left_epoch = max(
-                [
-                    self.upper_left_epoch,
-                    round(self.epoch - ZOOM_IN_FACTOR * epochs_shown),
-                ]
-            )
-
-            self.upper_right_epoch = min(
-                [
-                    self.upper_right_epoch,
-                    round(self.epoch + ZOOM_IN_FACTOR * epochs_shown),
-                ]
-            )
-
-        elif direction == ZOOM_OUT:
-            self.upper_left_epoch = max(
-                [0, round(self.epoch - ZOOM_OUT_FACTOR * epochs_shown)]
-            )
-
-            self.upper_right_epoch = min(
-                [self.n_epochs - 1, round(self.epoch + ZOOM_OUT_FACTOR * epochs_shown)]
-            )
-
-        else:  # reset
-            self.upper_left_epoch = 0
-            self.upper_right_epoch = self.n_epochs - 1
+        self.upper_left_epoch, self.upper_right_epoch = find_new_x_limits(
+            direction=direction,
+            left_epoch=self.upper_left_epoch,
+            right_epoch=self.upper_right_epoch,
+            min_n_shown=self.epochs_to_show,
+            total_epochs=self.n_epochs,
+            selected_epoch=self.epoch,
+        )
         self.adjust_upper_figure_x_limits()
         self.ui.upperfigure.canvas.draw()
 
@@ -806,8 +792,11 @@ class ManualScoringWindow(QDialog):
         # update upper plot if needed
         upper_epochs_shown = self.upper_right_epoch - self.upper_left_epoch + 1
         if (
-            self.epoch
-            > self.upper_left_epoch + (1 - SCROLL_BOUNDARY) * upper_epochs_shown
+            (
+                self.epoch
+                > self.upper_left_epoch + (1 - SCROLL_BOUNDARY) * upper_epochs_shown
+                or self.epoch + (self.epochs_to_show - 1) / 2 > self.upper_right_epoch
+            )
             and self.upper_right_epoch < (self.n_epochs - 1)
             and direction == DIRECTION_RIGHT
         ):
@@ -815,7 +804,11 @@ class ManualScoringWindow(QDialog):
             self.upper_right_epoch += 1
             self.adjust_upper_figure_x_limits()
         elif (
-            self.epoch < self.upper_left_epoch + SCROLL_BOUNDARY * upper_epochs_shown
+            (
+                self.epoch
+                < self.upper_left_epoch + SCROLL_BOUNDARY * upper_epochs_shown
+                or self.epoch - (self.epochs_to_show - 1) / 2 < self.upper_left_epoch
+            )
             and self.upper_left_epoch > 0
             and direction == DIRECTION_LEFT
         ):
@@ -984,6 +977,19 @@ class ManualScoringWindow(QDialog):
 
         self.update_figures()
 
+    def scroll_zoom(self, event) -> None:
+        """Zoom on mouse scroll events"""
+        if self.now_zooming:
+            return
+
+        self.now_zooming = True
+        if event.button == "up":
+            self.zoom_x(direction=ZOOM_IN)
+        else:
+            self.zoom_x(direction=ZOOM_OUT)
+        time.sleep(ZOOM_DELAY)
+        self.now_zooming = False
+
 
 def convert_labels(labels: np.array, style: str) -> np.array:
     """Convert labels between "display" and "digit" formats
@@ -1095,3 +1101,55 @@ def transform_eeg_emg(eeg: np.array, emg: np.array) -> (np.array, np.array):
     eeg = eeg / np.percentile(eeg, 95) / 2.2
     emg = emg / np.percentile(emg, 95) / 2.2
     return eeg, emg
+
+
+def find_new_x_limits(
+    direction: str | None,
+    left_epoch: int,
+    right_epoch: int,
+    total_epochs: int,
+    min_n_shown: int,
+    selected_epoch: int,
+) -> (int, int):
+    """Calculate new plot x limits to allow zooming
+
+    :param direction: in, out, reset, or None
+    :param left_epoch: index of current leftmost epoch
+    :param right_epoch: index of current rightmost epoch
+    :param total_epochs: total number of epochs in the recording
+    :param min_n_shown: minimum number of epochs to display
+    :param selected_epoch: currently selected epoch
+    """
+    # number of epochs currently displayed in the upper plots
+    current_n_shown = right_epoch - left_epoch + 1
+    if direction == ZOOM_IN:
+        # can't display fewer than the number of epochs in the lower plot
+        new_n_shown = max([min_n_shown, round(current_n_shown * (1 - ZOOM_FACTOR))])
+    elif direction == ZOOM_OUT:
+        # can't display more than the total number of epochs
+        new_n_shown = min([total_epochs, round(current_n_shown / (1 - ZOOM_FACTOR))])
+    elif direction == ZOOM_RESET:
+        left_epoch = 0
+        right_epoch = total_epochs - 1
+        return left_epoch, right_epoch
+    else:  # just recalculating if min_n_shown has changed
+        new_n_shown = int(
+            np.clip(current_n_shown, a_min=min_n_shown, a_max=total_epochs)
+        )
+
+    # count epochs to show on either side of the selected epoch
+    epochs_on_left_side = int(np.ceil((new_n_shown - 1) / 2))
+    epochs_on_right_side = new_n_shown - epochs_on_left_side - 1
+    if selected_epoch - epochs_on_left_side < 0:
+        # can't go further left than 0
+        left_epoch = 0
+        right_epoch = new_n_shown - 1
+    elif selected_epoch + epochs_on_right_side >= total_epochs:
+        # can't go further right than the total number of epochs
+        left_epoch = total_epochs - new_n_shown
+        right_epoch = total_epochs - 1
+    else:
+        left_epoch = selected_epoch - epochs_on_left_side
+        right_epoch = selected_epoch + epochs_on_right_side
+
+    return left_epoch, right_epoch

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/primary_window.py

@@ -757,7 +757,7 @@ class Ui_PrimaryWindow(object):
         self.top_training_layout.setSpacing(10)
         self.top_training_layout.setObjectName("top_training_layout")
         self.horizontalLayout_5 = QHBoxLayout()
-        self.horizontalLayout_5.setSpacing(5)
+        self.horizontalLayout_5.setSpacing(3)
         self.horizontalLayout_5.setObjectName("horizontalLayout_5")
         self.label = QLabel(self.model_training_tab)
         self.label.setObjectName("label")
@@ -786,21 +786,48 @@ class Ui_PrimaryWindow(object):
 
         self.top_training_layout.addItem(self.horizontalSpacer)
 
-        self.delete_image_box = QCheckBox(self.model_training_tab)
-        self.delete_image_box.setObjectName("delete_image_box")
+        self.calibrate_checkbox = QCheckBox(self.model_training_tab)
+        self.calibrate_checkbox.setObjectName("calibrate_checkbox")
         sizePolicy1.setHeightForWidth(
-            self.delete_image_box.sizePolicy().hasHeightForWidth()
+            self.calibrate_checkbox.sizePolicy().hasHeightForWidth()
         )
-        self.delete_image_box.setSizePolicy(sizePolicy1)
-        self.delete_image_box.setChecked(True)
+        self.calibrate_checkbox.setSizePolicy(sizePolicy1)
+        self.calibrate_checkbox.setChecked(True)
+
+        self.top_training_layout.addWidget(self.calibrate_checkbox)
+
+        self.horizontalLayout_84 = QHBoxLayout()
+        self.horizontalLayout_84.setSpacing(3)
+        self.horizontalLayout_84.setObjectName("horizontalLayout_84")
+        self.horizontalLayout_84.setContentsMargins(10, -1, -1, -1)
+        self.calibrate_label = QLabel(self.model_training_tab)
+        self.calibrate_label.setObjectName("calibrate_label")
+        sizePolicy1.setHeightForWidth(
+            self.calibrate_label.sizePolicy().hasHeightForWidth()
+        )
+        self.calibrate_label.setSizePolicy(sizePolicy1)
+
+        self.horizontalLayout_84.addWidget(self.calibrate_label)
+
+        self.calibration_spinbox = QSpinBox(self.model_training_tab)
+        self.calibration_spinbox.setObjectName("calibration_spinbox")
+        sizePolicy1.setHeightForWidth(
+            self.calibration_spinbox.sizePolicy().hasHeightForWidth()
+        )
+        self.calibration_spinbox.setSizePolicy(sizePolicy1)
+        self.calibration_spinbox.setMinimum(10)
+        self.calibration_spinbox.setMaximum(50)
+        self.calibration_spinbox.setValue(15)
+
+        self.horizontalLayout_84.addWidget(self.calibration_spinbox)
 
-        self.top_training_layout.addWidget(self.delete_image_box)
+        self.top_training_layout.addLayout(self.horizontalLayout_84)
 
-        self.horizontalSpacer_6 = QSpacerItem(
+        self.horizontalSpacer_3 = QSpacerItem(
             10, 5, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
         )
 
-        self.top_training_layout.addItem(self.horizontalSpacer_6)
+        self.top_training_layout.addItem(self.horizontalSpacer_3)
 
         self.horizontalLayout_6 = QHBoxLayout()
         self.horizontalLayout_6.setObjectName("horizontalLayout_6")
@@ -836,18 +863,12 @@ class Ui_PrimaryWindow(object):
 
         self.top_training_layout.addLayout(self.horizontalLayout_6)
 
-        self.horizontalSpacer_3 = QSpacerItem(
-            10, 5, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
-        )
-
-        self.top_training_layout.addItem(self.horizontalSpacer_3)
-
-        self.top_training_layout.setStretch(0, 2)
+        self.top_training_layout.setStretch(0, 5)
         self.top_training_layout.setStretch(1, 1)
-        self.top_training_layout.setStretch(2, 2)
-        self.top_training_layout.setStretch(3, 1)
-        self.top_training_layout.setStretch(4, 3)
-        self.top_training_layout.setStretch(5, 1)
+        self.top_training_layout.setStretch(2, 3)
+        self.top_training_layout.setStretch(3, 4)
+        self.top_training_layout.setStretch(4, 1)
+        self.top_training_layout.setStretch(5, 5)
 
         self.model_training_layout.addLayout(self.top_training_layout, 0, 0, 1, 1)
 
@@ -855,10 +876,10 @@ class Ui_PrimaryWindow(object):
         self.bottom_training_layout.setObjectName("bottom_training_layout")
         self.train_model_button = QPushButton(self.model_training_tab)
         self.train_model_button.setObjectName("train_model_button")
-        sizePolicy3.setHeightForWidth(
+        sizePolicy1.setHeightForWidth(
             self.train_model_button.sizePolicy().hasHeightForWidth()
         )
-        self.train_model_button.setSizePolicy(sizePolicy3)
+        self.train_model_button.setSizePolicy(sizePolicy1)
 
         self.bottom_training_layout.addWidget(self.train_model_button)
 
@@ -868,56 +889,8 @@ class Ui_PrimaryWindow(object):
 
         self.bottom_training_layout.addItem(self.horizontalSpacer_8)
 
-        self.calibrate_checkbox = QCheckBox(self.model_training_tab)
-        self.calibrate_checkbox.setObjectName("calibrate_checkbox")
-        sizePolicy1.setHeightForWidth(
-            self.calibrate_checkbox.sizePolicy().hasHeightForWidth()
-        )
-        self.calibrate_checkbox.setSizePolicy(sizePolicy1)
-        self.calibrate_checkbox.setChecked(True)
-
-        self.bottom_training_layout.addWidget(self.calibrate_checkbox)
-
-        self.horizontalSpacer_7 = QSpacerItem(
-            10, 10, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
-        )
-
-        self.bottom_training_layout.addItem(self.horizontalSpacer_7)
-
-        self.calibrate_label = QLabel(self.model_training_tab)
-        self.calibrate_label.setObjectName("calibrate_label")
-        sizePolicy1.setHeightForWidth(
-            self.calibrate_label.sizePolicy().hasHeightForWidth()
-        )
-        self.calibrate_label.setSizePolicy(sizePolicy1)
-
-        self.bottom_training_layout.addWidget(self.calibrate_label)
-
-        self.calibration_spinbox = QSpinBox(self.model_training_tab)
-        self.calibration_spinbox.setObjectName("calibration_spinbox")
-        sizePolicy1.setHeightForWidth(
-            self.calibration_spinbox.sizePolicy().hasHeightForWidth()
-        )
-        self.calibration_spinbox.setSizePolicy(sizePolicy1)
-        self.calibration_spinbox.setMinimum(10)
-        self.calibration_spinbox.setMaximum(50)
-        self.calibration_spinbox.setValue(15)
-
-        self.bottom_training_layout.addWidget(self.calibration_spinbox)
-
-        self.horizontalSpacer_78 = QSpacerItem(
-            10, 10, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
-        )
-
-        self.bottom_training_layout.addItem(self.horizontalSpacer_78)
-
-        self.bottom_training_layout.setStretch(0, 6)
+        self.bottom_training_layout.setStretch(0, 5)
         self.bottom_training_layout.setStretch(1, 5)
-        self.bottom_training_layout.setStretch(2, 3)
-        self.bottom_training_layout.setStretch(3, 1)
-        self.bottom_training_layout.setStretch(4, 3)
-        self.bottom_training_layout.setStretch(5, 1)
-        self.bottom_training_layout.setStretch(6, 1)
 
         self.model_training_layout.addLayout(self.bottom_training_layout, 1, 0, 1, 1)
 
@@ -2749,6 +2722,30 @@ class Ui_PrimaryWindow(object):
 
         self.verticalLayout_14.addLayout(self.horizontalLayout_71)
 
+        self.horizontalLayout_79 = QHBoxLayout()
+        self.horizontalLayout_79.setObjectName("horizontalLayout_79")
+        self.horizontalLayout_85 = QHBoxLayout()
+        self.horizontalLayout_85.setObjectName("horizontalLayout_85")
+        self.delete_image_box = QCheckBox(self.hyperparameter_page)
+        self.delete_image_box.setObjectName("delete_image_box")
+        sizePolicy1.setHeightForWidth(
+            self.delete_image_box.sizePolicy().hasHeightForWidth()
+        )
+        self.delete_image_box.setSizePolicy(sizePolicy1)
+        self.delete_image_box.setChecked(True)
+
+        self.horizontalLayout_85.addWidget(self.delete_image_box)
+
+        self.horizontalLayout_79.addLayout(self.horizontalLayout_85)
+
+        self.horizontalSpacer_93 = QSpacerItem(
+            40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum
+        )
+
+        self.horizontalLayout_79.addItem(self.horizontalSpacer_93)
+
+        self.verticalLayout_14.addLayout(self.horizontalLayout_79)
+
         self.horizontalLayout_74 = QHBoxLayout()
         self.horizontalLayout_74.setObjectName("horizontalLayout_74")
         self.horizontalSpacer_86 = QSpacerItem(
@@ -3033,11 +3030,16 @@ class Ui_PrimaryWindow(object):
         self.label.setText(
             QCoreApplication.translate("PrimaryWindow", "Epochs per image:", None)
         )
-        self.delete_image_box.setText(
-            QCoreApplication.translate(
-                "PrimaryWindow", "Delete images after training", None
-            )
+        self.calibrate_checkbox.setText(
+            QCoreApplication.translate("PrimaryWindow", "Calibrate model", None)
         )
+        self.calibrate_label.setText(
+            QCoreApplication.translate("PrimaryWindow", "Calibration set size:", None)
+        )
+        self.calibration_spinbox.setSuffix(
+            QCoreApplication.translate("PrimaryWindow", "%", None)
+        )
+        self.calibration_spinbox.setPrefix("")
         self.label_2.setText(
             QCoreApplication.translate("PrimaryWindow", "Model type:", None)
         )
@@ -3059,15 +3061,6 @@ class Ui_PrimaryWindow(object):
                 "PrimaryWindow", "Train classification model", None
             )
         )
-        self.calibrate_checkbox.setText(
-            QCoreApplication.translate("PrimaryWindow", "Calibrate model", None)
-        )
-        self.calibrate_label.setText(
-            QCoreApplication.translate("PrimaryWindow", "Calibration set size:", None)
-        )
-        self.calibration_spinbox.setSuffix(
-            QCoreApplication.translate("PrimaryWindow", "%", None)
-        )
         self.lower_tab_widget.setTabText(
             self.lower_tab_widget.indexOf(self.model_training_tab),
             QCoreApplication.translate("PrimaryWindow", "Model training", None),
@@ -3296,6 +3289,11 @@ class Ui_PrimaryWindow(object):
         self.training_epochs_label.setText(
             QCoreApplication.translate("PrimaryWindow", "Epochs:", None)
         )
+        self.delete_image_box.setText(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Delete images after training", None
+            )
+        )
         self.reset_hyperparams_button.setText(
             QCoreApplication.translate("PrimaryWindow", "reset to defaults", None)
         )
@@ -3306,7 +3304,9 @@ class Ui_PrimaryWindow(object):
                 "- Batch size: number of examples in each training iteration\n"
                 "- Learning rate: step size for adjusting model weights\n"
                 "- Momentum: amount of past gradients to use in the current update. Typically between 0.6 and 0.99\n"
-                "- Epochs: number of passes over the training data",
+                "- Epochs: number of passes over the training data\n"
+                "\n"
+                "You can also choose whether to delete images created by the training process once it's finished. This is recommended unless you are debugging the training code.",
                 None,
             )
         )

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/primary_window.ui

@@ -1239,14 +1239,14 @@ color: rgb(244, 195, 68);</string>
                      <number>10</number>
                     </property>
                     <item row="0" column="0">
-                     <layout class="QHBoxLayout" name="top_training_layout" stretch="2,1,2,1,3,1">
+                     <layout class="QHBoxLayout" name="top_training_layout" stretch="5,1,3,4,1,5">
                       <property name="spacing">
                        <number>10</number>
                       </property>
                       <item>
                        <layout class="QHBoxLayout" name="horizontalLayout_5">
                         <property name="spacing">
-                         <number>5</number>
+                         <number>3</number>
                         </property>
                         <item>
                          <widget class="QLabel" name="label">
@@ -1299,7 +1299,7 @@ color: rgb(244, 195, 68);</string>
                        </spacer>
                       </item>
                       <item>
-                       <widget class="QCheckBox" name="delete_image_box">
+                       <widget class="QCheckBox" name="calibrate_checkbox">
                         <property name="sizePolicy">
                          <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
                           <horstretch>0</horstretch>
@@ -1307,7 +1307,7 @@ color: rgb(244, 195, 68);</string>
                          </sizepolicy>
                         </property>
                         <property name="text">
-                         <string>Delete images after training</string>
+                         <string>Calibrate model</string>
                         </property>
                         <property name="checked">
                          <bool>true</bool>
@@ -1315,7 +1315,55 @@ color: rgb(244, 195, 68);</string>
                        </widget>
                       </item>
                       <item>
-                       <spacer name="horizontalSpacer_6">
+                       <layout class="QHBoxLayout" name="horizontalLayout_84">
+                        <property name="spacing">
+                         <number>3</number>
+                        </property>
+                        <property name="leftMargin">
+                         <number>10</number>
+                        </property>
+                        <item>
+                         <widget class="QLabel" name="calibrate_label">
+                          <property name="sizePolicy">
+                           <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                            <horstretch>0</horstretch>
+                            <verstretch>0</verstretch>
+                           </sizepolicy>
+                          </property>
+                          <property name="text">
+                           <string>Calibration set size:</string>
+                          </property>
+                         </widget>
+                        </item>
+                        <item>
+                         <widget class="QSpinBox" name="calibration_spinbox">
+                          <property name="sizePolicy">
+                           <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                            <horstretch>0</horstretch>
+                            <verstretch>0</verstretch>
+                           </sizepolicy>
+                          </property>
+                          <property name="suffix">
+                           <string>%</string>
+                          </property>
+                          <property name="prefix">
+                           <string/>
+                          </property>
+                          <property name="minimum">
+                           <number>10</number>
+                          </property>
+                          <property name="maximum">
+                           <number>50</number>
+                          </property>
+                          <property name="value">
+                           <number>15</number>
+                          </property>
+                         </widget>
+                        </item>
+                       </layout>
+                      </item>
+                      <item>
+                       <spacer name="horizontalSpacer_3">
                         <property name="orientation">
                          <enum>Qt::Orientation::Horizontal</enum>
                         </property>
@@ -1376,30 +1424,14 @@ color: rgb(244, 195, 68);</string>
                         </item>
                        </layout>
                       </item>
-                      <item>
-                       <spacer name="horizontalSpacer_3">
-                        <property name="orientation">
-                         <enum>Qt::Orientation::Horizontal</enum>
-                        </property>
-                        <property name="sizeType">
-                         <enum>QSizePolicy::Policy::Preferred</enum>
-                        </property>
-                        <property name="sizeHint" stdset="0">
-                         <size>
-                          <width>10</width>
-                          <height>5</height>
-                         </size>
-                        </property>
-                       </spacer>
-                      </item>
                      </layout>
                     </item>
                     <item row="1" column="0">
-                     <layout class="QHBoxLayout" name="bottom_training_layout" stretch="6,5,3,1,3,1,1">
+                     <layout class="QHBoxLayout" name="bottom_training_layout" stretch="5,5">
                       <item>
                        <widget class="QPushButton" name="train_model_button">
                         <property name="sizePolicy">
-                         <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
+                         <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
                           <horstretch>0</horstretch>
                           <verstretch>0</verstretch>
                          </sizepolicy>
@@ -1428,89 +1460,6 @@ color: rgb(244, 195, 68);</string>
                         </property>
                        </spacer>
                       </item>
-                      <item>
-                       <widget class="QCheckBox" name="calibrate_checkbox">
-                        <property name="sizePolicy">
-                         <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                          <horstretch>0</horstretch>
-                          <verstretch>0</verstretch>
-                         </sizepolicy>
-                        </property>
-                        <property name="text">
-                         <string>Calibrate model</string>
-                        </property>
-                        <property name="checked">
-                         <bool>true</bool>
-                        </property>
-                       </widget>
-                      </item>
-                      <item>
-                       <spacer name="horizontalSpacer_7">
-                        <property name="orientation">
-                         <enum>Qt::Orientation::Horizontal</enum>
-                        </property>
-                        <property name="sizeType">
-                         <enum>QSizePolicy::Policy::Preferred</enum>
-                        </property>
-                        <property name="sizeHint" stdset="0">
-                         <size>
-                          <width>10</width>
-                          <height>10</height>
-                         </size>
-                        </property>
-                       </spacer>
-                      </item>
-                      <item>
-                       <widget class="QLabel" name="calibrate_label">
-                        <property name="sizePolicy">
-                         <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                          <horstretch>0</horstretch>
-                          <verstretch>0</verstretch>
-                         </sizepolicy>
-                        </property>
-                        <property name="text">
-                         <string>Calibration set size:</string>
-                        </property>
-                       </widget>
-                      </item>
-                      <item>
-                       <widget class="QSpinBox" name="calibration_spinbox">
-                        <property name="sizePolicy">
-                         <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                          <horstretch>0</horstretch>
-                          <verstretch>0</verstretch>
-                         </sizepolicy>
-                        </property>
-                        <property name="suffix">
-                         <string>%</string>
-                        </property>
-                        <property name="minimum">
-                         <number>10</number>
-                        </property>
-                        <property name="maximum">
-                         <number>50</number>
-                        </property>
-                        <property name="value">
-                         <number>15</number>
-                        </property>
-                       </widget>
-                      </item>
-                      <item>
-                       <spacer name="horizontalSpacer_78">
-                        <property name="orientation">
-                         <enum>Qt::Orientation::Horizontal</enum>
-                        </property>
-                        <property name="sizeType">
-                         <enum>QSizePolicy::Policy::Preferred</enum>
-                        </property>
-                        <property name="sizeHint" stdset="0">
-                         <size>
-                          <width>10</width>
-                          <height>10</height>
-                         </size>
-                        </property>
-                       </spacer>
-                      </item>
                      </layout>
                     </item>
                    </layout>
@@ -4612,6 +4561,43 @@ Each brain state has several attributes:
                     </item>
                    </layout>
                   </item>
+                  <item>
+                   <layout class="QHBoxLayout" name="horizontalLayout_79">
+                    <item>
+                     <layout class="QHBoxLayout" name="horizontalLayout_85">
+                      <item>
+                       <widget class="QCheckBox" name="delete_image_box">
+                        <property name="sizePolicy">
+                         <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                          <horstretch>0</horstretch>
+                          <verstretch>0</verstretch>
+                         </sizepolicy>
+                        </property>
+                        <property name="text">
+                         <string>Delete images after training</string>
+                        </property>
+                        <property name="checked">
+                         <bool>true</bool>
+                        </property>
+                       </widget>
+                      </item>
+                     </layout>
+                    </item>
+                    <item>
+                     <spacer name="horizontalSpacer_93">
+                      <property name="orientation">
+                       <enum>Qt::Orientation::Horizontal</enum>
+                      </property>
+                      <property name="sizeHint" stdset="0">
+                       <size>
+                        <width>40</width>
+                        <height>20</height>
+                       </size>
+                      </property>
+                     </spacer>
+                    </item>
+                   </layout>
+                  </item>
                   <item>
                    <layout class="QHBoxLayout" name="horizontalLayout_74">
                     <item>
@@ -4682,7 +4668,9 @@ Each brain state has several attributes:
 - Batch size: number of examples in each training iteration
 - Learning rate: step size for adjusting model weights
 - Momentum: amount of past gradients to use in the current update. Typically between 0.6 and 0.99
-- Epochs: number of passes over the training data</string>
+- Epochs: number of passes over the training data
+
+You can also choose whether to delete images created by the training process once it's finished. This is recommended unless you are debugging the training code.</string>
                     </property>
                     <property name="textFormat">
                      <enum>Qt::TextFormat::MarkdownText</enum>

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/settings_widget.py

@@ -9,6 +9,7 @@ from PySide6.QtWidgets import QCheckBox, QDoubleSpinBox, QLineEdit
 from accusleepy.brain_state_set import BrainState, BrainStateSet
 from accusleepy.constants import (
     DEFAULT_BATCH_SIZE,
+    DEFAULT_DELETE_TRAINING_IMAGES_STATE,
     DEFAULT_EMG_BP_LOWER,
     DEFAULT_EMG_BP_UPPER,
     DEFAULT_EMG_FILTER_ORDER,
@@ -55,6 +56,7 @@ class SettingsWidget(QObject):
         self._hyperparameters = config.hyperparameters
         self._default_epochs_to_show = config.epochs_to_show
         self._default_autoscroll_state = config.autoscroll_state
+        self._delete_training_images = config.delete_training_images
 
         # Store default values for main tab settings (used to populate Settings tab UI)
         self._default_epoch_length = config.default_epoch_length
@@ -81,6 +83,11 @@ class SettingsWidget(QObject):
         """Model training hyperparameters"""
         return self._hyperparameters
 
+    @property
+    def delete_training_images(self) -> bool:
+        """Whether to delete images after training"""
+        return self._delete_training_images
+
     @property
     def default_epochs_to_show(self) -> int:
         """Default number of epochs to show in manual scoring"""
@@ -186,6 +193,7 @@ class SettingsWidget(QObject):
         self._ui.learning_rate_spinbox.setValue(self._hyperparameters.learning_rate)
         self._ui.momentum_spinbox.setValue(self._hyperparameters.momentum)
         self._ui.training_epochs_spinbox.setValue(self._hyperparameters.training_epochs)
+        self._ui.delete_image_box.setChecked(self._delete_training_images)
         # Brain states
         states = {b.digit: b for b in self._brain_state_set.brain_states}
         for digit in range(10):
@@ -233,6 +241,7 @@ class SettingsWidget(QObject):
         self._ui.training_epochs_spinbox.valueChanged.connect(
             self._hyperparameters_changed
         )
+        self._ui.delete_image_box.stateChanged.connect(self._hyperparameters_changed)
         for digit in range(10):
             state = self._settings_widgets[digit]
             state.enabled_widget.stateChanged.connect(
@@ -302,6 +311,7 @@ class SettingsWidget(QObject):
             momentum=self._ui.momentum_spinbox.value(),
             training_epochs=self._ui.training_epochs_spinbox.value(),
         )
+        self._delete_training_images = self._ui.delete_image_box.isChecked()
         self._ui.save_config_status.setText("")
 
     def reset_status_message(self, _new_value=None) -> None:
@@ -392,6 +402,7 @@ class SettingsWidget(QObject):
             hyperparameters=self._hyperparameters,
             epochs_to_show=self._ui.epochs_to_show_spinbox.value(),
             autoscroll_state=self._ui.autoscroll_checkbox.isChecked(),
+            delete_training_images=self._ui.delete_image_box.isChecked(),
         )
         self._ui.save_config_status.setText("configuration saved")
 
@@ -407,3 +418,4 @@ class SettingsWidget(QObject):
         self._ui.learning_rate_spinbox.setValue(DEFAULT_LEARNING_RATE)
         self._ui.momentum_spinbox.setValue(DEFAULT_MOMENTUM)
         self._ui.training_epochs_spinbox.setValue(DEFAULT_TRAINING_EPOCHS)
+        self._ui.delete_image_box.setChecked(DEFAULT_DELETE_TRAINING_IMAGES_STATE)

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/text/main_guide.md

@@ -125,25 +125,28 @@ To train a new model on your own data:
     recording. Calibration files are not required.
 2. Click the "Model training" tab
 3. Choose the number of epochs to consider when scoring each epoch.
-    This will be the "width" of the training images. For "default"
-    type models, this must be an odd number. In general, about 30
-    seconds worth of data is enough.
-4. Choose whether the images used to train the model should be
-    deleted once training is complete. It's generally best to
-    leave this box checked. A (temporary) folder for these files
-    will be created in the same location as the trained model.
-5. Choose whether to create a "default" or "real-time"-type model.
-    Note that scoring recordings in the primary interface requires
-    a default-type model.
-6. Choose whether to calibrate the model. This process uses part
+    This will be the width, in pixels, of the training images.
+    For "default" type models, this must be an odd number. Generally,
+    about 30 seconds worth of data is enough.
+4. Choose whether to create a "default" or "real-time"-type model.
+    Scoring recordings in the AccuSleePy interface requires a
+    default-type model. Only select real-time if you plan to create
+    your own scoring function. An example real-time scoring function
+    can be found in `classification.py`.
+5. Choose whether to calibrate the model. This process uses part
     of the training data to make the model's confidence scores
     more accurately reflect the probability that the output
     labels are accurate. If using calibration, choose what percent
     of the training data to set aside for calibration.
-7. Click "Train classification model" and enter a
+6. Click "Train classification model" and enter a
     filename for the trained model. Training can take some time.
     The terminal will display progress updates.
 
+As part of the training process, a temporary folder of images will
+be created in the location where the model will be saved. This folder
+is deleted by default, but if you want to keep it for debugging
+purposes, you can change this behavior in the "Settings" tab.
+
 ## 4C. Automatic scoring
 
 Instructions for automatic scoring using this interface are below.

{accusleepy-0.9.2 → accusleepy-0.10.0}/accusleepy/gui/text/manual_scoring_guide.md

@@ -2,6 +2,7 @@
 
 Keyboard shortcuts:
 - Mouse click on the upper 3 plots: jump to epoch
+- Mouse scroll on the upper 3 plots: zoom in/out along the x-axis
 - Ctrl + S: save labels to file
 - Right / left arrow: move one epoch forward / backward in time
 - Numbers 0-9: set current epoch to this brain state

{accusleepy-0.9.2 → accusleepy-0.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "accusleepy"
-version = "0.9.2"
+version = "0.10.0"
 description = "Python implementation of AccuSleep"
 authors = [
     {name = "Zeke Barger",email = "zekebarger@gmail.com"}
@@ -20,12 +20,12 @@ dependencies = [
     "fastparquet (>=2024.11.0,<2025.0.0)",
     "pre-commit (>=4.2.0,<5.0.0)",
     "tqdm (>=4.67.1,<5.0.0)",
-    "toml (>=0.10.2,<0.11.0)",
     "pyside6 (>=6.9.0, <6.9.3)",
 ]
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=8.3.5,<9.0.0"
+pytest-qt = ">=4.4.0,<5.0.0"
 ruff = ">=0.11.2,<0.12.0"
 
 [build-system]
@@ -34,3 +34,9 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
 extend-exclude = ["*.ipynb"]
+
+[tool.pytest.ini_options]
+markers = [
+    "gui: marks tests as GUI tests (may require display or xvfb)",
+]
+qt_api = "pyside6"