Skip to content
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.

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

2.0.0rc4 release #338

Merged
merged 404 commits into from
Nov 5, 2024
Merged

2.0.0rc4 release #338

merged 404 commits into from
Nov 5, 2024

Conversation

tab-cmd
Copy link
Contributor

@tab-cmd tab-cmd commented Aug 19, 2024

2.0.0rc4

This is our final release before the official 2.0 release! It includes many refactors and changes. Please see CHANGELOG.md for more information.

AWATING THE FOLLOWING BEFORE MERGER

  • ET/ FUSION PR
  • Human in-the-loop testing
  • Cleanup

Major updates: In-Progress Write-Up!

Multimodal Support

  • devices.json "active/passive" data recording support
  • offline analysis can train EEG and ET models

Orchestration

  • a new task execution methodology that provides a higher-level interface for running tasks/actions in sequence. This will permit AI/ ML models to be at a top level in the future (modifying task or signal processing parameters based on performance).
    Experiment/protocol support allows a user to define a protocol for an experiment to be run, allowing for greater standardization during the experiment.
  • parameter guardrails: a flag was added to parameters.json to indicate from the user whether a parameter can be changed during a session.
  • Ability to run multiple copy phrases in a random order (using phrases.json) and a path provided in the parameters.json

Interfaces / Actions

  • VEP Calibration
  • BciPy Report Action
  • Inquiry Preview Enhancements

Artifact Analysis

  • A new module will be created to determine the presence of artifacts and view them offline in a semi-automatic fashion.

Upgrades and Refactors

  • support more OS/ hardware, new versions of Python, upgrade libraries

Testing

  • Unit and Integration tests passing
  • Pilot testing is ongoing!

Tab Memmott and others added 30 commits October 31, 2023 18:06
upgrades to permit use on m2 chips
Ensures that InquiryReshaper works when passed None for it's channel_map
best_case_rsvp_inq_gen function
lawhead and others added 21 commits September 25, 2024 17:19
… in Copy Phrase task which caused preview to be displayed twice. Updated demos and fixed unit tests
* gets `main.py` functionality working in the orchestrator

* Fixes task initialization process

Save folder and parameters are now saved and loaded per task as they are executed rather than once per session.

* Moves parameter loading to task execution

* Adds functions for parsing visit actions

* Adds some test to action parsing

* Adds tests for action serialization

* Adds parameter validation function with tests

* Updates changelog.md

* lints actions.py and test_actions.py

* Adds constant for action separator

* removes old file that has been moved

* renames action parsing module and updates test imports

* simplifies `serialize_actions` function

* Fixes typing and formatting issues

* removes `parse_actions.py`

* renames `parse_actions` to `parse_sequence`

* replaces magic '->' string with constant

* removes unnecessary error check

* Adds basic structure for orchestrator actions

* refactors config function naming and adds support for actions in parsing functions

* renames `test_actions` to `test_config`

* Adds additional tests for action parsing

* Adds action serialization tests

* Add more actions

* Refactors type unions to be `Optional`s

* Adds parameter loading to the orchestrator

* Adds initialize and cleanup methods to `Task`

* makes `name` a property in `OfflineAnalysisAction`

* Implements `setup` method in base `Task` class

* Adds missing parent `execute` call

* changes `initialize` call to `setup` in orchestrator

* Refactors `name` to be a property in base `Task` class

* Refactors `config.py` to only work with tasks

* adds demo file for orchestrator execution

* Fixes data_save initialization in orchestrator

* Creates default_user_id constant

* Fixes incorrect user initialization

* Refactors orchestrator save structure

* Implements `save` method

* Adds `task_registry_dict` to simplify fetching classes for initialization

This is currently redundant with the `TaskType` approach and ideally would be refactored to have only one source of string reference

* Adds comment about `task_registry_dict`

* Moves `task_registry_dict` to `orchestrator.config`

* refactors `name` property of tasks

* Adds task registry class

* Refactor `super` calls in orchestrator actions

* adds type hint for task parameter

* calls `construct_command` in constructor

* adds function to run experiment data collection without running from the command line

* adds `ExperimentFieldCollectionAction`

* refactors orchestrator demo file to use `ExperimentFieldCollectionAction`

* lints `task_registry.py`

* imports `Task` for correct typing in config

* Updates `task_registry.py` to import all tasks

* moves `TASK_SEPERATOR` to `config.py`

* Adds docstring to orchestrator

* Renames `TestConfig`

* removes property decorator in task class

* removes implementation of abstract class

* updates changelog

* removes super calls to abstract method `execute`

* Filters out abstract subclasses from registry generation

* removes registry dict empty initialization

* Fixes typing issues

* Removes task import from the registry

* Refactors config to support TaskRegistry

* Refactors task names

