model-registry 命令组

The model-registry command group within the Databricks CLI allows you to manage the full lifecycle of MLflow Models. 工作区模型注册表是一个集中式模型存储库和一组 UI 和一组 API，可用于管理 MLflow 模型的完整生命周期。

databricks model-registry approve-transition-request

批准模型版本阶段转换请求。

databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

STAGE

    转换的目标阶段。 支持的值： Archived、 None、、 Production、 Staging

ARCHIVE_EXISTING_VERSIONS

    指定是否存档目标阶段中的所有当前模型版本。

选项

--comment string

    用户提供的对作的注释。

--json JSON

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

Global flags

databricks model-registry create-comment

在模型版本上发布注释。 用户可以提交注释，也可以以编程方式提交注释以显示有关模型的相关信息。 例如，测试结果或部署错误。

databricks model-registry create-comment NAME VERSION COMMENT [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

COMMENT

    用户提供的对作的注释。

选项

--json JSON

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

Global flags

databricks model-registry create-model

使用请求正文中指定的名称创建新的已注册模型。

如果存在具有给定名称的已注册模型，则会引发RESOURCE_ALREADY_EXISTS。

databricks model-registry create-model NAME [flags]

Arguments

NAME

    在此名称下注册模型

选项

--description string

    已注册模型的可选说明。

--json JSON

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

Global flags

databricks model-registry create-model-version

创建模型版本。

databricks model-registry create-model-version NAME SOURCE [flags]

Arguments

NAME

    在此名称下注册模型

SOURCE

    指示模型项目位置的 URI。

选项

--description string

    模型版本的可选说明。

--json JSON

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

--run-id string

    如果源是由 MLflow 跟踪服务器中的试验生成的，则为关联 MLflow 运行 ID。

--run-link string

    MLflow 运行链接 - 这是生成此模型版本的运行的确切链接，可能托管在另一个 MLflow 实例上。

Global flags

databricks model-registry create-transition-request

创建模型版本阶段转换请求。

databricks model-registry create-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

STAGE

    转换的目标阶段。 有效值为：

• 无：模型版本的初始阶段。
• 过渡：过渡或预生产阶段。
• 生产：生产阶段。
• 已存档：存档阶段。

支持的值：[存档、无、生产、暂存]

选项

--comment string

    用户提供的对作的注释。

--json JSON

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

Global flags

databricks model-registry create-webhook

创建注册表 Webhook。

databricks model-registry create-webhook [flags]

Arguments

None

选项

--description string

    Webhook 的用户指定说明。

--json JSON

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

--model-name string

    其事件将触发此 Webhook 的模型的名称。

--status RegistryWebhookStatus

    启用或禁用触发 Webhook，或将 Webhook 置于测试模式。 支持的值：[ACTIVE、DISABLED、TEST_MODE]

Global flags

databricks model-registry delete-comment

删除对模型版本的注释。

databricks model-registry delete-comment ID [flags]

Arguments

ID

    要删除的注释的唯一标识符。

选项

Global flags

databricks model-registry delete-model

删除已注册的模型。

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    已注册的模型唯一名称标识符。

选项

Global flags

databricks model-registry delete-model-tag

删除已注册模型的标记。

databricks model-registry delete-model-tag NAME KEY [flags]

Arguments

NAME

    标记所记录的已注册模型的名称。

KEY

    标记的名称。 名称必须完全匹配;不支持通配符删除。 最大大小为 250 字节。

选项

Global flags

databricks model-registry delete-model-version

删除模型版本。

databricks model-registry delete-model-version NAME VERSION [flags]

Arguments

NAME

    已注册模型的名称

VERSION

    型号版本号

选项

Global flags

databricks model-registry delete-model-version-tag

删除模型版本标记。

databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]

Arguments

NAME

    标记所记录的已注册模型的名称。

VERSION

    标记记录到的型号版本号。

KEY

    标记的名称。 名称必须完全匹配;不支持通配符删除。 最大大小为 250 字节。

选项

Global flags

databricks model-registry delete-transition-request

取消模型版本阶段转换请求。

databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

STAGE

    转换请求的目标阶段。 有效值为：

