Compartilhar via


Grupo de comandos model-registry

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

Note

Esta API faz referência a APIs de documentos para o Registro de Modelo do Workspace. Em vez disso, o Databricks recomenda usar modelos no Catálogo do Unity . Os modelos no Catálogo do Unity fornecem governança de modelo centralizada, acesso entre workspaces, linhagem e implantação. O Registro de Modelo de Workspace será preterido no futuro.

O model-registry grupo de comandos dentro da CLI do Databricks permite que você gerencie todo o ciclo de vida dos Modelos de MLflow. O Registro de Modelo de Workspace é um repositório de modelo centralizado e uma interface do usuário e um conjunto de APIs que permitem gerenciar o ciclo de vida completo dos Modelos de MLflow.

databricks model-registry approve-transition-request

Aprovar uma solicitação de transição de estágio de versão do modelo.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Estágio final da transição. Valores com suporte: Archived, None, Production, Staging

ARCHIVE_EXISTING_VERSIONS

    Especifica se todas as versões do modelo atual devem ser arquivadas no estágio de destino.

Opções

--comment string

    Comentário fornecido pelo usuário sobre a ação.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry criar-comentário

Poste um comentário em uma versão do modelo. Um comentário pode ser enviado por um usuário ou programaticamente para exibir informações relevantes sobre o modelo. Por exemplo, resultados de teste ou erros de implantação.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

COMMENT

    Comentário fornecido pelo usuário sobre a ação.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry criar-modelo

Crie um novo modelo registrado com o nome especificado no corpo da solicitação.

Gerará RESOURCE_ALREADY_EXISTS se houver um modelo registrado com o nome fornecido.

databricks model-registry create-model NAME [flags]

Arguments

NAME

    Registrar modelos com esse nome

Opções

--description string

    Descrição opcional para o modelo registrado.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry create-model-version

Criar uma versão do modelo.

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

Arguments

NAME

    Registrar modelo com esse nome

SOURCE

    URI que indica o local dos artefatos do modelo.

Opções

--description string

    Descrição opcional para a versão do modelo.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--run-id string

    ID de execução do MLflow para correlação, se a origem foi gerada por um experimento realizado no servidor de monitoramento do MLflow.

--run-link string

    Link de execução do MLflow – esse é o link exato da execução que gerou essa versão do modelo, potencialmente hospedada em outra instância do MLflow.

Sinalizadores globais

databricks model-registry create-transition-request

Crie uma solicitação de transição de estágio de versão do modelo.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Estágio final da transição. Os valores válidos são:

  • Nenhum: o estágio inicial de uma versão do modelo.
  • Preparo: preparo ou estágio de pré-produção.
  • Produção: estágio de produção.
  • Arquivado: estágio arquivado.

Valores com suporte: [Arquivado, Nenhum, Produção, Preparo]

Opções

--comment string

    Comentário fornecido pelo usuário sobre a ação.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry create-webhook

Note

Esse comando está na Visualização Pública.

Criar um webhook de registro.

databricks model-registry create-webhook [flags]

Arguments

None

Opções

--description string

    Descrição especificada pelo usuário para o webhook.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--model-name string

    Nome do modelo cujos eventos disparariam esse webhook.

--status RegistryWebhookStatus

    Habilite ou desabilite o gatilho do webhook ou coloque o webhook no modo de teste. Valores com suporte: [ATIVO, DESATIVADO, MODO_DE_TESTE]

Sinalizadores globais

Comentário de exclusão do registro de modelo do Databricks

Exclua um comentário em uma versão do modelo.

databricks model-registry delete-comment ID [flags]

Arguments

ID

    Identificador exclusivo do comentário a ser excluído.

Opções

Sinalizadores globais

Comando 'delete-model' do 'databricks model-registry'

Exclua um modelo registrado.

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

Sinalizadores globais

databricks model-registry delete-model-tag

Exclua a marcação de um modelo registrado.

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

Arguments

NAME

    Nome do modelo registrado em que a tag foi registrada.

KEY

    Nome da marcação. O nome deve ser uma correspondência exata; não há suporte para exclusão de caracteres curinga. O tamanho máximo é de 250 bytes.

Opções

Sinalizadores globais

registro-de-modelo databricks excluir-versão-do-modelo

Excluir uma versão do modelo.

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

Arguments

NAME

    Nome do modelo registrado

VERSION

    Número da versão do modelo

Opções

Sinalizadores globais

databricks model-registry delete-model-version-tag

Excluir uma tag de versão do modelo.

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

Arguments

NAME

    Nome do modelo registrado em que a tag foi registrada.

