api.task_logic

_images/AindChangeDetectionTaskLogic.svg
pydantic model aind_behavior_change_detection.task_logic.AindChangeDetectionTaskLogic[source]

Bases: AindBehaviorTaskLogicModel

Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • validate_defaults: bool = True

  • strict: bool = True

  • str_strip_whitespace: bool = True

Fields:
Validators:
field name: str = 'AindChangeDetection'[source]

Name of the task logic

field task_parameters: AindChangeDetectionTaskParameters [Required][source]

Parameters of the task logic

field version: Literal[__version__] = '0.0.0'[source]
Validated by:

  • coerce_version

pydantic model aind_behavior_change_detection.task_logic.AindChangeDetectionTaskParameters[source]

Bases: TaskParameters

Config:

  • extra: str = allow

  • validate_assignment: bool = True

  • validate_defaults: bool = True

  • strict: bool = True

  • str_strip_whitespace: bool = True

Fields:

aind_behavior_change_detection.task_logic.scalar_value(value: float) → Scalar[source]

Helper function to create a scalar value distribution for a given value.

Parameters:

value (float) – The value of the scalar distribution.

Returns:

The scalar distribution type.

Return type:

distributions.Scalar