aind_behavior_curriculum.curriculumΒΆ

Core Stage and Curriculum Primitives.

Functions

create_curriculum(name, version, tasks[, ...])

Creates a new curriculum model with the specified name, version, and tasks.

is_non_deserializable_callable(value)

Check if the given value is an instance of _NonDeserializableCallable.

make_task_discriminator(tasks)

Creates a discriminated union type for the given tasks.

try_materialize_non_deserializable_callable_error(value)

Attempts to materialize the error from a non-deserializable callable.

Classes

BehaviorGraph(*[, nodes, graph])

Core directed graph data structure used in Stage and Curriculum.

Curriculum(*, pkg_location, name, version, ...)

Curriculum manages a StageGraph instance with a read/write API.

Metrics(**extra_data)

Abstract Metrics class.

MetricsProvider(function, *[, skip_validation])

A type for a callable that is able to produce Metrics

Policy(function, *[, skip_validation])

User-defined function that defines how current Task parameters change according to metrics.

PolicyGraph(*[, nodes, graph])

Graph for Stage.

PolicyTransition(function, *[, skip_validation])

User-defined function that defines how current Policies change during a Stage.

Stage(*, name, task, graph, start_policies, ...)

Instance of a Task.

StageGraph(*[, nodes, graph])

Graph for Curriculum.

StageTransition(function, *[, skip_validation])

User-defined function that defines criteria for transitioning stages based on metrics.