VERSION

    Número de versão do modelo em que o tag foi registrado.

KEY

    Nome da marcação. O nome deve ser uma correspondência exata; não há suporte para exclusão de caracteres curinga. O tamanho máximo é de 250 bytes.

Opções

Sinalizadores globais

data-registro de modelos do databricks solicitação de exclusão de transição

Cancelar uma solicitação de mudança de estágio da versão do modelo.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Estágio de destino da solicitação de transição. Os valores válidos são:

  • Nenhum: o estágio inicial de uma versão do modelo.
  • Preparo: preparo ou estágio de pré-produção.
  • Produção: estágio de produção.
  • Arquivado: estágio arquivado.

Valores com suporte: [Arquivado, Nenhum, Produção, Preparo]

CREATOR

    Nome de usuário do usuário que criou essa solicitação. Das solicitações de transição que correspondem aos detalhes especificados, somente uma transição criada por esse usuário será excluída.

Opções

--comment string

    Comentário fornecido pelo usuário sobre a ação.

Sinalizadores globais

databricks registro-de-modelo deletar-webhook

Note

Esse comando está na Visualização Pública.

Exclui um webhook do registro.

databricks model-registry delete-webhook [flags]

Arguments

None

Opções

--id string

    ID do webhook necessário para excluir um webhook do registro.

Sinalizadores globais

Como usar o comando databricks model-registry get-latest-versions para obter as versões mais recentes.

Obtenha a versão mais recente de um modelo registrado.

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

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry get-model

Obtenha os detalhes de um modelo. Esta é uma versão do endpoint do MLflow no workspace do Databricks que também retorna a ID do workspace do modelo no Databricks e o nível de permissão do usuário solicitante no modelo.

databricks model-registry get-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

Sinalizadores globais

databricks model-registry get-model-version

Obtenha uma versão do modelo.

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

Arguments

NAME

    Nome do modelo registrado

VERSION

    Número da versão do modelo

Opções

Sinalizadores globais

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

Obtenha um URI para baixar a versão do modelo.

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

Arguments

NAME

    Nome do modelo registrado

VERSION

    Número da versão do modelo

Opções

Sinalizadores globais

modelos do databricks model-registry list-models

Liste todos os modelos registrados disponíveis até o limite especificado em max_results.

databricks model-registry list-models [flags]

Arguments

None

Opções

--max-results int

    Número máximo de modelos registrados desejados.

--page-token string

    Token de paginação para ir para a próxima página com base em uma consulta anterior.

Sinalizadores globais

databricks model-registry list-transition-requests

Obtenha uma lista de todas as solicitações abertas de transição de estágio para a versão do modelo.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

Opções

Sinalizadores globais

databricks model-registry list-webhooks

Note

Esse comando está na Visualização Pública.

listar todos os webhooks do registro.

databricks model-registry list-webhooks [flags]

Arguments

None

Opções

--model-name string

    Se não for especificado, todos os webhooks associados aos eventos especificados serão listados, independentemente de seu modelo associado.

--page-token string

    Token que indica a página de resultados do artefato a ser buscada.

Sinalizadores globais

databricks model-registry rejeitar-solicitação-de-transição

Rejeitar uma solicitação de transição de estágio de versão do modelo.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Estágio final da transição. Os valores válidos são:

  • Nenhum: o estágio inicial de uma versão do modelo.
  • Preparo: preparo ou estágio de pré-produção.
  • Produção: estágio de produção.
  • Arquivado: estágio arquivado.

Valores com suporte: [Arquivado, Nenhum, Produção, Preparo]

Opções

--comment string

    Comentário fornecido pelo usuário sobre a ação.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry rename-model

Renomeie um modelo registrado.

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--new-name string

    Se fornecido, atualiza o nome deste registered_model.

Sinalizadores globais

databricks model-registry busca-versões-de-modelo

Pesquise versões de modelo específicas com base no filtro fornecido.

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

Arguments

None

Opções

--filter string

    Condição de filtro de cadeia de caracteres, como "name='my-model-name'".

--max-results int

    Número máximo de modelos desejados.

--page-token string

    Token de paginação para ir para a próxima página com base na consulta anterior.

Sinalizadores globais

pesquisar modelos no registro de modelos do Databricks

Pesquise modelos registrados com base no filtro especificado.

databricks model-registry search-models [flags]

Arguments

None

Opções

--filter string

    Condição de filtro de cadeia de caracteres, como "name LIKE 'my-model-name'".

--max-results int

    Número máximo de modelos desejados.

