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

Simulator fix and orchestrator saving updates #358

Merged
merged 9 commits into from
Oct 30, 2024

Conversation

tab-cmd
Copy link
Contributor

@tab-cmd tab-cmd commented Oct 29, 2024

Overview

This PR updates the simulator to support the new Task refactor and updates the parameter name and data save path in the orchestrator. Some cleanup of variable names, data in Tasks, and typing are included.

Ticket

Contributions

  • update DEFAULT_PARAMETER_FILENAME to DEFAULT_PARAMATERS_FILENAME for consistency.
  • update get_evidence_type in the simulator to check for supported types and cast to an ENUM (from a string). Ensure it is used wherever needed.
  • update the parameter saving in the orchestrator to use the DEFAULT_PARAMATERS_FILENAME to support use throughout the codebase.
  • update the file save structure in the orchestrator from user/experiment/datetime/tasks/ to user/date/experiment/timestamp/tasks/

Test

  • make test-all
  • bcipy-sim -d ".../2024-10-17_13-33-26" -m ".../Matrix Calibration_2024-10-17_13-00-19" -g "*Copy*" -p ".../parameters.json" -n "25"
  • bcipy --fake --task "RSVP Calibration" -nv
  • bcipy --fake --task "RSVP Calibration"
  • bcipy --fake --task "Matrix Calibration" -nv
  • bcipy --fake --task "Matrix Copy Phrase" -nv

Documentation

  • Are documentation updates required? In-line, README, or documentation? Updated docstrings and task README

CHANGELOG

Updated with all current 2.0rc4 changes of note.

@tab-cmd tab-cmd requested a review from lawhead October 29, 2024 21:59

# Check if the evidence type is supported
if evidence_type not in SUPPORTED_EVIDENCE_TYPES:
raise ValueError(f"Unsupported evidence type: {evidence_type}. Supported types: {SUPPORTED_EVIDENCE_TYPES}")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer that the task doesn't make the call as to what evidence is supported. When we add the Gaze support we shouldn't need to change anything in the task. Maybe just try to create the EvidenceType from the string and let that fail if it's not valid.

@tab-cmd tab-cmd merged commit be07e59 into 2.0.0rc4 Oct 30, 2024
9 checks passed
@tab-cmd tab-cmd deleted the simulator_fix_and_save_structure branch October 30, 2024 20:23
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.

2 participants