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

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), FieldInfo(annotation=NoneType, required=True, validate_default=True)] [Optional][source]

Date of the experiment

Constraints:
  • func = <function _add_default_tz at 0x7f769504e700>

  • 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 root_path: str [Required][source]

Root path where data will be logged

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.12.2'] = '0.12.2'[source]
Validated by:
validator generate_session_name_default  »  all fields[source]
experiment_version: str[source]

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

msg[source]

The deprecation message to be emitted.

wrapped_property[source]

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

field_name[source]

The name of the field being deprecated.