Skip to main content

Automated Scenario Characterization Toolkit.

Project description

WIP ScenarioCharacterization

Note: This project is a work in progress.

A generalizable, automated scenario characterization framework for trajectory datasets.

Currently, this is a re-implementation of the scenario characterization approach introduced in SafeShift, as part of an internship project at StackAV.

Repository: github.com/navarrs/ScenarioCharacterization

This repository currently uses:

  • uv as the package manager.
  • Hydra for hierarchical configuration management.
  • Pydantic for input/output data validation.

Installation

Install the package

uv pip install scenario-characterization

Install the package in editable mode

Clone the repository and install the package in editable mode:

git clone git@github.com:navarrs/ScenarioCharacterization.git
cd ScenarioCharacterization
uv run pip install -e .

To install with Waymo dependencies (required for running the example), use:

uv run pip install -e ".[waymo]"

If installing with dev, run

uv run pip install -e. ".[dev]"
uv run pre-commit install

Documentation

  • Organization: Overview of the Hydra configuration structure.
  • Schemas: Guidelines for creating dataset adapters and processors that comply with the required input/output schemas.
  • Characterization: Details on supported scenario characterization and visualization tools, and how to use them.
  • Example: Step-by-step usage example using the Waymo Open Motion Dataset.

Citing

@INPROCEEDINGS{stoler2024safeshift,
  author={Stoler, Benjamin and Navarro, Ingrid and Jana, Meghdeep and Hwang, Soonmin and Francis, Jonathan and Oh, Jean},
  booktitle={2024 IEEE Intelligent Vehicles Symposium (IV)},
  title={SafeShift: Safety-Informed Distribution Shifts for Robust Trajectory Prediction in Autonomous Driving},
  year={2024},
  volume={},
  number={},
  pages={1179-1186},
  keywords={Meters;Collaboration;Predictive models;Robustness;Iron;Trajectory;Safety},
  doi={10.1109/IV55156.2024.10588828}}

Development

Run uv sync --frozen --all-groups to set up environment. Run pre-commit run --all-files to run all hooks on all files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scenario_characterization-0.3.1.tar.gz (84.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scenario_characterization-0.3.1-py3-none-any.whl (115.2 kB view details)

Uploaded Python 3

File details

Details for the file scenario_characterization-0.3.1.tar.gz.

File metadata

File hashes

Hashes for scenario_characterization-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3f166370420a417190e2d7fa561496d94ac46387e67b47bfa962bfe40fd7b8ed
MD5 abe4c4fded1ad55a035b3a167882c1f8
BLAKE2b-256 e864a33da3e1b76facf8a1cdf40febfbc2bc6801059ae71987fd6cc5192bb226

See more details on using hashes here.

Provenance

The following attestation bundles were made for scenario_characterization-0.3.1.tar.gz:

Publisher: package.yml on navarrs/ScenarioCharacterization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scenario_characterization-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for scenario_characterization-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e671dfe64f20e676b2af98aaa7e6a63a93f1bc7c810eb6af70502687deea513c
MD5 9c842ec0ca27d908e61bb464b69c6117
BLAKE2b-256 5bf01de7b40daa0ab7963bc2dd9db379994019477e34c327cdd4619534301d6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for scenario_characterization-0.3.1-py3-none-any.whl:

Publisher: package.yml on navarrs/ScenarioCharacterization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page