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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.2.tar.gz
Algorithm Hash digest
SHA256 77d75460817cda141400e87c2d28a42af52376f5e1f239826e74050bba6d5e73
MD5 17fa99ff7b3f1f1d697865ec190ff253
BLAKE2b-256 4197bfbc37adbe4c1107e9a1b5b7249567e4724fae5ec3d90aff4b77274d49ce

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for scenario_characterization-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 45be9172530d69b69b445ddccec05a90ed2bbdd73f135e75efd17dca4f8b62fd
MD5 316915d534a8187424ee7ed65557a208
BLAKE2b-256 addd0a3a09bf7b946ae9c6129c42e81e028d01ac0b01237a99bdbe436f41e193

See more details on using hashes here.

Provenance

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