* Refactors `TaskRegistry` to recursively collect subclasses

This makes it compatible with the new `BaseCalibrationTask` as it will be able to collect grandchild classes of `Task` (which is all calibration tasks now)

* Makes `BaseCalibrationTask` abstract

* removes name and label from `timing_verification.py`

* imports tasks in their module's `__init__.py`

This makes all tasks available to the task registry when it is initialized.

* Enforces `name` attribute in base task class

* adds calibration task check to the registry. TaskType now no longer exists

* fixes incorrect method name in TaskRegistry

* updates bci_main_tests to call main methods properly

* updates method calls in protocol parsing tests

* refactors `start_app` to use `start_experiment_field_collection_gui`

* changes orchestrator directory name to work on windows

* Adds basic selection box for orchestrator protocol

* Adds the ability to add and remove tasks to the protocol

* renames `sequence` to `protocol` in orchestrator config

* Allows protocol to be saved to `experiments.json`

* adds move up and down controls to tasks in protocol

* Refactors scrollable frames to have a title label. Some buttons are still misaligned in the ExperimentRegistry

* Moves create experiment button to the bottom of the gui

* changes task and action names to be more consistent

* adds basic `TaskData` return object

* fixes failing test in `test_copy_phrase`

* fixes missing return statement for `construct_command`

* adds `task_dict` to `TaskData`

* updates changelog

* adds seperate BCIUI file with stylsheet

This will hopefully replace BCIGui later, but I am keeping it seperate for now as to not break existing uis on this branch

* update demo experiment layout

* adjust stylesheet to remove label backgrounds

* improves gui code to allow for editing fields

* add basic removeable element

* add dynamic list class for easy ui reactivity

* Add small button component

* removes explicit color from small button

* adds basic toggle class

* changes toggle componenet to be simple connecting function

* makes on off callbacks optional in `make_toggle`

* add toggle to optional button

* swaps confusing parameter names

* loads experiment fields into combobox

* adds field buttons

* refactors gui to be inherited class
This improves state handling, as variables and widgets can be stored on the class itself

* add simple `show_alert` method

* add show_alert method

* adds validation to added fields


* adds experiment creation to application

* rename `gui_rewrite` to `bciui`

* adds app start method

* adds vertical center option to bciui

* add the beginning of intertask action ui

* add progress text

* allows for additional args in app running

* add functional progress bar

* Add next task display and functioning buttons

* adds seperate BCIUI file with stylesheet

This will hopefully replace BCIGui later, but I am keeping it seperate for now as to not break existing uis on this branch

* update demo experiment layout

* adjust stylesheet to remove label backgrounds

* improves gui code to allow for editing fields

* add basic removeable element

* add dynamic list class for easy ui reactivity

* Add small button component

* removes explicit color from small button

* adds basic toggle class

* changes toggle componenet to be simple connecting function

* makes on off callbacks optional in `make_toggle`

* add toggle to optional button

* swaps confusing parameter names

* loads experiment fields into combobox

* adds field buttons

* refactors gui to be inherited class
This improves state handling, as variables and widgets can be stored on the class itself

* add simple `show_alert` method

* add show_alert method

* adds validation to added fields

* remove debug prints

* adds experiment creation to application

* remove unused code

* rename `gui_rewrite` to `bciui`

* adds app start method

* adds vertical center option to bciui

* add beginning of intertask action ui

* add progress text

* allows for additional args in app running

* add functional progress bar

* Add next task display and functioning buttons

* add protocol layout and fix bug in DynamicList

* Parameter guardrails and cleanup (#340)

* supports adding tasks to the interface

* add reordering to tasks in the protocol

* allows adding new fields through the ui

* adds saving protocol in experiment from gui

* Task initialization and cleanup (#343)

* Adds documentation to ui methods

* rename `intertask_action` to `intertask_gui`

* add action that displays intertask GUI

* Add proper types and docs to bciui

* Deprecates old ExperimentRegistry in favor of new ui code

* Fixes incorrect background color when using dark mode

* improve stylsheet loading to use existing bcipy constants

* update legacy BCInterface to base session-orchestrator

* Session Orchestrator Updates [Post-Testing] (#344)

* Add logger to each task run

* Bcipy client refactor (#346)

* Task specific params and Matrix Layout (#349)

* Orchestrator - Load a JSON of copy phrases to use during execution  (#352)

* fix logger assignment

* BciPy report action, offline analysis updates,  Intertask GUI. (#354)

* updates to include IP changes

* Update to get static offset from the device


---------

Co-authored-by: Carson Reader <[email protected]>
Co-authored-by: lawhead <[email protected]>
@tab-cmd tab-cmd marked this pull request as ready for review October 29, 2024 17:28
@tab-cmd tab-cmd merged commit ad64938 into main Nov 5, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants