Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs #12

Merged
merged 2 commits into from
Dec 2, 2024
Merged

Update Docs #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e585696
docs: adapt validate docs
tklockau Dec 2, 2024
2adc73c
docs: change order of howtos
tklockau Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/source/howtos/2 Validating Scenes.rst → docs/source/howtos/1 Validating Scenes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SPDX-License-Identifier: Apache-2.0

===================
2 Validating Scenes
1 Validating Scenes
===================

Motivation
Expand All @@ -17,12 +17,14 @@ For the validation you need 2 things: the scene and the project specific ontholo
The onthology should be provided by your project partner. It is a .yaml-file listing all classes and their attributes.

.. code-block:: python
import json
from pathlib import Path

from raillabel_providerkit import validate
import raillabel

scene = raillabel.load("path/to/scene.json")
with Path("path/to/scene.json").open() as scene_file:
scene_dict = json.load(scene_file)

assert validate(scene, "path/to/onthology.yaml") == []
assert validate(scene_dict) == []

If this code does not raise any errors, you are good to go. If it does, read the content of the list `validate` returns carefully. It should tell you where the errors are. If you are unsure, contact your project partner or raise an issue on GitHub.
2 changes: 1 addition & 1 deletion docs/source/howtos/1 Converting Files.rst → docs/source/howtos/2 Converting Files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SPDX-License-Identifier: Apache-2.0

=============================
1 Converting Annotation Files
2 Converting Annotation Files
=============================

Many annotation providers have their own proprietary format, that they use internally. If the project requirements demand the delivery of the data in the RailLabel format, then the `raillabel_providerkit.convert()` method can support you with that.
Expand Down
Loading