registered-models 命令组

registered-models Databricks CLI 中的命令组包含用于管理 Unity 目录中模型注册表中的模型的命令。 已注册的模型提供跨 Databricks 工作区集中的访问控制、审核、世系和 ML 模型的发现。 请参阅在 Unity Catalog 中管理模型生命周期。

databricks 注册模型 创建

在 Unity 目录中创建新的已注册模型。

已注册模型中模型版本的文件存储将位于由父架构、父目录或元存储指定的默认位置。

若要成功创建已注册的模型，用户必须满足以下条件：

• 调用方必须是元存储管理员，或者是父目录和架构的所有者，或者具有 USE_CATALOG 父目录和 USE_SCHEMA 父架构的特权。
• 调用方必须在父架构上具有 CREATE MODEL 或 CREATE FUNCTION 特权。

databricks registered-models create CATALOG_NAME SCHEMA_NAME NAME [flags]

论据

CATALOG_NAME

    架构和已注册模型所在的目录的名称。

SCHEMA_NAME

    已注册模型所在的架构的名称。

NAME

    已注册模型的名称。

选项

--comment string

    附加到已注册模型的注释。

--json JSON

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

--storage-location string

    存储模型版本数据文件的云存储位置。

全局标志

例子

以下示例在指定的目录和架构中创建已注册的模型：

databricks registered-models create main my_schema my_model

以下示例使用注释创建已注册的模型：

databricks registered-models create main my_schema my_model --comment "My model description"

databricks registered-models delete (删除已注册的模型)

从指定的父目录和架构中删除已注册的模型及其所有模型版本。

调用方必须是元存储管理员或已注册模型的所有者。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

databricks registered-models delete FULL_NAME [flags]

论据

FULL_NAME

    已注册模型的三级（完全限定）名称。

选项

全局标志

例子

以下示例删除已注册的模型：

databricks registered-models delete main.my_schema.my_model

databricks 注册模型 删除别名

删除已注册的模型别名。

调用方必须是元存储管理员或已注册模型的所有者。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

databricks registered-models delete-alias FULL_NAME ALIAS [flags]

论据

FULL_NAME

    已注册模型的三级（完全限定）名称。

ALIAS

    别名的名称。

选项

全局标志

例子

以下示例删除已注册的模型别名：

databricks registered-models delete-alias main.my_schema.my_model production

数据砖注册模型获取

获取已注册的模型。

调用方必须是元存储管理员或已注册模型的所有者（或在该模型上具有 EXECUTE 权限）。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

databricks registered-models get FULL_NAME [flags]

论据

FULL_NAME

    已注册模型的三级（完全限定）名称。

选项

--include-aliases

    是否在响应中包含已注册的模型别名。

--include-browse

    是否在主体仅能访问选择性元数据的情况下，将已注册的模型包含在响应中。

全局标志

例子

以下示例获取有关已注册模型的信息：

databricks registered-models get main.my_schema.my_model

以下示例获取有关已注册模型的信息，包括别名：

databricks registered-models get main.my_schema.my_model --include-aliases

databricks registered-models 列表

列出已注册的模型。 可以在特定架构下列出已注册的模型，或列出当前元存储中的所有已注册模型。

返回的模型根据呼叫用户的权限进行筛选。 例如，元存储管理员能够列出所有已注册的模型。 常规用户必须是所有者，或者在注册模型上具有 EXECUTE 权限，才能在响应中获取已注册的模型。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

不能保证响应中元素的特定排序。

databricks registered-models list [flags]

选项

--catalog-name string

    用于列出已注册模型的目录标识符。

--include-browse

    是否在主体仅能访问选择性元数据的情况下，将已注册的模型包含在响应中。

--max-results int

    要返回的最大已注册模型数。

--page-token string

    用于发送下一页结果（分页）的不透明令牌。

--schema-name string

    用于列出已注册模型的架构标识符。

全局标志

例子

以下示例列出当前元存储中的所有已注册模型：

databricks registered-models list

以下示例列出了特定目录中已注册的模型：

databricks registered-models list --catalog-name main

以下示例列出了特定架构中的已注册模型：

databricks registered-models list --catalog-name main --schema-name my_schema

Databricks 注册模型设定别名

在指定的注册模型上设置别名。

调用方必须是元存储管理员或已注册模型的所有者。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

databricks registered-models set-alias FULL_NAME ALIAS VERSION_NUM [flags]

论据

FULL_NAME

    已注册模型的全名。

ALIAS

    别名的名称。

VERSION_NUM

    别名指向的模型版本的版本号。

选项

--json JSON

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

全局标志

例子

以下示例对已注册的模型设置别名：

databricks registered-models set-alias main.my_schema.my_model production 1

databricks registered-models 更新（用于更新已注册的模型）

更新指定的已注册模型。

调用方必须是元存储管理员或已注册模型的所有者。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

目前只能更新名称、已注册模型的所有者或注释。

databricks registered-models update FULL_NAME [flags]

论据

FULL_NAME

    已注册模型的三级（完全限定）名称。

选项

--comment string

    附加到已注册模型的注释。

--json JSON

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

''--new-name string'**

    已注册模型的新名称。

--owner string

    拥有已注册模型的用户的标识符。

全局标志

例子

以下示例更新已注册的模型的注释：

databricks registered-models update main.my_schema.my_model --comment "Updated model description"

以下示例更新已注册的模型名称：

databricks registered-models update main.my_schema.my_model --new-name my_new_model

全局标志

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

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