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"],
        )
        # Or use create_with_info() to get version and other details
        artifact = job.create_with_info(
            "TrainedModel",
            type="model",
            storage_name="s3",
            description="Model trained on latest data",
            metadata={"val_loss": 0.15},
        )
        print(f"Created {artifact.name} v{artifact.version} at {artifact.path}")

        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.5.1.tar.gz (10.0 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.5.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.5.1.tar.gz
Algorithm Hash digest
SHA256 4c937bf9b0b1bd0fa54ba88c55ad8a310d601565a6bc7b1da3a0bdecb1f4fad6
MD5 3a1be8d49eb9cf9441fde254cb536af5
BLAKE2b-256 e43fd299cdf91c7991d5c9d2b7343889301f615d070aa1736627d90a626fbbd4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4c4c95f2850299b577c1a99fa741f8dbdeaa752afdc7541204317888b78e17a5
MD5 b37ae104a2053ecf4daa55f966ba5dbb
BLAKE2b-256 8e13c855ba334215a5f4abd278ec8cf68ef800164f984a94b7a3c54779b903a6

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