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.2.tar.gz (8.4 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.2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.3.2.tar.gz
Algorithm Hash digest
SHA256 8e5479cd5aa8e43ea3f61b6171496e0a2569513b98b09dd615156081b9f1aa53
MD5 fe98491c47c26a890207eb82c31a8b21
BLAKE2b-256 87138e320c130b33e72a8e26e561d5f28c97ae1f81a906bb74165e2ffb982346

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5667a92169748d874ac8c77044bf2df3dd7a4bfed69cb2328fa808b832357bde
MD5 2a477039a3d4dc4db2f09b8718361017
BLAKE2b-256 4a30e620666199277d4a0531d071cd94e7b692c1a9707fb9ca9c9857945a5f1c

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