跳到主内容

ClearML Python 包

这是安装 clearml Python 包并将其连接到 ClearML 服务器的分步指南。完成后，您可以将 clearml 集成到您的代码中。

安装 ClearML

首先，免费注册。

安装 clearml Python 包

pip install clearml

将 ClearML SDK 连接到服务器

本地 Python

执行以下命令运行 ClearML 设置向导
```
clearml-init
```
注意
向导不会编辑或覆盖现有配置文件，因此如果 clearml.conf 文件已存在，上述命令将无法工作。
可以创建额外的 ClearML 配置文件，例如在执行任务时在 Docker 容器内部使用。
对 clearml-init 使用 --file 选项。
clearml-init --file MyOtherClearML.conf
然后在容器内部使用 CLEARML_CONFIG_FILE 环境变量指定它
CLEARML_CONFIG_FILE = MyOtherClearML.conf
有关在 Docker 容器内部运行任务的更多信息，请参阅 ClearML Agent 部署和 ClearML Agent 参考。

设置向导会提示输入 ClearML 凭据。

Please create new clearml credentials through the settings page in your `clearml-server` web app (e.g. http://localhost:8080//settings/workspace-configuration), 
or create a free account at https://app.clear.ml/settings/workspace-configuration

In the settings page, press "Create new credentials", then press "Copy to clipboard".

Paste copied configuration here:

获取 ClearML 凭据。在浏览器中打开 ClearML Web UI。在 设置 > 工作区 页面上，单击 创建新凭据。

本地 Python 选项卡显示设置向导所需的数据（鼠标悬停时可复制到剪贴板）。

在命令提示符 Paste copied configuration here: 处，粘贴 ClearML 凭据。设置向导会验证凭据。

Detected credentials key="********************" secret="*******"

CLEARML Hosts configuration:
Web App: https://app.<your-domain>
API: https://api.<your-domain>
File Store: https://files.<your-domain>
         
Verifying credentials ...
Credentials verified!
 
New configuration stored in /home/<username>/clearml.conf
CLEARML setup completed successfully.

现在您可以将 ClearML 集成到您的代码中！请继续此处。

Jupyter Notebook

要在 Jupyter Notebook 中使用 ClearML，您需要为您的 Notebook 配置 ClearML 服务器访问凭据。

获取 ClearML 凭据。在浏览器中打开 ClearML Web UI。在 设置 > 工作区 页面上，单击 创建新凭据。JUPYTER NOTEBOOK 选项卡显示配置您的 Notebook 所需的命令（鼠标悬停时可复制到剪贴板）
将这些命令添加到您的 Notebook

现在您可以在 Notebook 中使用 ClearML 了！

安装 ClearML
将 ClearML SDK 连接到服务器
- 本地 Python
- Jupyter Notebook