--page-token string

    Token de paginação para ir para a próxima página com base em uma consulta de pesquisa anterior.

Sinalizadores globais

databricks model-registry set-model-tag

Defina uma etiqueta em um modelo registrado.

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

Arguments

NAME

    Nome exclusivo do modelo.

KEY

    Nome da marcação. O tamanho máximo depende do back-end de armazenamento. Se uma marca com esse nome já existir, seu valor pré-existente será substituído pelo valor especificado. Todos os back-ends de armazenamento são garantidos para dar suporte a valores de chave de até 250 bytes de tamanho.

VALUE

    Valor da string da marcação que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os back-ends de armazenamento são garantidos para dar suporte a valores de chave de até 5.000 bytes de tamanho.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry set-model-version-tag (Define uma tag para a versão do modelo no registro de modelos do Databricks)

Defina uma etiqueta de versão do modelo.

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

Arguments

NAME

    Nome exclusivo do modelo.

VERSION

    Número da versão do modelo.

KEY

    Nome da marcação. O tamanho máximo depende do back-end de armazenamento. Se uma marca com esse nome já existir, seu valor pré-existente será substituído pelo valor especificado. Todos os back-ends de armazenamento são garantidos para dar suporte a valores de chave de até 250 bytes de tamanho.

VALUE

    Valor da string da marcação que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os back-ends de armazenamento são garantidos para dar suporte a valores de chave de até 5.000 bytes de tamanho.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry test-registry-webhook

Note

Esse comando está na Visualização Pública.

Teste um webhook do registro.

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

Arguments

ID

    Webhook ID

Opções

--event RegistryWebhookEvent

    Se o evento for especificado, o gatilho de teste usará o evento especificado. Valores com suporte: [ 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

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry fase de transição

Faça a transição de estágio de uma versão de modelo. Esta é uma versão do workspace do Databricks para o endpoint do MLflow que também aceita um comentário associado à transição para ser registrada.

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Estágio final da transição. Os valores válidos são:

  • Nenhum: o estágio inicial de uma versão do modelo.
  • Preparo: preparo ou estágio de pré-produção.
  • Produção: estágio de produção.
  • Arquivado: estágio arquivado.

Valores com suporte: [Arquivado, Nenhum, Produção, Preparo]

ARCHIVE_EXISTING_VERSIONS

    Especifica se todas as versões do modelo atual devem ser arquivadas no estágio de destino.

Opções

--comment string

    Comentário fornecido pelo usuário sobre a ação.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

Atualizar comentário do registro de modelo do Databricks

Publique uma edição de um comentário sobre uma versão do modelo.

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

Arguments

ID

    Identificador exclusivo de uma atividade

COMMENT

    Comentário fornecido pelo usuário sobre a ação.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry update-model

Atualize um modelo registrado.

databricks model-registry update-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

--description string

    Se fornecido, atualiza a descrição deste registered_model.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry update-model-version

Atualize a versão do modelo.

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

Arguments

NAME

    Nome do modelo registrado

VERSION

    Número da versão do modelo

Opções

--description string

    Se fornecido, atualiza a descrição deste registered_model.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks model-registry update-webhook

Note

Esse comando está na Visualização Pública.

Atualize um webhook de registro.

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Webhook ID

Opções

--description string

    Descrição especificada pelo usuário para o webhook.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--status RegistryWebhookStatus

    Habilite ou desabilite o gatilho do webhook ou coloque o webhook no modo de teste. Valores com suporte: [ATIVO, DESATIVADO, MODO_DE_TESTE]

Sinalizadores globais

databricks model-registry get-permission-levels

Obtenha níveis de permissão do modelo registrado.

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

Arguments

REGISTERED_MODEL_ID

    O modelo registrado para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

permissões de obtenção de model-registry do databricks

Obtém as permissões de um modelo registrado. Os modelos registrados podem herdar permissões de seu objeto raiz.

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    O modelo registrado para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

Comando para definir permissões no registro de modelos do Databricks: databricks model-registry set-permissions

Defina permissões de modelo registradas, substituindo as permissões existentes se elas existirem. Excluirá todas as permissões diretas se nenhuma for especificada. Os objetos podem herdar permissões de seu objeto raiz.

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    O modelo registrado para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

Databricks registro-de-modelos atualizar-permissões

Atualize as permissões em um modelo registrado. Os modelos registrados podem herdar permissões de seu objeto raiz.

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    O modelo registrado para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

Sinalizadores globais

--debug

  Indica se deve 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, text ou json. 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, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg para usar ao 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, append, inplace ou json

-t, --target corda

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