Metadata-Version: 1.2
Name: backend.ai
Version: 1.0.2
Summary: Lablup Backend.AI Meta-package
Home-page: https://github.com/lablup/backend.ai
Author: Lablup Inc.
Author-email: devops@lablup.com
License: LGPLv3
Description-Content-Type: UNKNOWN
Description: Backend.AI
        ==========
        
        Backend.AI is a streamlined backend service framework hosting heterogeneous
        programming languages and popular AI frameworks.
        It manages the underlying computing resources for multi-tenant computation
        sessions where such sessions are spawned and executed instantly on demand.
        
        All sub-projects are licensed under LGPLv3+.
        
        By installing this meta-package, you get the client with command-line interface
        by default and optionally you may add the manager and agent using pip extra
        tags.
        
        .. code-block:: console
        
           $ pip install backend.ai
           (installs the common and client libs which includes CLI)
           $ pip install backend.ai[manager]
           (installs the common and client libs with the manager/gateway daemon)
           $ pip install backend.ai[agent]
           (installs the common and client libs with the agent daemon)
        
        
        Server-side Components
        ----------------------
        
        Manager with API Gateway
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        It routes external API requests from front-end services to individual agents.
        It also monitors and scales the cluster of multiple agents (a few tens to hundreds).
        
        * Package namespace: ``ai.backend.gateway`` and ``ai.backend.manager``
        * https://github.com/lablup/backend.ai-manager
        
        Agent
        ~~~~~
        
        It manages individual server instances and launches/destroys Docker containers where REPL daemons (kernels) run.
        Each agent on a new EC2 instance self-registers itself to the instance registry via heartbeats.
        
        * Package namespace: ``ai.backend.agent``
        * https://github.com/lablup/backend.ai-agent
        
        Kernels
        ~~~~~~~
        
        A set of small ZeroMQ-based REPL daemons in various programming languages and configurations.
        
        * https://github.com/lablup/backend.ai-kernels
        * Each daemon is a separate program, usually named "run.{lang-specific-extension}".
        
        Jail
        ~~~~
        
        A programmable sandbox implemented using ptrace-based sytem call filtering written in Go.
        
        * https://github.com/lablup/backend.ai-jail
        
        Hook
        ~~~~
        
        A set of libc overrides for resource control and web-based interactive stdin (paired with agents).
        
        * https://github.com/lablup/backend.ai-hook
        
        Commons
        ~~~~~~~
        
        A collection of utility modules commonly shared throughout Backend.AI projects.
        
        * Package namespaces: ``ai.backend.common``
        * https://github.com/lablup/backend.ai-common
        
        
        Client-side Components
        ----------------------
        
        Client Libraries
        ~~~~~~~~~~~~~~~~
        
        A client library to access the Backend.AI API servers with ease.
        
        * Python
           * ``pip install backend.ai-client``
           * https://github.com/lablup/backend.ai-client-py
        * Javascript (under preparation)
           * ``npm install backend.ai-client``
           * https://github.com/lablup/backend.ai-client-js
        * PHP (under preparation)
           * ``composer require lablup/backend.ai-client``
           * https://github.com/lablup/backend.ai-client-php
        
        Media
        ~~~~~
        
        The front-end support libraries to handle multi-media outputs (e.g., SVG plots, animated vector graphics)
        
        * The Python package (``lablup``) is installed *inside* kernel containers.
        * To interpret and display media generated by the Python package, you need to load the Javascript part in the front-end.
        * https://github.com/lablup/backend.ai-media
        
        
        Integrations with IDEs and Editors
        ----------------------------------
        
        Jupyter Kernel
        ~~~~~~~~~~~~~~
        
        Jupyter kernel integration of the Backend.AI Cloud API.
        
        * Package namespaces: ``backend.ai-integration``
        * https://github.com/lablup/backend.ai-integration-jupyter
        
        Visual Studio Code Extension
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Extension for Visual Studio Code to run your code on the Lablup.AI clouds or your own Backend.AI servers.
        
        * Search 'live code runner' to VSCode extension search.
        * https://github.com/lablup/vscode-live-code-runner
        
        Atom Editor plugin
        ~~~~~~~~~~~~~~~~~~
        
        Atom Editor Plugin that allows running your code on the Lablup.AI clouds or your own Backend.AI servers.
        
        * Search 'live code runner' to Atom plugin search.
        * https://github.com/lablup/atom-live-code-runner
        
        
        Installation
        ------------
        
        The Backend.AI project uses latest features in Python 3.6+ and Docker CE 17.05+.
        
        To install the manager with API gateway, run:
        
        .. code-block:: sh
        
           pip install backend.ai[manager]
        
        For each computing servers, install the agent using:
        
        .. code-block:: sh
        
           pip install backend.ai[agent]
        
        
        NOTE: More details about configuration will be released soon.
        
        
        Development
        -----------
        
        git flow
        ~~~~~~~~
        
        The Backend.AI repositories use `git flow <http://danielkummer.github.io/git-flow-cheatsheet/index.html>`_ to streamline branching during development and deployment.
        We use the default configuration (master -> preparation for release, develop -> main development, feature/ -> features, etc.) as-is.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.6
