Skip to main content

Automatic labeling of CommonRoad scenarios.

Project description

CommonRoad Automatic Scenario Labeling

PyPI pyversions PyPI version fury.io PyPI download week PyPI download month PyPI license

Automatically assign correct labels to CommonRoad scenarios and check whether existing tags are correct.

The full documentation of the API and introductory examples can be found at cps.pages.gitlab.lrz.de/commonroad/automatic-scenario-labeling.

Quick Start

Installation

$ pip install commonroad-labeling

Usage Example

from pathlib import Path

from commonroad_labeling.common.general import get_detected_tags_by_file

# specify a directory and detect tags
tags_by_file = get_detected_tags_by_file(Path.cwd().joinpath("path", "to", "directory"))

Sketched Functionality

  1. Load scenario using commonroad-io.
  2. Read all currently assigned scenario tags.
  3. Determine which tags are correct.
    1. Using formalized rules.
    2. Using traffic rule monitor.
    3. Using criticality metrics.
  4. Check whether the tags are consistent with the previously assigned tags. → Warning if necessary
  5. Overwrite scenario with corrected tags.

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

commonroad_labeling-2025.1.1.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commonroad_labeling-2025.1.1-py3-none-any.whl (85.3 kB view details)

Uploaded Python 3

File details

Details for the file commonroad_labeling-2025.1.1.tar.gz.

File metadata

  • Download URL: commonroad_labeling-2025.1.1.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.18 Linux/5.15.0-87-generic

File hashes

Hashes for commonroad_labeling-2025.1.1.tar.gz
Algorithm Hash digest
SHA256 66bf5041d5a4dbf94624b16998da83a1c684045e0b9074eede5c63ec151f0ff6
MD5 7c4873dfe5a36060ca44e3da4cb652bc
BLAKE2b-256 c34619e130758e81e84dd81f48133243f1d78216b76505bc1a16c6df3573d2a7

See more details on using hashes here.

File details

Details for the file commonroad_labeling-2025.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for commonroad_labeling-2025.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 861bb1a448ffbe43a26dac5ccd46c12c43bcb07aa573a5fc74ecebf7ebc54cae
MD5 628ff27c1eb2dc37eb42e7cb2fa08226
BLAKE2b-256 5eb72ee85bfbe6fdbdbfbf2bd16246f9156bf852e9b40be58de32f1c8baa564e

See more details on using hashes here.

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