experiments 命令组

The experiments command group within the Databricks CLI allows you to create, edit, delete, and manage experiments in MLflow. 请参阅使用 MLflow 试验组织训练运行。

databricks 试验 create-experiment

创建具有名称的试验。 返回新创建的试验的 ID。 验证同名的另一个试验尚不存在，如果存在同名的另一个试验，则失败。

如果存在具有给定名称的试验，则 RESOURCE_ALREADY_EXISTS 引发。

databricks experiments create-experiment NAME [flags]

Arguments

NAME

    Experiment name.

选项

--artifact-location string

    存储试验的所有项目的位置。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验 create-run

在试验中创建新的运行。 运行通常是机器学习或数据 ETL 管道的单个执行。 MLflow 使用运行来跟踪与单个执行关联的 mlflowParam、mlflowMetric 和 mlflowRunTag。

databricks experiments create-run [flags]

Arguments

None

选项

--experiment-id string

    关联的试验的 ID。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件

--run-name string

    运行的名称。

--start-time int

    启动运行时的 Unix 时间戳（以毫秒为单位）。

--user-id string

    执行运行的用户的 ID。

Global flags

databricks 试验 delete-experiment

标记试验和关联的元数据、运行、指标、参数和标记以供删除。 如果试验使用 FileStore，也会删除与试验关联的项目。

databricks experiments delete-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    关联的试验的 ID。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件

Global flags

databricks 试验 delete-run

标记要删除的运行。

databricks experiments delete-run RUN_ID [flags]

Arguments

RUN_ID

    要删除的运行 ID。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件

Global flags

databricks 试验 delete-runs

批量删除在指定时间戳之前或之前创建的试验中运行。 删除每个请求最多max_runs。 若要从 Python 中的 Databricks Notebook 调用此 API，可以在 上使用客户端代码片段

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    包含要删除的运行的试验的 ID。

MAX_TIMESTAMP_MILLIS

    自 UNIX 删除运行以来的最大创建时间戳（以毫秒为单位）。 仅删除在此时间戳或之前创建的运行。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件

--max-runs int

    一个可选的正整数，指示要删除的最大运行数。

Global flags

databricks 试验 delete-tag

在运行时删除标记。 标记是可在运行期间和运行完成后更新的运行元数据。

databricks experiments delete-tag RUN_ID KEY [flags]

Arguments

RUN_ID

    记录标记的运行 ID。 Required.

KEY

    标记的名称。 最大大小为 255 字节。 Required.

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件

Global flags

databricks 试验按名称获取

获取具有指定名称的试验的元数据。

此命令将返回已删除的试验，但如果活动试验和已删除的试验共享相同的名称，则首选活动试验。 如果多个已删除的试验具有相同的名称，API 将返回其中一个。

如果不存在具有指定名称的试验，则 RESOURCE_DOES_NOT_EXIST 引发。

databricks experiments get-by-name EXPERIMENT_NAME [flags]

Arguments

EXPERIMENT_NAME

    关联的试验的名称。

选项

Global flags

databricks 试验 get-experiment

获取具有指定 ID 的试验的元数据。 此命令适用于已删除的试验。

databricks experiments get-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    关联的试验的 ID。

选项

Global flags

databricks 试验 get-history

获取给定运行的指定指标的所有值的列表。

databricks experiments get-history METRIC_KEY [flags]

Arguments

METRIC_KEY

    指标的名称。

选项

--max-results int

    每个分页请求返回的最大指标记录数。

--page-token string

    指示要提取的指标历史记录页的令牌。

--run-id string

    要从中提取指标值的运行 ID。

--run-uuid string

    已弃用，请改用 --run_id 。 要从中提取指标值的运行 ID。

Global flags

databricks 试验 get-run

获取运行的元数据、指标、参数和标记。 如果为运行记录了具有相同密钥的多个指标，则仅返回具有最新时间戳的值。

如果有多个具有最新时间戳的值，则返回这些值的最大值。

databricks experiments get-run RUN_ID [flags]

Arguments

RUN_ID

    要提取的运行 ID。 必须提供。

选项

