gipper documentation

Driving gipper from another repo

Writing a job that runs on any provider

The Python surface

These names are stable within 0.x:

Name What
gipper.job.load(path) a Job
gipper.run.plan(job, provider=, gpu=, throughput=) (offers, hourly ceiling, notes); each offer carries .estimate
gipper.run.run(job, provider=, dry_run=, log_dir=, gpu_override=, throughput=) (run_id, outcome): succeeded, failed, timeout, capped, interrupted, error, termination_pending
gipper.run.estimate(job, offer=o) the whole-run estimate for one offer
gipper.run.preflight(remote) GPU idle check; wrap it to add your own. Raise gipper.run.Unsuitable when the host works but doesn't suit the job (wrong architecture for a pinned runtime), and gipper.run.BadHost when it's broken. Both replace the host; only BadHost counts against it in memory
gipper.run.settings looked up at call time, so a wrapper can change caps for one run
gipper.providers.load(name) .offers(job), .list_ours(), .get(id) (Vast), .terminate(id), .account(), .billed(since)
gipper.providers.runpod.Runpod().api() the raw Runpod client
gipper.ledger.read(since=, kinds=, job=) / .write(kind, payload, job=) receipts
gipper.history.History.load() memory: .failure(p, machine), .ready_s, .mbps, .compute_s(workload, gpu), .billing_factor(p)
gipper.ssh.Remote(host, port, user) .run, .put, .put_secrets, .get over gipper's key. .put records a custody manifest first and can raise gipper.custody.Refused

Kept for scripts written before 0.2: gipper.runpod.api.Api and gipper.runpod.run._wait_ready. Any other gipper.runpod.run name raises an error pointing at gipper.run, so a script that patches the old pick_gpu fails instead of silently patching nothing.

Receipts a guard can rely on

An editable install imports code directly from its checkout. Use an isolated worktree for changes if clients are using that checkout; see AGENTS.md.