• 无：模型版本的初始阶段。
• 过渡：过渡或预生产阶段。
• 生产：生产阶段。
• 已存档：存档阶段。

支持的值：[存档、无、生产、暂存]

CREATOR

    创建此请求的用户的用户名。 在与指定详细信息匹配的转换请求中，只会删除此用户创建的一个转换。

选项

--comment string

    用户提供的对作的注释。

Global flags

databricks model-registry delete-webhook

删除注册表 Webhook。

databricks model-registry delete-webhook [flags]

Arguments

None

选项

--id string

    删除注册表 Webhook 所需的 Webhook ID。

Global flags

databricks model-registry get-latest-versions

获取已注册模型的最新版本。

databricks model-registry get-latest-versions NAME [flags]

Arguments

NAME

    已注册的模型唯一名称标识符。

选项

--json JSON

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

Global flags

databricks model-registry get-model

获取模型的详细信息。 This is a Databricks workspace version of the MLflow endpoint that also returns the model's Databricks workspace ID and the permission level of the requesting user on the model.

databricks model-registry get-model NAME [flags]

Arguments

NAME

    已注册的模型唯一名称标识符。

选项

Global flags

databricks model-registry get-model-version

获取模型版本。

databricks model-registry get-model-version NAME VERSION [flags]

Arguments

NAME

    已注册模型的名称

VERSION

    型号版本号

选项

Global flags

databricks model-registry get-model-version-download-uri

获取用于下载模型版本的 URI。

databricks model-registry get-model-version-download-uri NAME VERSION [flags]

Arguments

NAME

    已注册模型的名称

VERSION

    型号版本号

选项

Global flags

databricks model-registry list-models

List all available registered models, up to the limit specified in max_results.

databricks model-registry list-models [flags]

Arguments

None

选项

--max-results int

    所需的已注册模型的最大数量。

--page-token string

    根据上一个查询转到下一页的分页令牌。

Global flags

databricks model-registry list-transition-requests

获取模型版本的所有开放阶段转换请求的列表。

databricks model-registry list-transition-requests NAME VERSION [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

选项

Global flags

databricks model-registry list-webhooks

列出所有注册表 Webhook。

databricks model-registry list-webhooks [flags]

Arguments

None

选项

--model-name string

    如果未指定，则列出与指定事件关联的所有 Webhook，而不考虑其关联的模型。

--page-token string

    指示要提取的项目结果页的令牌。

Global flags

databricks model-registry reject-transition-request

拒绝模型版本阶段转换请求。

databricks model-registry reject-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

STAGE

    转换的目标阶段。 有效值为：

• 无：模型版本的初始阶段。
• 过渡：过渡或预生产阶段。
• 生产：生产阶段。
• 已存档：存档阶段。

支持的值：[存档、无、生产、暂存]

选项

--comment string

    用户提供的对作的注释。

--json JSON

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

Global flags

databricks model-registry rename-model

重命名已注册的模型。

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    已注册的模型唯一名称标识符。

选项

--json JSON

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

--new-name string

    如果提供，请更新此registered_model的名称。

Global flags

databricks model-registry search-model-versions

Searche for specific model versions based on the supplied filter.

databricks model-registry search-model-versions [flags]

Arguments

None

选项

--filter string

    字符串筛选器条件，如“name='my-model-name'”。

--max-results int

    所需的最大模型数。

--page-token string

    根据以前的搜索查询转到下一页的分页令牌。

Global flags

databricks model-registry search-models

Search for registered models based on the specified filter.

databricks model-registry search-models [flags]

Arguments

None

选项

--filter string

    字符串筛选器条件，如“name LIKE 'my-model-name'”。

--max-results int

    所需的最大模型数。

--page-token string

    基于上一个搜索查询转到下一页的分页令牌。

Global flags

databricks model-registry set-model-tag

在已注册的模型上设置标记。

databricks model-registry set-model-tag NAME KEY VALUE [flags]

Arguments

NAME

    模型的唯一名称。

KEY

    标记的名称。 最大大小取决于存储后端。 如果已存在具有此名称的标记，则其预先存在的值将替换为指定的值。 保证所有存储后端支持最大大小为 250 字节的键值。

VALUE

    要记录的标记的字符串值。 最大大小取决于存储后端。 保证所有存储后端支持最大大小为 5000 字节的键值。

选项

--json JSON

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

Global flags

databricks model-registry set-model-version-tag

设置模型版本标记。

databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]

