.. _quickstart_example_downloading:

下载快速上手示例
================

SDK预置了一系列以Jupyter notebook编写的使用示例，
便于用户体验SDK的基本功能，
并快速上手SDK的使用方式。

本节介绍运行这些内置示例的方法。

克隆源代码：

.. Note::
    用户需已获得Anylearn SDK在实验室范围内公开的
    `GitHub仓库 <https://github.com/thulab/Anylearn-sdk/>`_
    的读权限。

.. code-block:: shell

    git clone https://github.com/thulab/Anylearn-sdk.git
    cd Anylearn-sdk

示例位于 ``./examples/jupyter`` 子目录中：

.. code-block:: shell

    cd examples/jupyter

如果本地未安装全局的Jupyter notebook，
建议于示例子目录中创建独立的Python虚拟环境，
安装Jupyter notebook及示例所需相关依赖：

.. code-block:: shell

    python3 -m venv venv
    source venv/bin/activate
    pip install anylearn matplotlib notebook numpy pandas scikit-learn scipy

启动Jupyter notebook：

.. code-block:: shell

    jupyter notebook

可以直接运行的预置示例文件如下：

+----------------------------------------+----------------------------------------------------+------------------------------------------+
| 示例场景                               | 示例文件                                           | 文档链接                                 |
+========================================+====================================================+==========================================+
| 使用本地算法和数据进行训练             | project_quick_training_local_resources.ipynb       | :ref:`quickstart_example_training`       |
+----------------------------------------+----------------------------------------------------+------------------------------------------+
| 使用本地模型进行推理                   | *comming soon*                                     | :ref:`quickstart_example_serving`        |
+----------------------------------------+----------------------------------------------------+------------------------------------------+