Skip to main content

avdm

The Audiovisual Scene Data Model (AVDM-001), revision 0.2: one canonical document for one shot, and the serializers that render it into the text a video model reads.

media ──observe──▶ SceneDocument ──render──▶ caption / prompt ──generate──▶ media
                    (observed)                 to_h3, to_prose
                    SceneDocument (planned) ──render──┘

The same serializer writes a training caption from an observed document and an inference prompt from a planned one, so the two registers match by construction.

What is in 0.2

Part File
JSON Schema, the source of truth src/avdm/schema/avdm-0.2.schema.json
Attribute vocabulary, one table src/avdm/vocabulary.py
The form an observer model fills in src/avdm/observe.py
Typed models (pydantic v2), mirrored by hand src/avdm/model.py
Evidence rules: assess, assemble, validate src/avdm/evidence.py
Serializers: to_h3, to_prose, to_ste src/avdm/render.py
Token budget warning src/avdm/budget.py

The subset is a single observed or planned shot: Asset, Shot with camera moves, Entity, Event, AudioCue, Observation, exact rational TimeRanges, and per-aspect coverage. 0.2 adds attribute claims on entities and on the shot, from a controlled vocabulary, where unclear is always an answer and never a default. When a claim is specified, the serializers write the picture from the claims, not from free prose. Intent, constraints, baselines, bindings and edits come later.

Use

import avdm

doc = avdm.assemble(avdm.SceneDocument.model_validate_json(raw))  # apply evidence rules
assert not avdm.validate(doc)
caption = avdm.to_h3(doc, trigger="ohwx")

Develop

uv sync
uv run pytest
uv run ruff check . && uv run ruff format --check . && uv run ty check

To adopt AVDM in another repository, point that repository's agent at AGENTS.md.

Metadata

Release files for avdm 0.2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for avdm 0.2.3
File Size Uploaded Provenance Actions
avdm-0.2.3.tar.gz 66.2 kB With provenance Details for avdm-0.2.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for avdm 0.2.3
File Interpreter ABI Platform Actions
avdm-0.2.3-py3-none-any.whl Python 3 none any Details for avdm-0.2.3-py3-none-any.whl

Total release size: 91.8 kB

Release files / avdm-0.2.3.tar.gz

Download URL avdm-0.2.3.tar.gz
Size 66.2 kB
Tags Source
SHA-256 checksum
How to use checksums
bb82f4213f4f4d716ade26638db34fa787be4c90266bf0058041b32729ebed7e
BLAKE2b-256 checksum
How to use checksums
3b386e04f1f7f1b9e8ca2e95780791baf57c4d5bdf777413f0a2fd376aee9ad4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / avdm-0.2.3-py3-none-any.whl

Download URL avdm-0.2.3-py3-none-any.whl
Size 25.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
28c2f327c464c5f1b538d6ecab47f324db629eff5b604543e87fb139b7da50cc
BLAKE2b-256 checksum
How to use checksums
cd5ba8ac5c68df69211cb2c4d55cac5d3658e9c8c50790faa66c57d79483a540
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Security for avdm 0.2.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for avdm-0.2.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.3 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page