Skip to main content

Tenant SDK for the AuspexAI volunteer compute network

Project description

AuspexAI Tenant SDK

CI

The researcher surface of the AuspexAI volunteer compute network: everything a research tenant needs to author an experiment, submit it to the live coordinator, drive it to convergence, and walk away holding a cryptographically verified copy of the data — receipts, a Rekor-anchored attestation, and a signed custody record included.

Python ≥ 3.11, Apache-2.0. Install from PyPI:

pip install auspexai-tenant
# with the analysis surface (pandas/Parquet evidence loader):
pip install "auspexai-tenant[analysis]"

Most researchers don't install the SDK directly — the researcher onramp (curl -fsSL https://getresearcher.auspexai.network | bash) provisions it alongside the dashboard. Releases are also on the releases page, Sigstore-signed.

New researcher? The full front door — install, apply for a tenant via auspexai-tenant apply (GitHub device flow, no key material to paste), and your first verified run — is ONBOARDING.md.

The researcher lifecycle

The SDK covers the whole arc. Each stage works today against the live coordinator (https://coord.auspexai.network).

1. Author

  • Published wire contracts (JSON Schema + CDDL, immutable per the honor-forever versioning policy) for manifests, work units, executor output, results, reducer decisions, and receipts — with strict Pydantic models for all of them. Tenants may consume the SDK or implement the published contract independently.
  • ExecutorHarness — wrap your science in a run_one(unit, models_dir) -> dict function and the harness handles the worker invocation contract (a working tenant is ~30 lines; see examples/synthetic_tenant/).
  • ReducerHarness — same pattern for custom reduction.
  • auspexai_tenant/lite.py — a zero-dependency, stdlib-only, Python 3.10-safe mirror of the harness, designed to be vendored into your package so your executor runs in the worker sandbox without installing the SDK there. Includes InferenceClient for LLM-inference tenants: deterministic chat against the model the worker serves over a sandbox-local socket (temperature pinned to 0 by the worker; seed/num_predict/num_ctx whitelisted).
  • Static work-unit packing (tar_writer/tar_reader) and package-digest helpers that match the worker's verification byte-for-byte.

2. Sign & submit

  • Ed25519 tenant keypair (key generate / key pubkey); every API call is signed (RFC 9421 HTTP message signatures) — no passwords, no tokens.
  • manifest validatemanifest signmanifest upload. Manifests are immutable once submitted (manifest-swap protection: work units bind the manifest hash); a maintainer approves the experiment before any work is scheduled.
  • Model catalog: model catalog surfaces the network's bottom-up model catalog — the emergent set of models the active workers declare they serve.

3. Drive

  • run_until — the autonomic driver: submit a round, fold results into a checkpointable aggregate (Counter/Mean/Histogram or your own) as they arrive, test your convergence condition, generate the next batch. Resumable via a round-atomic journal; wakes on an SSE doorbell instead of hot-polling; pluggable stall policy (abort / finalize-partial / keep waiting).
  • CLI: experiment run <id> --driver yourmodule:build drives a whole adaptive experiment headlessly. experiment reduce batch-reduces a completed consensus set.

4. Watch

  • experiment list / status / results (consensus by default, --raw for all replicas) / receipts, plus an anonymized activity rollup (contributor counts, replication fill — never volunteer identities).

5. Verify — the part you can't get from a rented GPU

Every completed experiment yields a result-set attestation: a Merkle root over the per-unit consensus set, COSE-signed by the network's published key and anchored in the public Sigstore Rekor transparency log. The SDK verifies all of it independently:

  • experiment attestation --check-rekor --verify-against-results — recompute the root from your own pulled results, check the signature against the published signer roster, and confirm public log inclusion.
  • v1 attestations additionally bind each work unit's input hash into the leaves: "result R was produced from parameters P" is cryptography, not a database row.
  • Per-result worker signatures — the only signatures in the chain not made by the coordinator — verify from the bundle alone.

6. Take custody & analyze

  • experiment export --verify downloads the evidence bundle — results + work-unit inputs + receipts + attestation + Rekor proof + a signed proof-of-transfer — and runs the full verification chain on receipt. Collection transfers data custody to you: the network can re-verify your bundle forever, but after age-off it never re-delivers. Your verified copy is the durable copy.
  • bundle verify <file> — re-verify a saved bundle any time, offline, with no coordinator. Hand the file and the command to a reviewer.
  • evidence.load_verified(bundle) — run the chain, then get a tidy pandas DataFrame (inputs as input.* columns, outputs as output.*). There is deliberately no force flag: analysis begins from a verified dataset or it doesn't begin. bundle table <file> -o results.parquet is the no-Python path to Excel/Tableau/R. See examples/evidence_loader.ipynb.
  • Reading your evidence — the analysis guide: each verified row carries integrity_basis, ran_under (containment), and served_weights, and the experiment carries an apparatus footprint. Stratify, don't pool; weight by replication + independence; treat divergence as signal, not failure; correct for the footprint. Read this before you aggregate.

CLI quick reference

Group What it does
key Ed25519 tenant keypair (generate, pubkey)
manifest validate, sign, upload an experiment manifest
experiment list, status, run (autonomic driver), results, receipts, attestation, reduce, export
bundle verify a saved evidence bundle offline; write it as a CSV/Parquet table
model browse the network model catalog
receipts decode/pretty-print CBOR receipts

Every command has --help with the full contract.

Examples

Status

Open beta. The coordinator is live and experiments run on real volunteer hardware end-to-end (work-unit dispatch, consensus, receipts, live Rekor anchoring, evidence-bundle custody). The network is publicly installable: researchers self-onboard with the getresearcher one-liner and apply for a tenant via auspexai-tenant apply (GitHub or ORCID device flow — no invitation, no key material to paste). A maintainer reviews the application against the Research Ethics Policy; from there a certified starter runs with no code review — the safest first run — while bringing your own code is reviewed more closely. Questions about running research on the network? Email contact@auspexai.network.

Scope & license boundary

The Tenant SDK is the contract between tenant research code and the AuspexAI platform. It is intentionally a thin client over a published data + subprocess contract: tenants consume the SDK's stable surface (or implement the published contract independently); the AGPL-3.0 platform (auspexai/platform, auspexai/worker) runs on the other side of that contract. Tenant project modules authoring against the SDK are not derivative works of the AGPL platform — the split follows the published-contract pattern used by MongoDB drivers, Grafana plugins, and Sentry SDKs (copyleft on the server, permissive on the SDK). See the AuspexAI Principles & Scope §5.2 for the structural argument.

Apache-2.0 for the SDK. Tenants license their own research code however suits them.

Governance & policies

  • Governance — roles, decision rules, recruitment, conflict of interest
  • Code of Conduct — community standards, reporting, escalation pathway
  • Contributing — DCO sign-off, PR workflow, RFC requirement for substantial changes
  • Research Ethics Policy — what research can run on the network and how it's reviewed
  • Tenant Terms — including the results-custody model this SDK implements

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

auspexai_tenant-0.6.13.tar.gz (155.5 kB view details)

Uploaded Source

Built Distribution

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

auspexai_tenant-0.6.13-py3-none-any.whl (121.3 kB view details)

Uploaded Python 3

File details

Details for the file auspexai_tenant-0.6.13.tar.gz.

File metadata

  • Download URL: auspexai_tenant-0.6.13.tar.gz
  • Upload date:
  • Size: 155.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for auspexai_tenant-0.6.13.tar.gz
Algorithm Hash digest
SHA256 6de345a6ef9442a6889fc102e0269884d0a3d7d1c4c4bd77538630572e55650a
MD5 2b5595097f80296a0823c79c03db1ebc
BLAKE2b-256 f5877271aaec2090621dd644a4d95489d42c22478a1597ad1ff6248ccfac11de

See more details on using hashes here.

Provenance

The following attestation bundles were made for auspexai_tenant-0.6.13.tar.gz:

Publisher: release.yml on auspexai/tenant-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file auspexai_tenant-0.6.13-py3-none-any.whl.

File metadata

File hashes

Hashes for auspexai_tenant-0.6.13-py3-none-any.whl
Algorithm Hash digest
SHA256 1c298c0bdd3c7db64dad88b130c61fb2b257f27b4300109505ab9c9bdd87d1c5
MD5 d40713483bbefa84c3f338570060305e
BLAKE2b-256 f96f9fb0a71003ae89663a2bb654ba303fb320d3d2f9eb20c212dc048122f083

See more details on using hashes here.

Provenance

The following attestation bundles were made for auspexai_tenant-0.6.13-py3-none-any.whl:

Publisher: release.yml on auspexai/tenant-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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