vdschema 0.1.0

Unified annotation schema and JSONL IO for vision datasets.

vdschema

Unified annotation schema and JSONL IO for vision datasets.

vdschema can be used by annotation pipelines to write JSONL annotation files and by training pipelines to read those files back into typed Python objects.

Install

uv sync

Basic Usage

from vdschema import AnnotationReader, AnnotationWriter, DetectionAnnotation

writer = AnnotationWriter("output/detection/annotation_meta.jsonl", DetectionAnnotation)
writer.append(
    filename="images/sample.jpg",
    width=640,
    height=480,
    instances=[
        {"id": 0, "category_id": 1, "bbox": [10, 20, 100, 200]},
    ],
)
writer.save()

annotations = AnnotationReader(
    "output/detection/annotation_meta.jsonl",
    DetectionAnnotation,
).load()

Development

uv sync --group dev
uv run python test_annotation_format.py
uv run ruff check .
uv build

Publishing

This repository includes a GitHub Actions workflow for publishing to PyPI with trusted publishing. Configure the PyPI project and GitHub environment before creating a release.