Skip to content

Commit

Permalink
docs: adapt validate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tklockau committed Dec 2, 2024
1 parent 9ea9e29 commit e585696
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/source/howtos/2 Validating Scenes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit e585696

Please sign in to comment.