注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
注释
这是有关工作区模型注册表 API 的参考文档。 Databricks 建议改 用 Unity 目录中的模型 。 Unity Catalog 中的模型集模型治理、跨工作区访问、数据世系和部署于一体。 工作区模型注册表将在未来弃用。
model-registry
CLI 中的命令组允许管理 MLflow 模型的完整生命周期。 工作区模型注册表是一个集中式模型存储库和一组 UI 和一组 API,可用于管理 MLflow 模型的完整生命周期。
databricks model-registry 批准转换请求
批准模型版本阶段转换请求。
databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
STAGE
转换的目标阶段。 支持的值:Archived
、None
、Production
、Staging
ARCHIVE_EXISTING_VERSIONS
指定是否存档目标阶段中的所有当前模型版本。
选项
--comment string
用户提供的关于操作的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks 模型寄存注册创建评论 (model-registry create-comment)
在模型版本上发表评论。 用户可以提交注释,也可以以编程方式提交注释以显示有关模型的相关信息。 例如,测试结果或部署错误。
databricks model-registry create-comment NAME VERSION COMMENT [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
COMMENT
用户提供的关于操作的注释。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks model-registry create-model
使用请求正文中指定的名称创建新的已注册模型。
如果存在具有给定名称的已注册模型,则会引发RESOURCE_ALREADY_EXISTS。
databricks model-registry create-model NAME [flags]
论据
NAME
在此名称下注册模型
选项
--description string
已注册模型的可选说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
Databricks model-registry 创建模型版本
创建模型版本。
databricks model-registry create-model-version NAME SOURCE [flags]
论据
NAME
在该名称下注册模型
SOURCE
指示模型项目位置的 URI。
选项
--description string
模型版本的可选说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--run-id string
用于关联的 MLflow 运行 ID,如果源是由 MLflow 跟踪服务器中的试验生成的。
--run-link string
MLflow 运行链接 - 这是生成此模型版本的运行的确切链接,可能托管在另一个 MLflow 实例上。
Databricks 模型注册表创建转换请求
创建模型版本阶段转换请求。
databricks model-registry create-transition-request NAME VERSION STAGE [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
STAGE
转换的目标阶段。 有效值为:
- 无:模型版本的初始阶段。
- 过渡:过渡或预生产阶段。
- 生产:生产阶段。
- 已存档:存档阶段。
支持的值:[存档、无、生产、暂存]
选项
--comment string
用户提供的关于操作的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks model-registry create-webhook
注释
此命令目前是公共预览版。
创建注册表 Webhook。
databricks model-registry create-webhook [flags]
论据
没有
选项
--description string
Webhook 的用户指定说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--model-name string
其事件将触发此 Webhook 的模型的名称。
--status RegistryWebhookStatus
启用或禁用触发 Webhook,或将 Webhook 置于测试模式。 支持的值:[启用状态;禁用状态;测试模式]
databricks model-registry 删除评论
删除对模型版本的注释。
databricks model-registry delete-comment ID [flags]
论据
ID
要删除的注释的唯一标识符。
选项
databricks 模型注册表 删除模型
删除已注册的模型。
databricks model-registry delete-model NAME [flags]
论据
NAME
已注册的模型唯一名称标识符。
选项
databricks 模型注册中心 删除模型标签
删除已注册模型的标签。
databricks model-registry delete-model-tag NAME KEY [flags]
论据
NAME
标记被记录到的已注册模型的名称。
KEY
标记的名称。 名称必须完全匹配, 不支持使用通配符进行删除操作。 最大大小为 250 字节。
选项
databricks model-registry delete-model-version
删除模型版本。
databricks model-registry delete-model-version NAME VERSION [flags]
论据
NAME
已注册模型的名称
VERSION
型号版本号
选项
Databricks 模型注册表 删除模型版本标签
删除模型版本标记。
databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]
论据
NAME
标记被记录到的已注册模型的名称。
VERSION
标签登录时的模型版本号。
KEY
标记的名称。 名称必须完全匹配, 不支持使用通配符进行删除操作。 最大大小为 250 字节。
选项
Databricks 模型注册表删除转换请求
取消模型版本阶段转换请求。
databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
STAGE
过渡请求的目标阶段。 有效值为:
- 无:模型版本的初始阶段。
- 过渡:过渡或预生产阶段。
- 生产:生产阶段。
- 已存档:存档阶段。
支持的值:[存档、无、生产、暂存]
CREATOR
创建此请求的用户的用户名。 在与指定详细信息匹配的转换请求中,只会删除此用户创建的一个转换。
选项
--comment string
用户提供的关于操作的注释。
databricks 模型注册表 删除网络钩子
注释
此命令目前是公共预览版。
删除注册表的 Webhook。
databricks model-registry delete-webhook [flags]
论据
没有
选项
--id string
删除注册表网络钩子所需的网络钩子 ID。
databricks 模型注册表 获取最新版本
获取已注册模型的最新版本。
databricks model-registry get-latest-versions NAME [flags]
论据
NAME
已注册的模型唯一名称标识符。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks 模型注册表 获取模型
获取模型的详细信息。 这是 MLflow 终结点 的 Databricks 工作区版本,它还返回模型的 Databricks 工作区 ID 和请求用户对模型的权限级别。
databricks model-registry get-model NAME [flags]
论据
NAME
已注册的模型唯一名称标识符。
选项
databricks model-registry get-model-version(获取模型版本命令)
获取模型版本。
databricks model-registry get-model-version NAME VERSION [flags]
论据
NAME
已注册模型的名称
VERSION
型号版本号
选项
databricks model-registry 获取模型版本下载URI
获取用于下载模型版本的 URI。
databricks model-registry get-model-version-download-uri NAME VERSION [flags]
论据
NAME
已注册模型的名称
VERSION
型号版本号
选项
databricks 模型注册表 列出模型
列出所有可用的已注册模型,数量不超过max_results中指定的限制。
databricks model-registry list-models [flags]
论据
没有
选项
--max-results int
所需的已注册模型的最大数量。
--page-token string
用于根据上一个查询跳转到下一页的分页令牌。
databricks 模型注册表 列表过渡请求
获取模型版本的所有开放阶段转换请求的列表。
databricks model-registry list-transition-requests NAME VERSION [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
选项
Databricks 模型注册表 `list-webhooks`
注释
此命令目前是公共预览版。
列出所有注册表 Webhook。
databricks model-registry list-webhooks [flags]
论据
没有
选项
--model-name string
如果未指定,则列出与指定事件关联的所有 Webhook,不论其关联的模型。
--page-token string
指示要提取的项目结果页的令牌。
Databricks 模型注册表拒绝迁移请求 (databricks model-registry reject-transition-request)
拒绝模型版本阶段转换请求。
databricks model-registry reject-transition-request NAME VERSION STAGE [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
STAGE
转换的目标阶段。 有效值为:
- 无:模型版本的初始阶段。
- 过渡:过渡或预生产阶段。
- 生产:生产阶段。
- 已存档:存档阶段。
支持的值:[存档、无、生产、暂存]
选项
--comment string
用户提供的关于操作的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks model-registry rename-model
重命名已注册的模型。
databricks model-registry rename-model NAME [flags]
论据
NAME
已注册的模型唯一名称标识符。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--new-name string
如果提供,请更新此registered_model的名称。
databricks 模型注册表 搜索模型版本
根据提供的 筛选器搜索特定模型版本。
databricks model-registry search-model-versions [flags]
论据
没有
选项
--filter string
字符串过滤条件,如“name='my-model-name'”。
--max-results int
所需的最大模型数。
--page-token string
用于根据以前的搜索查询跳转到下一页的分页令牌。
为Databricks模型注册表搜索模型
根据指定的 筛选器搜索已注册的模型。
databricks model-registry search-models [flags]
论据
没有
选项
--filter string
字符串筛选条件,如“name LIKE 'my-model-name'”。
--max-results int
所需的最大模型数。
--page-token string
基于上一个搜索查询转到下一页的分页令牌。
Databricks 模型注册表设置模型标签
在已注册的模型上设置标记。
databricks model-registry set-model-tag NAME KEY VALUE [flags]
论据
NAME
模型的唯一名称。
KEY
标记的名称。 最大大小取决于存储后端。 如果已存在具有此名称的标记,则其预先存在的值将替换为指定的值。 保证所有存储后端支持最大大小为 250 字节的键值。
VALUE
要记录的标签的字符串值。 最大大小取决于存储后端。 保证所有存储后端支持最大大小为 5000 字节的键值。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
操作 "databricks model-registry set-model-version-tag" 在 Databricks 中设置模型版本标签
设置模型版本标记。
databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]
论据
NAME
模型的唯一名称。
VERSION
型号版本号。
KEY
标记的名称。 最大大小取决于存储后端。 如果已存在具有此名称的标记,则其预先存在的值将替换为指定的值。 保证所有存储后端支持最大大小为 250 字节的键值。
VALUE
要记录的标签的字符串值。 最大大小取决于存储后端。 保证所有存储后端支持最大大小为 5000 字节的键值。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks model-registry 测试注册钩子
注释
此命令目前是公共预览版。
测试注册表 Webhook。
databricks model-registry test-registry-webhook ID [flags]
论据
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 字符串或包含请求正文的 JSON 文件中的 @path。
databricks 模型注册表过渡阶段
过渡模型版本的阶段。 这是 MLflow 终结点 的 Databricks 工作区版本,还接受与要记录的转换关联的注释。
databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
论据
NAME
模型的名称。
VERSION
模型的版本。
STAGE
转换的目标阶段。 有效值为:
- 无:模型版本的初始阶段。
- 过渡:过渡或预生产阶段。
- 生产:生产阶段。
- 已存档:存档阶段。
支持的值:[存档、无、生产、暂存]
ARCHIVE_EXISTING_VERSIONS
指定是否存档目标阶段中的所有当前模型版本。
选项
--comment string
用户提供的关于操作的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks 模型注册表更新评论
发布对模型版本的注释的编辑。
databricks model-registry update-comment ID COMMENT [flags]
论据
ID
活动的唯一标识符
COMMENT
用户提供的关于操作的注释。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
Databricks 模型注册表 更新模型
更新已注册的模型。
databricks model-registry update-model NAME [flags]
论据
NAME
已注册的模型唯一名称标识符。
选项
--description string
如果已提供,则更新此已注册模型的说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks 模型注册表更新模型版本
更新模型版本。
databricks model-registry update-model-version NAME VERSION [flags]
论据
NAME
已注册模型的名称
VERSION
型号版本号
选项
--description string
如果已提供,则更新此已注册模型的说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
Databricks 模型注册表 更新 Webhook
注释
此命令目前是公共预览版。
更新注册表 Webhook。
databricks model-registry update-webhook ID [flags]
论据
ID
Webhook ID
选项
--description string
Webhook 的用户指定说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--status RegistryWebhookStatus
启用或禁用触发 Webhook,或将 Webhook 置于测试模式。 支持的值:[启用状态;禁用状态;测试模式]
databricks 模型注册表 获取权限级别
获取已注册的模型权限级别。
databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]
论据
REGISTERED_MODEL_ID
要为其获取或管理权限的已注册模型。
选项
databricks model-registry get-permissions
获取已注册模型的权限。 已注册的模型可以从其根对象继承权限。
databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]
论据
REGISTERED_MODEL_ID
要为其获取或管理权限的已注册模型。
选项
databricks 模型注册表 设置权限
设置已注册的模型权限,替换现有权限(如果存在)。 如果未指定任何权限,则删除所有直接权限。 对象可以从其根对象继承权限。
databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]
论据
REGISTERED_MODEL_ID
要为其获取或管理权限的已注册模型。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
databricks model-registry 更新权限
更新已注册模型的权限。 已注册的模型可以从其根对象继承权限。
databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]
论据
REGISTERED_MODEL_ID
要为其获取或管理权限的已注册模型。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
全局标志
--debug
是否启用调试日志记录。
-h
或 --help
显示 Databricks CLI、相关命令组或相关命令的帮助。
--log-file
字符串
一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。
--log-format
格式
日志格式类型,text
或 json
。 默认值是 text
。
--log-level
字符串
一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。
-o, --output
类型
命令输出类型为 text
或 json
。 默认值是 text
。
-p, --profile
字符串
要用于运行命令的 ~/.databrickscfg
文件中的配置文件名称。 如果未指定此标志,并且存在命名为 DEFAULT
的配置文件,则使用该配置文件。
--progress-format
格式
显示进度日志的格式: default
、 append
、 inplace
或 json
-t, --target
字符串
如果适用,要使用的捆绑包目标