api.session

pydantic model aind_behavior_services.session.AindBehaviorSessionModel[source]

Bases: SchemaVersionedModel

Fields:
Validators:
field allow_dirty_repo: bool = False[source]

Allow running from a dirty repository

field commit_hash: str | None = None[source]

Commit hash of the repository

field date: datetime [Optional][source]

Date of the experiment

field experiment: str [Required][source]

Name of the experiment

field experiment_version: str [Required][source]

Version of the experiment

field experimenter: List[str] = [][source]

Name of the experimenter

field notes: str | None = None[source]

Notes about the experiment

field remote_path: str | None = None[source]

Remote path where data will be attempted to be copied to after experiment is done

field root_path: str [Required][source]

Root path where data will be logged

field skip_hardware_validation: bool = False[source]

Skip hardware validation

field subject: str [Required][source]

Name of the subject

field version: Literal['0.2.0'] = '0.2.0'[source]
Validated by:
validator coerce_version  »  version[source]