client-py.docs.backend.ai Open in urlscan Pro
2606:4700::6811:2152  Public Scan

Form analysis
2 forms found in the DOM

GET search.html

<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  <input type="text" name="q" placeholder="Search docs">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

GET //readthedocs.org/projects/backendai-client-sdk-for-python/search/

<form id="flyout-search-form" class="wy-form" target="_blank" action="//readthedocs.org/projects/backendai-client-sdk-for-python/search/" method="get">
  <input type="text" name="q" aria-label="Search docs" placeholder="Search docs">
</form>

Text Content

Backend.AI Client SDK for Python
latest


Getting Started

 * Installation
 * Client Configuration

CLI

 * Configuration
 * Compute Sessions
 * Container Applications
 * Storage Management
 * Advanced Code Execution
 * Session Templates

Development

 * Developer Guides
 * High-level Function Reference
 * Low-level SDK Reference

Digital Ocean: Create your world-changing apps on the cloud developers love Try
now with a $100 Credit
Ad by EthicalAds   ·   Monetize your site
Backend.AI Client SDK for Python
 * Docs »
 * Backend.AI Client SDK for Python
 * Edit on GitHub

--------------------------------------------------------------------------------


BACKEND.AI CLIENT SDK FOR PYTHON¶

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


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


GETTING STARTED¶

Getting Started

 * Installation
   * Linux/macOS
   * Windows
   * Verification
 * Client Configuration


COMMAND-LINE INTERFACE¶

CLI

 * Configuration
   * Session Mode
   * API Mode
   * Checking out the current configuration
 * Compute Sessions
   * Listing sessions
   * Running simple sessions
   * Running sessions with accelerators
   * Terminating or cancelling sessions
 * Container Applications
   * Starting a session and connecting to its Jupyter Notebook
   * Accessing sessions via a web terminal
   * Accessing sessions via native SSH/SFTP
 * Storage Management
   * Creating vfolders and managing them
   * File transfers and management
   * Running sessions with storages
   * Creating default files for kernels
 * Advanced Code Execution
   * Running concurrent experiment sessions
 * Session Templates
   * Creating and starting session template
   * Full syntax for task template


DEVELOPER REFERENCE¶

Development

 * 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
   * Miscellaneous Utilities


INDICES AND TABLES¶

 * Index

 * Module Index

 * Search Page

Next

--------------------------------------------------------------------------------

© Copyright 2019, Lablup Inc. Revision 9293e488.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Languages en ko Versionen latest 20.09 20.03 19.09 19.03 docs/20.03 Downloads
PDF HTML Epub On Read the Docs Project Home Erstellungsprozesse Downloads On
GitHub Ansehen Bearbeiten Suche


--------------------------------------------------------------------------------

Hosted by Read the Docs · Privacy Policy