--run-uuid string

    已弃用，请改用 --run_id 。 要提取的运行 ID。

Global flags

databricks 试验列表项目

列出运行的项目。 采用可选的artifact_path前缀（如果指定），响应仅包含具有指定前缀的项目。 对于 Unity 目录卷，最多检索 1000 个项目。 使用 databricks fs ls 列出 Unity 目录卷中的项目，该卷支持分页。

databricks experiments list-artifacts [flags]

Arguments

None

选项

--page-token string

    指示要提取的项目结果页的标记。

--path string

    筛选匹配此路径的项目（根项目目录中的相对路径）。

--run-id string

    要列出其项目的运行 ID。

--run-uuid string

    已弃用，请改用 --run_id 。 要列出其项目的运行 ID。

Global flags

databricks 试验列表-试验

获取所有试验的列表。

databricks experiments list-experiments [flags]

Arguments

None

选项

--max-results int

    所需的最大试验数。

--page-token string

    指示要提取的试验页的标记。

--view-type ViewType

    要返回的试验类型的限定符。 支持的值：ACTIVE_ONLY、ALL、DELETED_ONLY

Global flags

databricks 试验日志批处理

记录一批运行的指标、参数和标记。 如果任何数据未能持久保存，服务器将响应错误（非 200 状态代码）。 For overwrite behavior and request limits, see Experiments.

databricks experiments log-batch [flags]

Arguments

None

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--run-id string

    要登录的运行 ID。

Global flags

databricks 试验日志输入

将输入（如数据集和模型）记录到 MLflow 运行。

databricks experiments log-inputs RUN_ID [flags]

Arguments

RUN_ID

    要登录的运行 ID

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验日志指标

记录运行的指标。 指标是具有关联时间戳的键值对（字符串键、浮点值）。 示例包括表示 ML 模型准确性的各种指标。 可以多次记录指标。

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

Arguments

KEY

    指标的名称。

VALUE

    要记录的指标的双精度值。

TIMESTAMP

    记录指标时 Unix 时间戳（以毫秒为单位）。

选项

--dataset-digest string

    与指标关联的数据集的数据集摘要，例如

--dataset-name string

    与指标关联的数据集的名称。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--model-id string

    与指标关联的已记录模型的 ID（如果适用）。

--run-id string

    要记录指标的运行 ID。

--run-uuid string

    已弃用，请改用 --run_id 。 要记录指标的运行 ID。

--step int

    记录指标的步骤。

Global flags

databricks 试验日志模型

记录模型。

databricks experiments log-model [flags]

Arguments

None

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--model-json string

    JSON 格式的 MLmodel 文件。

--run-id string

    要登录的运行 ID。

Global flags

databricks 试验日志参数

记录用于运行的参数。 参数是键值对（字符串键、字符串值）。 示例包括用于 ML 模型训练的超参数以及 ETL 管道中使用的常量日期和值。 只能为运行记录一次参数。

databricks experiments log-param KEY VALUE [flags]

Arguments

KEY

    参数的名称。 最大大小为 255 字节。

VALUE

    要记录的参数的字符串值。 最大大小为 500 字节。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--run-id string

    要记录参数的运行 ID。

--run-uuid string

    [已弃用，请改用run_id]要记录参数的运行 ID。

Global flags

databricks 试验 restore-experiment

还原标记为要删除的试验。 这还会还原关联的元数据、运行、指标、参数和标记。 如果试验使用 FileStore，则还会还原与试验关联的基础项目。

RESOURCE_DOES_NOT_EXIST如果从未创建试验或永久删除试验，则引发。

databricks experiments restore-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    关联的试验的 ID。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验还原-运行

还原已删除的运行。 这还会还原关联的元数据、运行、指标、参数和标记。

RESOURCE_DOES_NOT_EXIST如果从未创建或永久删除运行，则会引发。

databricks experiments restore-run RUN_ID [flags]

Arguments

RUN_ID

    要还原的运行 ID。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验还原运行

批量还原在未早于指定时间戳删除的试验中运行。 每个请求最多 max_runs 还原一次。

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    包含要还原的运行的试验的 ID。

