index.rst

Backend.AI Client SDK for Python

This is the documentation for the Python Client SDK which implements :doc:`the Backend.AI API <backendai:index>`.

Quickstart

Python 3.6 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 about :doc:`client configuration <gsg/config>`, the command-line examples, and :doc:`SDK code examples <dev/examples>`.

Getting Started

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   gsg/installation
   gsg/config

Command-line Interface

.. toctree::
   :maxdepth: 2
   :caption: CLI

   cli/config
   cli/sessions
   cli/apps
   cli/storage
   cli/code-execution
   cli/session-templates

Developer Reference

.. toctree::
   :maxdepth: 2
   :caption: Development

   dev/index
   func/index
   lowlevel/index

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`