APIClient
APIClient
类提供了一个 Python 风格的接口来访问 ClearML 的后端 REST API。它是一个方便的低级访问工具。
通过一个 APIClient
实例,你可以访问 ClearML 的 REST API 服务:
- authentication - 整个系统的认证管理、授权和管理
- debug - 调试工具
- 项目 - 支持定义包含任务、模型、数据集和/或管道的项目
- queues - 队列 管理 API
- workers - 用于工作机器报告状态和检索执行任务的API。
- events - 事件(例如指标、调试样本)报告和检索API
- models - 模型管理API
- tasks - 任务 管理 API
使用 APIClient
APIClient
将 ClearML 服务器的 REST API 端点作为 Python 方法提供。
要使用APIClient
,首先创建它的一个实例,然后调用与所需REST API端点对应的方法,并按照REST API参考页面中描述的相应参数进行操作。
例如,POST/ projects.get_all
调用返回您工作区中的所有项目。以下代码使用 APIClient 检索名称以“example”开头的所有项目列表。
from clearml.backend_api.session.client import APIClient
# Create an instance of APIClient
client = APIClient()
project_list = client.projects.get_all(name="example*")
print(project_list)