Skip to main content

SDK for Vast.ai GPU Cloud Service

Project description

Vast.ai Python SDK & CLI

PyPI version

The official Vast.ai Python package — provides both the CLI and SDK for managing Vast.ai GPU cloud resources, plus a serverless client for endpoint inference.

Install

pip install vastai

Note: pip install vastai-sdk also works and installs the same package. Both package names are supported for backward compatibility.

Quickstart

  1. Get your API key from https://cloud.vast.ai/manage-keys/

  2. Set your API key:

vastai set api-key YOUR_API_KEY
  1. Test a search:
vastai search offers --limit 3

You should see a short list of available GPU offers.

CLI Usage

The vastai command provides full access to the Vast.ai platform from your terminal:

vastai search offers 'gpu_name=RTX_4090 num_gpus>=4'
vastai create instance 12345 --image pytorch/pytorch --disk 32 --ssh --direct
vastai show instances
vastai stop instance 12345
vastai destroy instance 12345

Run vastai --help for a full list of commands. You can also use --help on any subcommand:

vastai search offers --help
vastai create instance --help

SDK Usage

from vastai import VastAI

vast = VastAI()  # uses VAST_API_KEY env var, or pass api_key="..."

vast.search_offers(query='gpu_name=RTX_4090 num_gpus>=4')
vast.show_instances()
vast.start_instance(id=12345)
vast.stop_instance(id=12345)

Use help(vast.search_offers) to view documentation for any method.

Migrating from vastai-sdk? The old import still works: from vastai_sdk import VastAI

Using the Serverless Client

  1. Create the client
from vastai import Serverless
serverless = Serverless() # or, Serverless("YOUR_API_KEY")
  1. Get an endpoint
endpoint = await serverless.get_endpoint("my-endpoint")
  1. Make a request
request_body = {
    "model": "Qwen/Qwen3-8B",
    "prompt" : "Who are you?",
    "max_tokens" : 100,
    "temperature" : 0.7
}
response = await serverless.request("/v1/completions", request_body)
  1. Read the response
text = response["response"]["choices"][0]["text"]
print(text)

Find more examples in the examples/ directory.

Tab Completion

Tab completion is supported in Bash and Zsh via argcomplete (installed automatically). To enable it:

activate-global-python-argcomplete

Or for a single session:

eval "$(register-python-argcomplete vastai)"

Contributing

This repository is open source. If you find a bug, please open an issue. PRs are welcome.

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

vastai-1.0.0.dev2.tar.gz (123.9 kB view details)

Uploaded Source

Built Distribution

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

vastai-1.0.0.dev2-py3-none-any.whl (146.0 kB view details)

Uploaded Python 3

File details

Details for the file vastai-1.0.0.dev2.tar.gz.

File metadata

  • Download URL: vastai-1.0.0.dev2.tar.gz
  • Upload date:
  • Size: 123.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1020-oem

File hashes

Hashes for vastai-1.0.0.dev2.tar.gz
Algorithm Hash digest
SHA256 7ed35ecddd80d92935decd2213ac68059c0a8c3c6d33c3282c6ee4377c5f4531
MD5 2cd2deee060476ec5c4c2218c515766a
BLAKE2b-256 fcd9f06775bc652381187575acdec7b79c602fb23c42fb206fcbc7255d2a8203

See more details on using hashes here.

File details

Details for the file vastai-1.0.0.dev2-py3-none-any.whl.

File metadata

  • Download URL: vastai-1.0.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 146.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1020-oem

File hashes

Hashes for vastai-1.0.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 da96881012682ca2d607b88960e99ed2d7a64624be4fe0772123499704e29b3a
MD5 e6852c3ee493112b80fbb55db6e71d24
BLAKE2b-256 032f4557681802758080cd04e3c89580060aedd36286ea3a1cc7ca89a657e4a9

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