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 StackAVd.

Categorical Scores Animated Scenarios Static Scenarios
Alt text Alt text Alt text
Result from our categorical profiler. Agents are visualized from dark green (low crit.) to dark red (high crit.) based on their criticality w.r.t. the ego-agent (blue). Result from our animated visualizer, Shows agents by color vehicle (gray), pedestrian (magenta), cyclist (green) and ego (blue), and the scenario's elapsed time throughout the episode. Result from our static scenario visualizer. 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 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.
  • 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 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.5.tar.gz (81.6 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.5-py3-none-any.whl (112.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.5.tar.gz
Algorithm Hash digest
SHA256 fe1a43fccef6fd72ef766cff333bf86f337e520cfb8e87457efa243d0e882623
MD5 3a886c5b242d561ec1252ab99c662599
BLAKE2b-256 7e5dd8f21ca7d076add03a5b994932c44a1da78fe179e42dd5a41d159b9e71f3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 35ce75bf85283a13582e0d9ed2166dd11dc3152d4dbf82f5d275eb488957b586
MD5 881f0b95d84a955fa0461e56eb5cabc8
BLAKE2b-256 ba7284f826fafee34c4855da46a91da2f0138cb69ae18a59b77498c271ae69b6

See more details on using hashes here.

Provenance

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