MIN_TIMESTAMP_MILLIS

    还原运行的 UNIX 纪元以来的最低删除时间戳（以毫秒为单位）。 仅还原未早于此时间戳删除的运行。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--max-runs int

    一个可选的正整数，指示要还原的最大运行数。

Global flags

databricks 试验搜索试验

搜索满足指定搜索条件的试验。

databricks experiments search-experiments [flags]

Arguments

None

选项

--filter string

    表示 SQL 筛选器条件的字符串

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--max-results int

    所需的最大试验数。

--page-token string

    指示要提取的试验页的标记。

--view-type ViewType

    要返回的试验类型的限定符。 支持的值：ACTIVE_ONLY、ALL、DELETED_ONLY

Global flags

databricks 试验搜索运行

搜索满足表达式的运行。 搜索表达式可以使用 mlflowMetric 和 mlflowParam 键。

databricks experiments search-runs [flags]

Arguments

None

选项

--filter string

    一个基于参数、指标和标记的筛选器表达式，该表达式允许返回一部分运行。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--max-results int

    所需的最大运行数。

--page-token string

    运行当前页的令牌。

--run-view-type ViewType

    是仅显示活动、仅已删除还是所有运行。 支持的值：ACTIVE_ONLY、ALL、DELETED_ONLY

Global flags

databricks 试验 set-experiment-tag

设置试验上的标记。 试验标记是可以更新的元数据。

databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]

Arguments

EXPERIMENT_ID

    要记录标记的试验的 ID。 必须提供。

KEY

    标记的名称。 支持最大大小为 250 字节的键。

VALUE

    要记录的标记的字符串值。 支持最大大小为 64KB 的值。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验集标记

在运行时设置标记。 标记是可在运行期间和运行完成后更新的运行元数据。

databricks experiments set-tag KEY VALUE [flags]

Arguments

KEY

    标记的名称。 支持最大大小为 250 字节的键。

VALUE

    要记录的标记的字符串值。 支持最大大小为 64KB 的值。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--run-id string

    要记录标记的运行 ID。

--run-uuid string

    已弃用，请改用 --run_id 。 要记录标记的运行 ID。

Global flags

databricks 试验 update-experiment

更新试验。

databricks experiments update-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    关联的试验的 ID。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--new-name string

    如果提供，试验的名称将更改为新名称。

Global flags

databricks 试验更新-运行

更新运行。

databricks experiments update-run [flags]

Arguments

None

选项

--end-time int

    运行结束时的 Unix 时间戳（以毫秒为单位）。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--run-id string

    要更新的运行 ID。

--run-name string

    更新了运行的名称。

--run-uuid string

    已弃用，请改用 --run_id 。 要更新的运行 ID。

--status UpdateRunStatus

    已更新运行状态。 支持的值：FAILED、、FINISHED、KILLEDRUNNING、SCHEDULED

Global flags

databricks 试验 get-permission-levels

获取试验权限级别。

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    要为其获取或管理权限的试验。

选项

Global flags

databricks 试验获取权限

获取试验的权限。 试验可以从其根对象继承权限。

databricks experiments get-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    要为其获取或管理权限的试验。

选项

Global flags

databricks 试验集权限

设置试验权限。

设置对象的权限，替换现有权限（如果存在）。 如果未指定任何权限，则删除所有直接权限。 对象可以从其根对象继承权限。

databricks experiments set-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    要为其获取或管理权限的试验。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

databricks 试验更新权限

更新试验权限。 试验可以从其根对象继承权限。

databricks experiments update-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    要为其获取或管理权限的试验。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

Global flags

Global flags

--debug

  是否启用调试日志记录。

-h 或 --help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串，表示要将输出日志写入到的文件。 如果未指定此标志，则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型或 textjson。 默认值是 text。

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定，则禁用日志格式级别。

-o, --output 类型

    命令输出类型或 textjson。 默认值是 text。

-p, --profile 字符串

    用于运行命令的文件中配置文件 ~/.databrickscfg 的名称。 如果未指定此标志，则如果存在，则使用命名 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标