Arguments

NAME

    模型的唯一名称。

VERSION

    型号版本号。

KEY

    标记的名称。 最大大小取决于存储后端。 如果已存在具有此名称的标记，则其预先存在的值将替换为指定的值。 保证所有存储后端支持最大大小为 250 字节的键值。

VALUE

    要记录的标记的字符串值。 最大大小取决于存储后端。 保证所有存储后端支持最大大小为 5000 字节的键值。

选项

--json JSON

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

Global flags

databricks model-registry test-registry-webhook

测试注册表 Webhook。

databricks model-registry test-registry-webhook ID [flags]

Arguments

ID

    Webhook ID

选项

--event RegistryWebhookEvent

    如果指定了事件，测试触发器将使用指定的事件。 支持的值：[ COMMENT_CREATED、MODEL_VERSION_CREATED、MODEL_VERSION_TAG_SET、MODEL_VERSION_TRANSITIONED_STAGE、MODEL_VERSION_TRANSITIONED_TO_ARCHIVED、MODEL_VERSION_TRANSITIONED_TO_PRODUCTION、MODEL_VERSION_TRANSITIONED_TO_STAGING、REGISTERED_MODEL_CREATED、TRANSITION_REQUEST_CREATED、TRANSITION_REQUEST_TO_ARCHIVED_CREATED、TRANSITION_REQUEST_TO_PRODUCTION_CREATED、TRANSITION_REQUEST_TO_STAGING_CREATED]

--json JSON

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

Global flags

databricks model-registry transition-stage

转换模型版本的阶段。 This is a Databricks workspace version of the MLflow endpoint that also accepts a comment associated with the transition to be recorded.

databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    模型的名称。

VERSION

    模型的版本。

STAGE

    转换的目标阶段。 有效值为：

• 无：模型版本的初始阶段。
• 过渡：过渡或预生产阶段。
• 生产：生产阶段。
• 已存档：存档阶段。

支持的值：[存档、无、生产、暂存]

ARCHIVE_EXISTING_VERSIONS

    指定是否存档目标阶段中的所有当前模型版本。

选项

--comment string

    用户提供的对作的注释。

--json JSON

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

Global flags

databricks model-registry update-comment

发布对模型版本的注释的编辑。

databricks model-registry update-comment ID COMMENT [flags]

Arguments

ID

    活动的唯一标识符

COMMENT

    用户提供的对作的注释。

选项

--json JSON

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

Global flags

databricks model-registry update-model

更新已注册的模型。

databricks model-registry update-model NAME [flags]

Arguments

NAME

    已注册的模型唯一名称标识符。

选项

--description string

    如果提供，请更新此registered_model的说明。

--json JSON

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

Global flags

databricks model-registry update-model-version

更新模型版本。

databricks model-registry update-model-version NAME VERSION [flags]

Arguments

NAME

    已注册模型的名称

VERSION

    型号版本号

选项

--description string

    如果提供，请更新此registered_model的说明。

--json JSON

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

Global flags

databricks model-registry update-webhook

更新注册表 Webhook。

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Webhook ID

选项

--description string

    Webhook 的用户指定说明。

--json JSON

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

--status RegistryWebhookStatus

    启用或禁用触发 Webhook，或将 Webhook 置于测试模式。 支持的值：[ACTIVE、DISABLED、TEST_MODE]

Global flags

databricks model-registry get-permission-levels

获取已注册的模型权限级别。

databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    要为其获取或管理权限的已注册模型。

选项

Global flags

databricks model-registry get-permissions

获取已注册模型的权限。 已注册的模型可以从其根对象继承权限。

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    要为其获取或管理权限的已注册模型。

选项

Global flags

databricks model-registry set-permissions

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

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    要为其获取或管理权限的已注册模型。

选项

--json JSON

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

Global flags

databricks model-registry update-permissions

更新已注册模型的权限。 已注册的模型可以从其根对象继承权限。

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_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 字符串

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