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.4.tar.gz (84.8 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.4-py3-none-any.whl (115.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.4.tar.gz
Algorithm Hash digest
SHA256 d89fea23aa3fc577003d0a4e2f3f37fc43ac473e7c55966a2b4d8ef6984ae26c
MD5 7e9efb2e787cc96a398dbf458c309796
BLAKE2b-256 e583f7df256ccdd7e8ba17a297bc7559797813b24bbf91caafcb2fe6a0a0f328

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9c660676c89d18543e8bfd1f1e82c2724cd678856ef8111d25c971e60ec6008b
MD5 90fdccee7f82226d3c99413f448efc14
BLAKE2b-256 342eef0cb34d5ba2e95d05403b1f23ed4c2791a6704085e68eaf07d553d7d3d9

See more details on using hashes here.

Provenance

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