api.session

pydantic model aind_behavior_services.session.AindBehaviorSessionModel

Bases: SchemaVersionedModel

Fields:

• allow_dirty_repo (bool)

• commit_hash (str | None)

• date (pydantic.types.AwareDatetime)

• experiment (str | None)

• experiment_version (str)

• experimenter (List[str])

• notes (str | None)

• root_path (str)

• session_name (str | None)

• skip_hardware_validation (bool)

• subject (str)

• version (Literal['0.12.2'])

Validators:

• coerce_version » version

• generate_session_name_default » all fields

field allow_dirty_repo: bool = False

Allow running from a dirty repository

Validated by:

• generate_session_name_default

field commit_hash: str | None = None

Commit hash of the repository

Validated by:

• generate_session_name_default

field date: Annotated[AwareDatetime, WrapValidator(func=_add_default_tz, json_schema_input_type=PydanticUndefined), FieldInfo(annotation=NoneType, required=True, validate_default=True)] [Optional]

Date of the experiment

Constraints:

• func = <function _add_default_tz at 0x7f769504e700>

• json_schema_input_type = PydanticUndefined

Validated by:

• generate_session_name_default

field experiment: str | None = None

Name of the experiment

Validated by:

• generate_session_name_default

field experimenter: List[str] = []

Name of the experimenter

Validated by:

• generate_session_name_default

field notes: str | None = None

Notes about the experiment

Validated by:

• generate_session_name_default

field root_path: str [Required]

Root path where data will be logged

Validated by:

• generate_session_name_default

field session_name: str | None = None

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:

• generate_session_name_default

field skip_hardware_validation: bool = False

Skip hardware validation

Validated by:

• generate_session_name_default

field subject: str [Required]

Name of the subject

Validated by:

• generate_session_name_default

field version: Literal['0.12.2'] = '0.12.2'

Validated by:

• coerce_version

• generate_session_name_default

validator generate_session_name_default  »  all fields

experiment_version: str

Read-only data descriptor used to emit a runtime deprecation warning before accessing a deprecated field.

msg

The deprecation message to be emitted.

wrapped_property

The property instance if the deprecated field is a computed field, or None.

field_name

The name of the field being deprecated.