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. This project is primarily a re-implementation of the scenario characterization approach introduced in SafeShift, as part of an internship project at StackAV.

Visualization Examples

Categorical Scores Animated Scenarios Static Scenarios
5c1f8d26c481e36d_2 43 5c1f8d26c481e36d_2 43 6e593bf6b9dbbf73
Results from our categorical profiler. Agents are visualized from dark green (low crit.) to dark red (high crit.) based on their criticality with respect to the ego agent (blue). Result from our animated visualizer, showing agents by type: vehicle (gray), pedestrian (magenta), cyclist (green), and ego (blue), along with the scenario's elapsed time throughout the episode. Result from our static scenario visualizer. The episode's time is shown by increasing trajectory opacity over time.

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 development dependencies, 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.
  • Analysis: Shows how to run feature and score analyses.
  • 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 the 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.11.tar.gz (83.7 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.11-py3-none-any.whl (114.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.11.tar.gz
Algorithm Hash digest
SHA256 1e6079787f24bfa585648298db8cdc3c6b6b9ff12cb575285f03d89752a126b5
MD5 99c30be1e72aa56a6afe9fe9449e0472
BLAKE2b-256 2eaa6b59c85f288568d22ba7657f645af5514879b0a3b69c58d387cb04186732

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e3d8717cac0ea6ac1a07125db417914b146e33392f731d6017d89c5dddfa55ac
MD5 f3810a6e4234d5145163e30154b78984
BLAKE2b-256 cb3b168c4be2329bf8dd8b095872143a946c08ac79b95f54538bbfb3e234e044

See more details on using hashes here.

Provenance

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