环境变量
本页列出了可用于配置 ClearML 的环境变量。
除了下面列出的环境变量之外，ClearML 还支持 动态环境变量 来覆盖配置文件中出现的任何配置选项。更多信息请参见 动态环境变量。
信息
ClearML 的环境变量会覆盖 clearml.conf 文件、SDK 和 配置保管库，但可以被命令行参数覆盖。
ClearML SDK 变量
通用
| 名称 | 描述 |
|---|---|
| CLEARML_LOG_ENVIRONMENT | 环境变量名称列表。这些环境变量将记录在 ClearML 任务的配置超参数的 Environment 部分。当由 ClearML agent 执行时，这些值将被设置在任务的执行环境中。列表应按以下格式指定：CLEARML_LOG_ENVIRONMENT=VAR_1,VAR_2。 |
| CLEARML_TASK_NO_REUSE | 布尔值。 当设置为 1 时，每次执行都会创建一个新任务（参见任务重用）。 |
| CLEARML_CACHE_DIR | 设置 ClearML 缓存目录的路径，ClearML 在其中存储所有下载的内容。 |
| CLEARML_DOCKER_IMAGE | 设置在 Docker 模式下运行 agent 时使用的默认 docker 镜像。 |
| CLEARML_LOG_LEVEL | 设置 ClearML 包的日志详细程度。日志级别遵循 Python 日志级别：CRITICAL, ERROR, WARNING, INFO, DEBUG, NOTSET |
| CLEARML_SUPPRESS_UPDATE_MESSAGE | 布尔值。 当设置为 1 时，抑制新的 ClearML 包版本可用性消息。 |
| CLEARML_DEFAULT_OUTPUT_URI | 模型检查点（快照）和 artifact 的默认输出目标。 |
| CLEARML_SET_ITERATION_OFFSET | 设置已执行任务的初始迭代值。任务将从指定值 +1 开始报告其迭代。指定 0 会强制重置迭代计数。 |
VCS
覆盖仓库自动记录
| 名称 | 描述 |
|---|---|
| CLEARML_VCS_REPO_URL | 仓库 URL |
| CLEARML_VCS_COMMIT_ID | 仓库 Commit ID |
| CLEARML_VCS_BRANCH | 仓库分支 |
| CLEARML_VCS_ROOT | 仓库根目录 |
| CLEARML_VCS_WORK_DIR | 仓库工作目录 |
| CLEARML_VCS_STATUS | 仓库状态 |
| CLEARML_VCS_DIFF | Base64 编码字符串。包含记录到任务的仓库 diff。如果设置为空字符串，则不记录未提交的更改。注意：当远程执行任务时，覆盖 CLEARML_VCS_DIFF 可能会改变任务的结果。 |
| CLEARML_VCS_ENTRY_POINT | 入口点脚本 |
服务器连接
| 名称 | 描述 |
|---|---|
| CLEARML_API_HOST | 设置 API 服务器 URL |
| CLEARML_CONFIG_FILE | 设置 ClearML 配置文件。覆盖默认配置文件位置。 |
| CLEARML_WEB_HOST | 设置 Web UI 服务器 URL |
| CLEARML_FILES_HOST | 设置文件服务器 URL |
| CLEARML_API_ACCESS_KEY | 设置服务器的公共访问密钥 |
| CLEARML_API_SECRET_KEY | 设置服务器的私有访问密钥 |
| CLEARML_API_HOST_VERIFY_CERT | 启用 / 禁用服务器证书验证（如果位于防火墙后） |
| CLEARML_API_DEFAULT_REQ_METHOD | 实验性 - 此选项尚未经过严格测试。 设置所有 API 请求和认证登录的请求方法。当服务器阻止带有 payload 的 GET 请求时，这很有用，因此可以使用 POST/PUT 请求代替。 |
| CLEARML_OFFLINE_MODE | 设置离线模式 |
| CLEARML_NO_DEFAULT_SERVER | 当没有设置 HOST 服务器时，禁用向演示服务器发送信息 |
Agent 特定变量
参见此处查看有关如何配置 ClearML Agent 与 SDK 配合使用的环境变量。