json-schemas.session

Download Schema

AindBehaviorSessionModel

type

object

properties

  • aind_behavior_services_pkg_version

aind_behavior_services package version

type

string

pattern

^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

default

0.8.8

  • version

Version

type

string

default

0.3.0

const

0.3.0

  • experiment

Experiment

Name of the experiment

type

string

  • experimenter

Experimenter

Name of the experimenter

type

array

default

items

type

string

  • date

Date

Date of the experiment

type

string

format

date-time

  • root_path

Root Path

Root path where data will be logged

type

string

  • session_name

Session Name

Name of the session. This will be used to create a folder in the root path.

default

null

oneOf

type

string

type

null

  • subject

Subject

Name of the subject

type

string

  • experiment_version

Experiment Version

Version of the experiment

type

string

  • notes

Notes

Notes about the experiment

default

null

oneOf

type

string

type

null

  • commit_hash

Commit Hash

Commit hash of the repository

default

null

oneOf

type

string

type

null

  • allow_dirty_repo

Allow Dirty Repo

Allow running from a dirty repository

type

boolean

default

False

  • skip_hardware_validation

Skip Hardware Validation

Skip hardware validation

type

boolean

default

False