Backend.AI Client SDK for Python

Python 3.8 or higher is required.

You can download its official installer from python.org, or use a 3rd-party package/version manager such as homebrew, miniconda, or pyenv. It works on Linux, macOS, and Windows.

We recommend to create a virtual environment for isolated, unobtrusive installation of the client SDK library and tools.

$ python3 -m venv venv-backend-ai
$ source venv-backend-ai/bin/activate
(venv-backend-ai) $

Then install the client library from PyPI.

(venv-backend-ai) $ pip install -U pip setuptools
(venv-backend-ai) $ pip install backend.ai-client

Set your API keypair as environment variables:

(venv-backend-ai) $ export BACKEND_ACCESS_KEY=AKIA...
(venv-backend-ai) $ export BACKEND_SECRET_KEY=...

And then try the first commands:

(venv-backend-ai) $ backend.ai --help
...
(venv-backend-ai) $ backend.ai ps
...

Check out more details with the below table of contents.

• Installation
  • Linux/macOS
  • Windows
  • Verification
• Client Configuration
• Command Line Interface
  • Configuration
  • Compute Sessions
  • Container Applications
  • Storage Management
  • Advanced Code Execution
  • Session Templates
• Developer Guides
  • Client Session
  • Examples
  • Testing
• High-level Function Reference
  • Admin Functions
  • Agent Functions
  • Auth Functions
  • Configuration
  • KeyPair Functions
  • Manager Functions
  • Scaling Group Functions
  • ComputeSession Functions
  • Session Template Functions
  • Virtual Folder Functions
• Low-level SDK Reference
  • Base Function
  • Request API
  • Exceptions
  • Type Definitions