.. Anylearn SDK documentation master file, created by
   sphinx-quickstart on Wed Dec 16 11:42:56 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

############
Anylearn SDK
############

概述
====

Anylearn SDK是Anylearn后端引擎上游的Python开发工具集，具有易用、便捷、灵活的特点：

- **易用** ：通过pip即可安装，可通过少量编程或命令行的方式调用SDK封装的功能。
- **便捷** ：特色功能的接口友好，用户仅需少量调用即可使用一种功能。
- **灵活** ：用户可以灵活配置需要连接的Anylearn后端引擎以及SDK本地存储的接入方式。

核心功能
========

SDK旨在通过轻量编程的方式，
使用户可以方便快速地接入Anylearn，
使用后端引擎的模型训练、模型验证、模型在线服务、资源管理等功能，
实现机器学习全生命周期管理。

利用Anylearn后端引擎的强大能力，
SDK还为用户提供了多种特色功能，
通过便捷的接口调用即可使用。
目前SDk的特色功能包括：

- `自定义算法/模型的训练和验证 <api/applications.quickstart.html>`__
- `训练跟踪 <api/applications.tracking.html>`__
- `超参数自动调优 <api/applications.hpo.html>`__

除此之外，SDK还为用户提供了命令行接口（CLI），
可以通过执行命令的方式调用SDK中的部分功能。
目前仅限于本地快速开始和超参数自动调优，
今后会持续增加其他功能的命令。

下图展示了当前Anylearn SDK与Anylearn后端引擎的应用架构。

.. Note::
    灰色部分为已实现的功能，
    绿色部分为开发中的功能，
    蓝色部分为设计规划中的功能。

.. figure:: _static/img/overview-arch-sdk-back.png
    :width: 720px
    :align: center
    :height: 750px
    :alt: Anylearn Arch SDK-Backend
    :figclass: align-center

    Anylearn SDK与后端引擎应用架构

文档目录
========

..  toctree::
    :maxdepth: 2
    :titlesonly:

    快速上手 <quickstart>
    API参考 <api>
    CLI命令行工具 <cli>
    工业场景应用示例 <examples>
    开发者进阶参考 <apiplus>
    常见问题 <faq>
    更新日志 <changelog>

更多
----
* :ref:`genindex`