Skip to content

Commit 286cef5

Browse files
authored
Merge pull request #32 from DSD-DBS/update-readme
docs: update readme to mention --ontology
2 parents b0fd186 + 197a10a commit 286cef5

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ To set up a development environment, clone the project and install it into a
2828
virtual environment.
2929

3030
```zsh
31+
# Note that contributors should clone via ssh instead as GitHub does not allow pushing via https!
3132
git clone https://github.com/DSD-DBS/raillabel-providerkit
3233
cd raillabel-providerkit
3334
python -m venv .venv
@@ -60,6 +61,12 @@ If you want to output in .csv format instead of .json format, you can use this c
6061
python -m raillabel_providerkit /path/to/folder_containing_scenes/ /path/to/output_folder --use-csv --no-json
6162
```
6263

64+
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:
65+
66+
```zsh
67+
python -m raillabel_providerkit /path/to/folder_containing_scenes/ /path/to/output_folder --ontology /path/to/project-ontology.yaml
68+
```
69+
6370
# Contributing
6471

6572
We'd love to see your bug reports and improvement suggestions! Please take a

0 commit comments

Comments
 (0)