Skip to main content

Official Python SDK for the Chassis GPU cloud API by OkeyMeta Ltd

Project description

chassis-cloud (Python)

Official Python client for the Chassis public API (/api/v1).

Default base URL: https://chassis.okeymeta.com.ng/api/v1

PyPI: chassis-cloud · import as chassis

Install

pip install chassis-cloud

Requires Python 3.10+ and httpx.

from chassis import Chassis

Auth

Create an API key in the Chassis console under API Keys. Keys look like chs_… and are shown once.

from chassis import Chassis

with Chassis(api_key="chs_...") as client:
    ...

Quickstart

from chassis import Chassis

with Chassis(api_key="chs_...") as client:
    gpus = client.list_gpus()
    instance = client.spin_up(
        gpuSkuId=gpus[0]["id"],
        name="train-01",
        imageName="pytorch/pytorch:2.1.0-cuda11.8-cudnn8-devel",
    )

Example: training job

Spin up a dedicated GPU, run your trainer on the instance, then stop billing.

from chassis import Chassis

with Chassis(api_key="chs_...") as client:
    gpus = client.list_gpus()
    gpu = next(
        (g for g in gpus if "A100" in str(g.get("displayName", ""))),
        gpus[0],
    )

    instance = client.spin_up(
        gpuSkuId=gpu["id"],
        name="finetune-bert",
        gpuCount=1,
        imageName="pytorch/pytorch:2.1.0-cuda11.8-cudnn8-devel",
        containerDiskGb=80,
        ports="8888/http,22/tcp",
    )
    print("running", instance["id"], instance["status"])

    # On the instance (SSH / Jupyter), run train.py:
    #
    # import torch, torch.nn as nn
    # from torch.utils.data import DataLoader, TensorDataset
    # device = torch.device("cuda")
    # ... train loop ...
    # torch.save(model.state_dict(), "checkpoint.pt")

    client.stop(instance["id"])
    # client.terminate(instance["id"])

Example: inference (serverless)

with Chassis(api_key="chs_...") as client:
    gpus = client.list_gpus()
    endpoint = client.create_endpoint(
        name="text-infer",
        gpuSkuId=gpus[0]["id"],
        workersMin=0,
        workersMax=3,
    )

    result = client.run_sync(
        endpoint["id"],
        body={
            "input": {
                "prompt": "Summarize Chassis in one sentence.",
                "max_tokens": 128,
            }
        },
    )
    print(result)

    job = client.run(endpoint["id"], body={"input": {"prompt": "hello"}})
    status = client.get_job(endpoint["id"], job["id"])
    print(status)

Instance options (create_instance / spin_up)

Field Required Notes
gpuSkuId yes Chassis SKU UUID from list_gpus()
name yes Instance name
gpuCount no Default 1, max 8
imageName no Container image
containerDiskGb no Default 50
volumeGb no Ephemeral volume GB
networkVolumeId no Chassis network volume UUID
registryCredentialId no Chassis registry credential UUID
cloudType no "SECURE" or "COMMUNITY"
ports no e.g. "8888/http,22/tcp"
startAfterCreate no Default True (spin_up forces True)

Methods

GPUs & instances

Method HTTP
list_gpus() GET /gpus
list_instances() GET /instances
create_instance(**kwargs) POST /instances
spin_up(**kwargs) POST /instances (startAfterCreate: true)
get_instance(id) GET /instances/:id
get_instance_logs(id, tail=None) GET /instances/:id/logs
start(id) POST /instances/:id/start
stop(id) POST /instances/:id/stop
restart(id) POST /instances/:id/restart
terminate(id) DELETE /instances/:id

Clusters (multi-node)

Method HTTP
list_clusters() GET /clusters
create_cluster(**kwargs) POST /clusters
get_cluster(id) GET /clusters/:id
start_cluster(id) POST /clusters/:id/start
stop_cluster(id) POST /clusters/:id/stop
terminate_cluster(id) DELETE /clusters/:id

Create with name, gpuSkuId, nodeCount (2–8), and optional gpusPerNode, imageName, networkVolumeId, ports. Nodes get CHASSIS_CLUSTER_ID, CHASSIS_NODE_RANK, and CHASSIS_NODE_COUNT.

Templates, volumes, registries

Method HTTP
list_templates() / create_template(**kwargs) /templates
list_volumes() / create_volume(**kwargs) /volumes
list_registries() / create_registry(**kwargs) /registries

Serverless endpoints

Method HTTP
list_endpoints() GET /endpoints
create_endpoint(**kwargs) POST /endpoints
delete_endpoint(id) DELETE /endpoints/:id
run(endpoint_id, body=None) POST /endpoints/:id/run
run_sync(endpoint_id, body=None, wait_ms=None) POST /endpoints/:id/runsync

Create options also accept env, interruptible, and publicIp.

Responses use data / error. Failures raise ChassisError with .status, .body, and a clear message.

Docs

Human setup guide: https://chassis.okeymeta.com.ng/docs

License

MIT · OkeyMeta Ltd

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

chassis_cloud-0.1.3.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

chassis_cloud-0.1.3-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file chassis_cloud-0.1.3.tar.gz.

File metadata

  • Download URL: chassis_cloud-0.1.3.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for chassis_cloud-0.1.3.tar.gz
Algorithm Hash digest
SHA256 57fb50073bbae9372fd855d4da71b1e629c390d80bbe77e6fab5791c763ee87b
MD5 bf9831993a2fc873cc78ed5492504b66
BLAKE2b-256 f0a1f931af1b721af16927427360caa77c91c63f072c8a935e7fdfaca1c4b53f

See more details on using hashes here.

File details

Details for the file chassis_cloud-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: chassis_cloud-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for chassis_cloud-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c8ab65b0fb0c9a93e23d4e9f942b2308af153cbef01592235ce86fefbf835e9f
MD5 20a5fa6449b5f8b1aaed5704c0a35b68
BLAKE2b-256 180029a1ada5cd100a8b752577b43c3bed293e32bfb5e0ee8336af0377860a7a

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