Skip to main content

Python SDK for the ML Artifact Registry

Project description

zvondb

Python SDK for the ML Artifact Registry — track artifacts, their lineage, and versions across ML experiments.

Installation

pip install zvondb

Quick start

from zvondb import Registry

with Registry(project="my-project") as reg:
    exp = reg.ensure_experiment("my-experiment", parent="baseline")

    with exp.start_job(name="train", git_sha="abc123") as job:
        # Resolve input artifacts (walks parent chain)
        data = job.resolve("TrainingData")
        print(f"Using {data.name} v{data.version} from {data.path}")

        # ... train your model ...

        # Register output artifact
        job.create(
            "TrainedModel",
            type="model",
            storage_name="s3",
            description="Model trained on latest data",
            metadata={"val_loss": 0.15},
            tags=["v1"],
        )
        job.complete()

Configuration

Environment variable Constructor param Default Description
ZVONDB_URL base_url http://localhost:8000 Registry server URL
ZVONDB_API_KEY api_key "" API authentication token

Key concepts

  • Registry — entry point; manages projects and experiments
  • Experiment — a branch of work that can inherit artifacts from a parent experiment
  • Job — a unit of work that consumes and produces artifacts
  • Artifact — a versioned, typed piece of data with metadata, tags, and lineage

Registering external data

exp = reg.get_experiment("baseline")
exp.register("TrainingData", type="dataset", path="s3://bucket/data/v3", description="External dataset")

# Jobs can now resolve it
with exp.start_job(name="train", git_sha="abc") as job:
    data = job.resolve("TrainingData")

W&B integration

with exp.start_job(name="train", git_sha="abc123") as job:
    job.inject_wandb_env()  # Sets WANDB_API_KEY, WANDB_PROJECT, WANDB_RUN_ID etc.
    # Tracking URL auto-set to https://wandb.ai/{entity}/{project}/runs/{job_id}

    # Frameworks like Axolotl that respect W&B env vars just work.
    # For manual usage:
    import wandb
    wandb.init()
    wandb.log({"loss": 0.5})

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zvondb-0.3.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zvondb-0.3.1-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file zvondb-0.3.1.tar.gz.

File metadata

  • Download URL: zvondb-0.3.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for zvondb-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a3fff507dd88ee7730334d1e72e36f13715db154767940283cfcdaf0525347ca
MD5 1eb5da046f9c8533ea209822568cc735
BLAKE2b-256 68c9fe8bfba9a9e788a7e547343f690bd0220c8f172decabb3d3696a36b3bcbc

See more details on using hashes here.

File details

Details for the file zvondb-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: zvondb-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for zvondb-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 20dba9383757d5c39c247ec9f99d444f3f8dc618ea1a0f7e3129cd8541886abd
MD5 43236d54a4b024c7b8390c2fe9b0febc
BLAKE2b-256 b54436b99873fa2f387c50e1e3852c3b7248fc5a6a4fbb8589d7e47de80b3437

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page