Compartilhar via


Grupo de comandos registered-models

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The registered-models command group within the Databricks CLI contains commands to manage models in the model registry in Unity Catalog. Os modelos registrados fornecem controle de acesso centralizado, auditoria, linhagem e descoberta de modelos de ML em workspaces do Databricks. Consulte Gerenciar o ciclo de vida do modelo no Catálogo Unity.

criação de modelos registrados do databricks

Crie um novo modelo registrado no Catálogo do Unity.

O armazenamento de arquivos para versões de modelo no modelo registrado estará localizado no local padrão especificado pelo esquema pai, pelo catálogo pai ou pelo Metastore.

Para que a criação do modelo registrado tenha êxito, o usuário deve atender às seguintes condições:

  • O chamador deve ser um administrador do metastore ou ser o proprietário do catálogo pai e do esquema ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.
  • O chamador deve ter o privilégio ou CREATE FUNCTION o CREATE MODEL privilégio no esquema pai.
databricks registered-models create CATALOG_NAME SCHEMA_NAME NAME [flags]

Arguments

CATALOG_NAME

    O nome do catálogo em que o esquema e o modelo registrado residem.

SCHEMA_NAME

    O nome do esquema no qual o modelo registrado reside.

NAME

    O nome do modelo registrado.

Opções

--comment string

    O comentário anexado ao modelo registrado.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path arquivo JSON com o corpo da solicitação.

--storage-___location string

    O local de armazenamento na nuvem na qual os arquivos de dados de versão do modelo são armazenados.

Global flags

Examples

O exemplo a seguir cria um modelo registrado no catálogo e no esquema especificados:

databricks registered-models create main my_schema my_model

O exemplo a seguir cria um modelo registrado com um comentário:

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

databricks registered-models delete

Exclua um modelo registrado e todas as suas versões de modelo do catálogo e esquema pai especificados.

O chamador deve ser um administrador metastore ou um proprietário do modelo registrado. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

databricks registered-models delete FULL_NAME [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do modelo registrado.

Opções

Global flags

Examples

O exemplo a seguir exclui um modelo registrado:

databricks registered-models delete main.my_schema.my_model

databricks registered-models delete-alias

Exclua um alias de modelo registrado.

O chamador deve ser um administrador metastore ou um proprietário do modelo registrado. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

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

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do modelo registrado.

ALIAS

    O nome do alias.

Opções

Global flags

Examples

O exemplo a seguir exclui um alias de modelo registrado:

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

databricks registered-models get

Obtenha um modelo registrado.

O chamador deve ser um administrador metastore ou um proprietário (ou ter o EXECUTE privilégio) no modelo registrado. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

databricks registered-models get FULL_NAME [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do modelo registrado.

Opções

--include-aliases

    Se deve incluir aliases de modelo registrados na resposta.

--include-browse

    Se deve incluir modelos registrados na resposta para a qual a entidade de segurança só pode acessar metadados seletivos.

Global flags

Examples

O exemplo a seguir obtém informações sobre um modelo registrado:

databricks registered-models get main.my_schema.my_model

O exemplo a seguir obtém informações sobre um modelo registrado, incluindo aliases:

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

lista de modelos registrados do databricks

Listar modelos registrados. Você pode listar modelos registrados em um esquema específico ou listar todos os modelos registrados no metastore atual.

Os modelos retornados são filtrados com base nos privilégios do usuário de chamada. Por exemplo, o administrador do metastore pode listar todos os modelos registrados. Um usuário regular precisa ser o proprietário ou ter o EXECUTE privilégio no modelo registrado para receber os modelos registrados na resposta. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

Não há garantia de uma ordenação específica dos elementos na resposta.

databricks registered-models list [flags]

Opções

--catalog-name string

    O identificador do catálogo no qual listar modelos registrados.

--include-browse

    Se deve incluir modelos registrados na resposta para a qual a entidade de segurança só pode acessar metadados seletivos.

--max-results int

    Número máximo de modelos registrados a serem retornados.

--page-token string

    Token opaco a ser enviado para a próxima página de resultados (paginação).

--schema-name string

    O identificador do esquema no qual listar modelos registrados.

Global flags

Examples

O exemplo a seguir lista todos os modelos registrados no metastore atual:

databricks registered-models list

O exemplo a seguir lista modelos registrados em um catálogo específico:

databricks registered-models list --catalog-name main

O exemplo a seguir lista modelos registrados em um esquema específico:

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

databricks registered-models set-alias

Defina um alias no modelo registrado especificado.

O chamador deve ser um administrador metastore ou um proprietário do modelo registrado. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

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

Arguments

FULL_NAME

    Nome completo do modelo registrado.

ALIAS

    O nome do alias.

VERSION_NUM

    O número de versão da versão do modelo para a qual o alias aponta.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path arquivo JSON com o corpo da solicitação.

Global flags

Examples

O exemplo a seguir define um alias em um modelo registrado:

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

atualização de modelos registrados do databricks

Atualize o modelo registrado especificado.

O chamador deve ser um administrador metastore ou um proprietário do modelo registrado. Para o último caso, o chamador também deve ser o proprietário ou ter o USE_CATALOG privilégio no catálogo pai e o USE_SCHEMA privilégio no esquema pai.

Atualmente, somente o nome, o proprietário ou o comentário do modelo registrado podem ser atualizados.

databricks registered-models update FULL_NAME [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do modelo registrado.

Opções

--comment string

    O comentário anexado ao modelo registrado.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path arquivo JSON com o corpo da solicitação.

``--new-name string`**

    Novo nome para o modelo registrado.

--owner string

    O identificador do usuário que possui o modelo registrado.

Global flags

Examples

O exemplo a seguir atualiza o comentário de um modelo registrado:

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

O exemplo a seguir atualiza o nome de um modelo registrado:

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

Global flags

--debug

  Se deseja habilitar o registro em log de depuração.

-h ou --help

    Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.

--log-file corda

    Uma cadeia de caracteres que representa o arquivo para o qual gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log ou textjson. O valor padrão é text.

--log-level corda

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.

-o, --output tipo

    O tipo de saída de comando ou textjson. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo a ~/.databrickscfg ser usado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.

--progress-format formato

    O formato para exibir logs de progresso: default, , appendou inplacejson

-t, --target corda

    Se aplicável, o destino do pacote a ser usado