api.session

pydantic model aind_behavior_services.session.Session[source]

Bases: SchemaVersionedModel

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

Allow running from a dirty repository

Validated by:
field commit_hash: str | None = None[source]

Commit hash of the repository

Validated by:
field date: Annotated[AwareDatetime, WrapValidator(func=_add_default_tz, json_schema_input_type=PydanticUndefined)] [Optional][source]

Date of the experiment

Constraints:

  • func = <function _add_default_tz at 0x7fb77272a0c0>

  • json_schema_input_type = PydanticUndefined

Validated by:
field experiment: str | None = None[source]

Name of the experiment

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

Name of the experimenter

Validated by:
field notes: str | None = None[source]

Notes about the experiment

Validated by:
field session_name: str | None = None[source]

Name of the session. This will be used to create a folder in the root path. If not provided, it will be generated using subject and date.

Validated by:
field skip_hardware_validation: bool = False[source]

Skip hardware validation

Validated by:
field subject: str [Required][source]

Name of the subject

Validated by:
field version: Literal['0.13.5'] = '0.13.5'[source]
Validated by:
validator generate_session_name_default  »  all fields[source]