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
Release history Release notifications | RSS feed
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.0.tar.gz
(10.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
zvondb-0.5.0-py3-none-any.whl
(11.1 kB
view details)
File details
Details for the file zvondb-0.5.0.tar.gz.
File metadata
- Download URL: zvondb-0.5.0.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0658713c301b698044d6e57e659c394fd89812f1aa2e567ce4eb5c5d4e74b53
|
|
| MD5 |
248ecb7f0fe7bbeac2ed45883320bb0e
|
|
| BLAKE2b-256 |
97198169933681c4ea83736e5d99aae3162a423d4cb379112acf97149e8c770c
|
File details
Details for the file zvondb-0.5.0-py3-none-any.whl.
File metadata
- Download URL: zvondb-0.5.0-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7875a6ecb57432595ac9e7a254a7e7a1b9d4b25de23fab14723dd0114065db0d
|
|
| MD5 |
f350b1b57979a20b027454057e7aaa8d
|
|
| BLAKE2b-256 |
094ca1862260b8a76b7d82b2a85037e6f15be0dbaf2c559070b4abc740018f9c
|