后端连接配置

Anylearn SDK需搭配Anylearn后端引擎使用。

用户需提供后端连接的相关信息， 为SDK初始化后端连接， 获取后端API令牌， 以便调用后端需校验鉴权信息的接口。

同时，SDK会在用户本地初始化一个文件工作区， 用来做本地元信息存储和文件存储。

SDK提供了2种初始化的方式：

1. （推荐） 调用 init_sdk 接口

2. 调用 AnylearnConfig.init 类方法

class anylearn.config.AnylearnConfig

Anylearn SDK配置类， 包含Anylearn后端引擎的连接配置和SDK的本地存储配置。

cluster_address = None

Anylearn后端引擎集群网关地址

username = None

Anylearn后端引擎账户用户名

user_id = None

Anylearn后端引擎账户ID

password = None

Anylearn后端引擎账户密码

token = None

Anylearn后端引擎API令牌

workspace_path = PosixPath('/github/home/.anylearn')

SDK本地存储工作区路径

db_path = PosixPath('/github/home/.anylearn/anylearn.db')

SDK本地存储元信息数据库文件（ sqlite）路径

db_uri = 'sqlite://///github/home/.anylearn/anylearn.db'

SDK本地存储元信息数据库（ sqlite）的URI

classmethod init(cluster_address=None, username=None, password=None, token=None, workspace=None, disable_git=False)

初始化SDK与后端连接以及本地存储。 可通过用户名密码建立后端连接，也可直接传入有效的后端API令牌。

参数

• cluster_address (str, optional) – Anylearn后端引擎集群网关地址。

• username (str, optional) – Anylearn后端引擎账户用户名。

• password (str, optional) – Anylearn后端引擎账户密码。

• token (str, optional) – Anylearn后端引擎API令牌。

• workspace (str, optional) – SDK本地存储工作区路径， 默认将工作区建立在 <home>/.anylearn 目录下。

• disable_git (bool, optional) – 是否禁用基于本地git的算法同步， 默认为否。

classmethod init_cluster(cluster_address=None, username=None, password=None, token=None)

仅初始化SDK与后端连接。 可通过用户名密码建立后端连接，也可直接传入有效的后端API令牌。

参数

• cluster_address (str, optional) – Anylearn后端引擎集群网关地址。

• username (str, optional) – Anylearn后端引擎账户用户名。

• password (str, optional) – Anylearn后端引擎账户密码。

• token (str, optional) – Anylearn后端引擎API令牌。

classmethod cluster_login()

通过用户名密码建立SDK与后端连接， 获取后端API令牌。 在以用户名密码的方式初始化后方可调用。

classmethod init_workspace(workspace=None)

仅初始化SDK本地存储。

参数

workspace (str, optional) – SDK本地存储工作区路径， 默认将工作区建立在 <home>/.anylearn 目录下。

classmethod clear_workspace()

清空SDK本地存储。 本地元信息存储、临时文件、资源缓存等均会被删除。 请谨慎调用。

anylearn.config.init_sdk(cluster_address, username, password, disable_git=False)

初始化SDK与后端连接的接口。 调用本接口并传入后端地址、用户名和密码， SDK将自动以相应账户进行登录并获取后端API令牌。

参数

• cluster_address (str) – Anylearn后端引擎集群网关地址。

• username (str) – Anylearn后端引擎账户用户名。

• password (str) – Anylearn后端引擎账户密码。

anylearn.config.init_sdk_incontainer(cluster_address)

初始化无鉴权信息的SDK与后端连接的接口。 调用本接口仅需传入后端地址， 无需账户信息。 以此方式初始化的SDK将无法调用需要鉴权信息的接口， 仅可调用无需API令牌的公共接口。

此接口的使用场景多为任务执行容器内与后端建立通信， 不建议用户使用。

参数

cluster_address (str) – Anylearn后端引擎集群网关地址。