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.0.tar.gz (82.2 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.0-py3-none-any.whl (115.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.0.tar.gz
Algorithm Hash digest
SHA256 590d3aed58e3d6b99645aa62995d75e7f410b97cdfe09a17a4dc11fafb581b80
MD5 752ea7506d10a8cecb340b449358b9d3
BLAKE2b-256 68bfa5ef8a00cee0f74a42e268c65648bc286ffea1507a7f42b75cfefc62bdd9

See more details on using hashes here.

Provenance

The following attestation bundles were made for scenario_characterization-0.3.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for scenario_characterization-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ebf9a23f591d98e7423a7873da5a938d7226018edca29e1f310b0f2225fa6585
MD5 56e8836d753fa72061d996729972fc88
BLAKE2b-256 cba738ff4e81337fa08c568b2dc674113cea7c3e056a3d7f03fd7f30aa211b26

See more details on using hashes here.

Provenance

The following attestation bundles were made for scenario_characterization-0.3.0-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