Skip to main content

Aind.Behavior.VrForaging.Curricula

CI License ruff uv

A repository of curricula for VR foraging task.

How to run a specific curriculum?

Curricula are modules of the main package: aind_behavior_vr_foraging_curricula.<curriculum_name>.

All curricula are available via the curriculum cli entry point. Available list of commands is printed with the -h flag:

uv run curriculum -h

List available curricula

Available curricula can be listed from the cli using:

uv run curriculum list

Running a curriculum

Curricula can be run using the run subcommand of the curriculum cli entry point.

uv run curriculum run -h

The following arguments are available for the run subcommand:

  • --data-directory: Path to the session data directory that will be used to calculate metrics (required)
  • --input-trainer-state: Path to a deserialized json file with the current trainer state (required)
  • --mute-suggestion: Disables the suggestion output (optional)
  • --output-suggestion: A path to save the serialized suggestion (optional)
  • --curriculum: The name of the curriculum to run (optional)

For a quick "demo" to ensure everything is working, you can run:

uv run curriculum run --data-directory "demo" --input-trainer-state "foo.json" --curriculum "template"

For real-world applications, you may want to omit the "--curriculum" flag and let the system automatically detect the curriculum from the trainer state.

Style guide

To keep things clear, I suggest the following naming convention:

  • Policies should start with p_ (e.g., p_identity_policy)
  • Policy transitions should start with pt_
  • Stages should start with s_ (e.g., s_stage1)
  • Stage transitions should start with st_ and should be named after the stages they transition between (e.g., st_s_stage1_s_stage2)

Define the following modules:

  • metrics: Defines (or imports) metrics classes and how to calculate them from data
  • stages: Defines the different stages of the VR foraging task. This includes task settings and, optionally, policies
  • curriculum: Defines the transitions between the stages and generate entry point to the application

Contributors

Contributions to this repository are welcome! However, please ensure that your code adheres to the recommended DevOps practices below:

Linting

We use ruff as our primary linting tool.

Testing

Attempt to add tests when new features are added. To run the currently available tests, run uv run pytest from the root of the repository.

Lock files

We use uv to manage our lock files and therefore encourage everyone to use uv as a package manager as well.

Metadata

Release files for aind-behavior-vr-foraging-curricula 1.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aind-behavior-vr-foraging-curricula 1.3.4
File Size Uploaded Provenance Actions
aind_behavior_vr_foraging_curricula-1.3.4.tar.gz 41.1 kB Without provenance Details for aind_behavior_vr_foraging_curricula-1.3.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aind-behavior-vr-foraging-curricula 1.3.4
File Interpreter ABI Platform Actions
aind_behavior_vr_foraging_curricula-1.3.4-py3-none-any.whl Python 3 none any Details for aind_behavior_vr_foraging_curricula-1.3.4-py3-none-any.whl

Total release size: 106.9 kB

Release files / aind_behavior_vr_foraging_curricula-1.3.4.tar.gz

Download URL aind_behavior_vr_foraging_curricula-1.3.4.tar.gz
Size 41.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3e1fba06439f463b918b6a08c80e6b3ec0f31cbbcaf2d87fbae1dcb42d8d55c4
BLAKE2b-256 checksum
How to use checksums
7573c58ee4f68316cc4c32518ad13961ac8aeaef21029be6158099d908492751
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / aind_behavior_vr_foraging_curricula-1.3.4-py3-none-any.whl

Download URL aind_behavior_vr_foraging_curricula-1.3.4-py3-none-any.whl
Size 65.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8f1253df9bed0601f5de486c302a579b00268aadb4b47d452242d30f29e80ee
BLAKE2b-256 checksum
How to use checksums
b5f4d5c1d528b1b46a2b1d92519bccd1e6c2b2c3c1e2e279b44d8e0395bc4b61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for aind-behavior-vr-foraging-curricula 1.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page