RailLabel Providerkit

A library for annotation providers of raillabel-formatted data.

Documentation

Read the full documentation on Github pages.

Installation

You can install the latest released version directly from PyPI.

pip install raillabel-providerkit

To set up a development environment, clone the project and install it into a virtual environment.

# Note that contributors should clone via ssh instead as GitHub does not allow pushing via https!
git clone https://github.com/DSD-DBS/raillabel-providerkit
cd raillabel-providerkit
python -m venv .venv

source .venv/bin/activate.sh  # for Linux / Mac
.venv\Scripts\activate  # for Windows

pip install -U pip pre-commit
pip install -e '.[docs,test]'
pre-commit install

Command Line Usage

You can use the validation functionality directly from the command line. To get a list of supported arguments, use this command:

python -m raillabel_providerkit --help

To simply validate all scenes in a folder and output any detected issues to an output folder (in .json format), use this command:

python -m raillabel_providerkit /path/to/folder_containing_scenes/ /path/to/output_folder

If you want to output in .csv format instead of .json format, you can use this command:

python -m raillabel_providerkit /path/to/folder_containing_scenes/ /path/to/output_folder --use-csv --no-json

Note that you need to provide a project-specific ontology (in .yaml format) to make use of the ontology validation functionality! You can point raillabel_providerkit at it like this:

python -m raillabel_providerkit /path/to/folder_containing_scenes/ /path/to/output_folder --ontology /path/to/project-ontology.yaml

Contributing

We'd love to see your bug reports and improvement suggestions! Please take a look at our guidelines for contributors for details.

Licenses

This project is compliant with the REUSE Specification Version 3.0.

Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in LICENSES/Apache-2.0.txt)

Dot-files are licensed under CC0-1.0 (see full text in LICENSES/CC0-1.0.txt)