安装

Python

本安装说明假定用户本地已安装Python。

当前SDK对Python版本的支持为:python 64-bit >= 3.7

安装方式

SDK仍处于开发阶段,暂未开源发布至PyPi供用户通过公网安装。 目前SDK的安装方式有3种:

  1. 通过pip安装(推荐)

  2. 通过wheel包安装

  3. 通过源代码安装

通过pip安装(推荐)

pip install anylearn

如有需要,可以安装特定版本的SDK,例如:

pip install -U anylearn==10

通过wheel包安装

注解

用户需已获得Anylearn SDK的 内部GitHub仓库 的读权限。

前往GitHub仓库的 发布页面 , 下载wheel包(后缀 .whl 的文件,例如 anylearn-0.15.3-py3-none-any.whl )。

通过pip安装wheel包

pip install /path/to/anylearn-<version>-py3-none-any.whl

通过源代码安装

注解

用户需已获得Anylearn SDK的 内部GitHub仓库 的读权限。

克隆源代码:

git clone https://github.com/Dmagine/Anylearn-sdk.git

如有需要,切换到特定的版本(可选):

cd Anylearn-sdk
git checkout 0.15.3

如有需要,创建Python虚拟环境(推荐):

python3 -m venv venv
source venv/bin/activate

执行安装:

python3 setup.py clean --all
python3 setup.py install

验证安装

查看命令行工具版本:

anylearnctl --version

样例输出:

> anylearnctl, version 0.15.3

开发者

本地开发环境

克隆源代码:

git clone https://github.com/Dmagine/Anylearn-sdk.git

创建Python虚拟环境(推荐):

python3 -m venv venv
source venv/bin/activate

依赖项:

pip install -U pip
pip install -r requirements_dev.txt

测试

于SDK代码目录下执行:

pytest

构建文档

建议开发者为文档的编辑和构建使用一套独立的Python虚拟环境。

依赖项:

cd docs
pip3 install -r requirements

构建文档:

make clean
make html