Skip to main content

第一步

安装 ClearML​

首先，免费注册。

安装 clearml python 包：

pip install clearml

连接 ClearML SDK 到服务器​

本地 Python​

  1. 执行以下命令以运行ClearML设置向导：

    clearml-init
    note

    向导不会编辑或覆盖现有的配置文件，因此如果clearml.conf文件已经存在，上述命令将无法工作。

    可以创建额外的ClearML配置文件，例如，在执行任务时在Docker容器内使用。

    使用--file选项进行clearml-init。

    clearml-init --file MyOtherClearML.conf

    然后在容器内使用CLEARML_CONFIG_FILE环境变量指定它：

    CLEARML_CONFIG_FILE = MyOtherClearML.conf

    有关在Docker容器内运行实验的更多信息，请参阅ClearML Agent Deployment 和ClearML Agent Reference。

  2. 设置向导会提示输入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:

  3. 获取ClearML凭证。在浏览器中打开ClearML Web UI。在设置 > 工作区页面，点击创建新凭证。

    LOCAL PYTHON 选项卡显示设置向导所需的数据（悬停时可进行复制到剪贴板的操作）。

  4. 在命令提示符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，您需要为您的笔记本配置ClearML服务器的访问凭据。

  1. 获取ClearML凭据。在浏览器中打开ClearML Web UI。在设置 > 工作区页面，点击创建新凭据。JUPYTER NOTEBOOK标签页显示了配置笔记本所需的命令（悬停时可复制到剪贴板）。
  2. 将这些命令添加到您的笔记本中

现在你可以在你的笔记本中使用ClearML了！

自动记录实验​

在ClearML中，实验被组织为任务。

ClearML 会自动记录您的实验和代码，包括来自流行机器学习框架的输出和参数，一旦您将 ClearML SDK 集成到您的代码中。要控制 ClearML 自动记录的内容，请参阅此 FAQ。

在代码的开头，导入clearml包：

from clearml import Task
Full Automatic Logging

为了确保完全自动记录，建议在入口脚本的顶部导入clearml包。

然后在你的main()函数或脚本的开头初始化Task对象。

task = Task.init(project_name='great project', task_name='best experiment')

如果项目尚不存在，则会自动创建一个新项目。

控制台应显示以下输出：

ClearML Task: created new task id=1ca59ef1f86d44bd81cb517d529d9e5a
2021-07-25 13:59:09
ClearML results page: https://app.clear.ml/projects/4043a1657f374e9298649c6ba72ad233/experiments/1ca59ef1f86d44bd81cb517d529d9e5a/output/log
2021-07-25 13:59:16

就是这样！ 你已经完成了将ClearML与你的代码集成 :)

现在，命令行参数、控制台输出以及Tensorboard和Matplotlib将自动记录在UI中创建的任务下。

坐下来，放松一下，看着你的模型收敛 :) 或者继续看看ClearML还能做些什么 这里。

YouTube 播放列表​

或者观看ClearML YouTube频道上的入门播放列表！

观看视频