Skip to main content

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.

Metadata

Release files for commonroad-labeling 2025.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for commonroad-labeling 2025.1.2
File Size Uploaded
commonroad_labeling-2025.1.2.tar.gz 27.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for commonroad-labeling 2025.1.2
File Interpreter ABI Platform
commonroad_labeling-2025.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 66.2 kB

Release files / commonroad_labeling-2025.1.2.tar.gz

Download URL commonroad_labeling-2025.1.2.tar.gz
Size 27.5 kB
Tags Source
SHA-256 checksum
How to use checksums
56ebbd6d009561b8d006abe341fbf93352b29b69ee1c8114127f66c93ee9661c
BLAKE2b-256 checksum
How to use checksums
074b2adf8cbb11b3471716f48c01a5dfe4068a364aaf7e98f26d649be90cc3a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.10.19 Linux/5.15.0-87-generic

Release files / commonroad_labeling-2025.1.2-py3-none-any.whl

Download URL commonroad_labeling-2025.1.2-py3-none-any.whl
Size 38.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
660bc8c3d8046703b1d27fd28957a9f0b56c5594c7a1d8d93d31943c818a9662
BLAKE2b-256 checksum
How to use checksums
1bea0c1ed79838db7e30b94a1d581957c4e57d4ac4381134a60db86c97db662a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.10.19 Linux/5.15.0-87-generic

Release history Release notifications | RSS feed

This release

2025.1.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page