Backend.AI Client SDK for Python

This is the documentation for the Python Client SDK which implements the Backend.AI API.

Requirements

Python 3.5.3 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.

Getting Started

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 about client configuration, command-line examples, and code examples.

Table of contents

• Getting Started
  • Installation
  • Examples
  • Client Session
  • Client Configuration
• Command-line Interface
  • Examples
• High-level Function Reference
  • Admin Functions
  • Agent Functions
  • Kernel Functions
  • KeyPair Functions
  • Manager Functions
  • Virtual Folder Functions
• Low-level SDK Reference
  • Base Function
  • Request API
  • Exceptions

Indices and tables

• Index

• Module Index

• Search Page