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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.5.2.tar.gz
Algorithm Hash digest
SHA256 cc172ad591e2ff8185545ccdda5e3fe935e5a3727c3d659c9952ed399541bad0
MD5 9b722de3816cfe5ea413da041a6b71b0
BLAKE2b-256 bab709480c2daa702c35217d972161cb3ead22ff1489e6a7d7d7b42c81fa6155

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for zvondb-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6f4ea451987e3ca7df691efd98106222e4339f6947f3193feacf9655cd2c8cfd
MD5 fcafcd50e8cf171d513cc76bb676a0fe
BLAKE2b-256 bea832e6fec26a300dc759dafbfad104deb9099a46ff59abc15124a36992576c

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