model-registry grupo de comando
Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.
Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.
Esta referência API documenta APIs para o Workspace Model Registry. A Databricks recomenda utilizar Modelos no Unity Catalog. Os modelos no Unity Catalog oferecem governança centralizada de modelos, acesso cross-workspace, linhagem e implantação. Workspace Model Registry será descontinuado no futuro.
O grupo de comandos model-registry dentro do Databricks CLI permite gerenciar todo o ciclo de vida dos modelos MLflow. O Workspace Model Registry é um repositório centralizado de modelos, uma interface de usuário e um conjunto de APIs que permitem gerenciar todo o ciclo de vida dos modelos MLflow.
databricks modelo-registrador-aprovação-solicitação de transição
Aprovar uma solicitação de transição de estágio da versão modelo.
databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
STAGE
Estágio alvo da transição. Valores suportados: Archived, None, Production, Staging
ARCHIVE_EXISTING_VERSIONS
Especifica se todas as versões atuais do modelo devem ser arquivadas no estágio de destino.
Opções
--comment string
Comentário fornecido pelo usuário sobre a ação.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry create-comment
Publique um comentário sobre 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 testes ou erros de implantação.
databricks model-registry create-comment NAME VERSION COMMENT [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
COMMENT
Comentário fornecido pelo usuário sobre a ação.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry create-model
Crie um novo modelo registrado com o nome especificado no corpo da solicitação.
Lança RESOURCE_ALREADY_EXISTS se existir um modelo registrado com o nome fornecido.
databricks model-registry create-model NAME [flags]
Argumentos
NAME
registro modelos sob este nome
Opções
--description string
Descrição opcional para o modelo registrado.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
registro de modelo do databricks criar versão do modelo
Crie uma versão do modelo.
databricks model-registry create-model-version NAME SOURCE [flags]
Argumentos
NAME
registro do modelo com este nome
SOURCE
URI indicando a localização dos artefatos do modelo.
Opções
--description string
Descrição opcional para a versão do modelo.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--run-id string
MLflow ID de execução para correlação, se a fonte foi gerada por uma experiência execução em MLflow servidor de acompanhamento.
--run-link string
Link de execução do MLflow - este é o link exato da execução que gerou esta versão do modelo, potencialmente hospedada em outra instância do MLflow.
solicitação de criação de transição do registro de modelos do databricks
Crie uma solicitação de transição de estágio da versão do modelo.
databricks model-registry create-transition-request NAME VERSION STAGE [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
STAGE
Estágio alvo da transição. Os valores válidos são:
- Nenhum: o estágio inicial de uma versão do modelo.
- Encenação: Estágio de preparação ou pré-produção.
- Produção: Etapa de produção.
- Arquivado: Estágio arquivado.
Valores suportados: [Arquivado, Nenhum, Produção, Preparação]
Opções
--comment string
Comentário fornecido pelo usuário sobre a ação.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry create-webhook
Este comando está em pré-visualização pública.
Crie um webhook de registro.
databricks model-registry create-webhook [flags]
Argumentos
Nenhuma
Opções
--description string
Descrição especificada pelo usuário para o webhook.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--model-name string
Nome do modelo cujos eventos acionariam esse webhook.
--status RegistryWebhookStatus
Ative ou desative o acionamento do webhook ou coloque o webhook no modo de teste. Valores suportados: [ACTIVE, DISABLED, TEST_MODE]
databricks model-registry excluir-comment
Exclua um comentário em uma versão do modelo.
databricks model-registry delete-comment ID [flags]
Argumentos
ID
Identificador exclusivo do comentário a ser excluído.
Opções
modelo-modelo de exclusão de registro do databricks
Exclua um modelo registrado.
databricks model-registry delete-model NAME [flags]
Argumentos
NAME
Identificador de nome exclusivo do modelo registrado.
Opções
databricks model-registry delete-model-tag
Exclua a tag de um modelo registrado.
databricks model-registry delete-model-tag NAME KEY [flags]
Argumentos
NAME
Nome do modelo registrado sob o qual a tag foi registrada.
KEY
Nome da etiqueta. O nome deve corresponder exatamente; a exclusão de curingas não é suportada. O tamanho máximo é 250 bytes.
Opções
registro de modelo do databricks excluir versão do modelo
Exclua uma versão do modelo.
databricks model-registry delete-model-version NAME VERSION [flags]
Argumentos
NAME
Nome do modelo registrado
VERSION
Número da versão do modelo
Opções
databricks model-registry delete-model-version-tag
Exclua uma tag de versão do modelo.
databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]
Argumentos
NAME
Nome do modelo registrado sob o qual a tag foi registrada.
VERSION
Número da versão do modelo em que a tag foi registrada.
KEY
Nome da etiqueta. O nome deve corresponder exatamente; a exclusão de curingas não é suportada. O tamanho máximo é 250 bytes.
Opções
solicitação de exclusão de transição do registro de modelos do databricks
Cancelar uma solicitação de transição de estágio de versão do modelo.
databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
STAGE
Estágio alvo da solicitação de transição. Os valores válidos são:
- Nenhum: o estágio inicial de uma versão do modelo.
- Encenação: Estágio de preparação ou pré-produção.
- Produção: Etapa de produção.
- Arquivado: Estágio arquivado.
Valores suportados: [Arquivado, Nenhum, Produção, Preparação]
CREATOR
Nome de usuário do usuário que criou essa solicitação. Das solicitações de transição que correspondam aos detalhes especificados, somente a transição criada por esse usuário será excluída.
Opções
--comment string
Comentário fornecido pelo usuário sobre a ação.
databricks model-registry delete-webhook
Este comando está em pré-visualização pública.
Exclui um webhook de registro.
databricks model-registry delete-webhook [flags]
Argumentos
Nenhuma
Opções
--id string
ID de webhook necessária para excluir um webhook de registro.
databricks model-registry obtenha as versões mais recentes
Obtenha a versão mais recente de um modelo registrado.
databricks model-registry get-latest-versions NAME [flags]
Argumentos
NAME
Identificador de nome exclusivo do modelo registrado.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry get-model
Veja os detalhes de um modelo. Esta é uma versão Databricks workspace da MLflow endpoint que também retorna o ID Databricks workspace do modelo e o nível de permissão do usuário solicitante no modelo.
databricks model-registry get-model NAME [flags]
Argumentos
NAME
Identificador de nome exclusivo do modelo registrado.
Opções
registro de modelos do databricks get-model-version
Obtenha uma versão modelo.
databricks model-registry get-model-version NAME VERSION [flags]
Argumentos
NAME
Nome do modelo registrado
VERSION
Número da versão do modelo
Opções
databricks model-registry obter-versão-do-modelo-download-uri
Obtenha um URI para download a versão do modelo.
databricks model-registry get-model-version-download-uri NAME VERSION [flags]
Argumentos
NAME
Nome do modelo registrado
VERSION
Número da versão do modelo
Opções
modelos de databricks - modelos de listas de registros
Liste todos os modelos registrados disponíveis, até o limite especificado em max_results .
databricks model-registry list-models [flags]
Argumentos
Nenhuma
Opções
--max-results int
Número máximo de modelos cadastrados desejados.
--page-token string
Tokens de paginação para avançar para a próxima página com base em uma consulta anterior.
solicitações de transição de lista de registros de modelos do databricks
Obtenha uma lista de todas as solicitações de transição de estágio em aberto para a versão do modelo.
databricks model-registry list-transition-requests NAME VERSION [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
Opções
databricks, lista de registros de modelos, webhooks
Este comando está em pré-visualização pública.
Liste todos os webhooks do registro.
databricks model-registry list-webhooks [flags]
Argumentos
Nenhuma
Opções
--model-name string
Se não for especificado, todos os webhooks associados aos eventos especificados serão listados, independentemente do modelo associado.
--page-token string
tokens indicando a página dos resultados do artefato a ser buscada.
solicitação de rejeição de transição de registro de modelo do databricks
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]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
STAGE
Estágio alvo da transição. Os valores válidos são:
- Nenhum: o estágio inicial de uma versão do modelo.
- Encenação: Estágio de preparação ou pré-produção.
- Produção: Etapa de produção.
- Arquivado: Estágio arquivado.
Valores suportados: [Arquivado, Nenhum, Produção, Preparação]
Opções
--comment string
Comentário fornecido pelo usuário sobre a ação.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
modelo-modelo de renomeação de registro de databricks
Renomeie um modelo registrado.
databricks model-registry rename-model NAME [flags]
Argumentos
NAME
Identificador de nome exclusivo do modelo registrado.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--new-name string
Se fornecido, atualiza o nome desse registered_model.
databricks model-registro-pesquisa-versões-modelo
Pesquise versões específicas do modelo com base no filtro fornecido.
databricks model-registry search-model-versions [flags]
Argumentos
Nenhuma
Opções
--filter string
condição do filtro de strings, como "name='my-model-name'".
--max-results int
Número máximo de modelos desejados.
--page-token string
Tokens de paginação para avançar para a próxima página com base na consulta de pesquisa anterior.
modelos de banco de dados - modelos de pesquisa de registro
Pesquise modelos registrados com base no filtro especificado.
databricks model-registry search-models [flags]
Argumentos
Nenhuma
Opções
--filter string
condição do filtro de strings, como "nome LIKE 'my-model-name'".
--max-results int
Número máximo de modelos desejados.
--page-token string
Tokens de paginação para avançar para a próxima página com base em uma consulta de pesquisa anterior.
databricks model-registry set-model-tag
Defina uma etiqueta em um modelo registrado.
databricks model-registry set-model-tag NAME KEY VALUE [flags]
Argumentos
NAME
Nome exclusivo do modelo.
KEY
Nome da etiqueta. O tamanho máximo depende do back-end de armazenamento. Se uma tag com esse nome já existir, seu valor preexistente será substituído pelo valor especificado. Todos os back-ends de armazenamento garantem suporte a valores de key com tamanho de até 250 bytes.
VALUE
valor das strings da tag que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os backends de armazenamento garantem suporte a valores de key com tamanho de até 5000 bytes.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry set-model-version-tag
Defina uma tag de versão do modelo.
databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]
Argumentos
NAME
Nome exclusivo do modelo.
VERSION
Número da versão do modelo.
KEY
Nome da etiqueta. O tamanho máximo depende do back-end de armazenamento. Se uma tag com esse nome já existir, seu valor preexistente será substituído pelo valor especificado. Todos os back-ends de armazenamento garantem suporte a valores de key com tamanho de até 250 bytes.
VALUE
valor das strings da tag que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os backends de armazenamento garantem suporte a valores de key com tamanho de até 5000 bytes.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks model-registry-test-registry-webhook
Este comando está em pré-visualização pública.
Teste um webhook de registro.
databricks model-registry test-registry-webhook ID [flags]
Argumentos
ID
ID do webhook
Opções
--event RegistryWebhookEvent
Se o evento for especificado, o acionador de teste usará o evento especificado. Valores suportados: [ 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_PARA_PRODUCTION_CREATED, TRANSITION_REQUEST_TO_STAGING_CREATED ]
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
estágio de transição do registro do modelo databricks
Faça a transição do estágio de uma versão do modelo. Esta é uma versão Databricks workspace da MLflow endpoint que também aceita um comentário associado à transição a ser registrada.
databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
Argumentos
NAME
Nome do modelo.
VERSION
Versão do modelo.
STAGE
Estágio alvo da transição. Os valores válidos são:
- Nenhum: o estágio inicial de uma versão do modelo.
- Encenação: Estágio de preparação ou pré-produção.
- Produção: Etapa de produção.
- Arquivado: Estágio arquivado.
Valores suportados: [Arquivado, Nenhum, Produção, Preparação]
ARCHIVE_EXISTING_VERSIONS
Especifica se todas as versões atuais do modelo devem ser arquivadas no estágio de destino.
Opções
--comment string
Comentário fornecido pelo usuário sobre a ação.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
comentário de atualização do registro de modelos do databricks
Publique uma edição em um comentário sobre uma versão modelo.
databricks model-registry update-comment ID COMMENT [flags]
Argumentos
ID
Identificador exclusivo de uma atividade
COMMENT
Comentário fornecido pelo usuário sobre a ação.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
modelo-modelo de atualização de registro do databricks
Atualize um modelo registrado.
databricks model-registry update-model NAME [flags]
Argumentos
NAME
Identificador de nome exclusivo do modelo registrado.
Opções
--description string
Se fornecido, atualiza a descrição desse registered_model.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks modelo-atualização-versão do modelo de registro
Atualize a versão do modelo.
databricks model-registry update-model-version NAME VERSION [flags]
Argumentos
NAME
Nome do modelo registrado
VERSION
Número da versão do modelo
Opções
--description string
Se fornecido, atualiza a descrição desse registered_model.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
webhook de atualização de registro de modelos do databricks
Este comando está em pré-visualização pública.
Atualize um webhook de registro.
databricks model-registry update-webhook ID [flags]
Argumentos
ID
ID do webhook
Opções
--description string
Descrição especificada pelo usuário para o webhook.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--status RegistryWebhookStatus
Ative ou desative o acionamento do webhook ou coloque o webhook no modo de teste. Valores suportados: [ACTIVE, DISABLED, TEST_MODE]
databricks model-registry get-permission-levels
Obtenha níveis de permissão de modelo registrados.
databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]
Argumentos
REGISTERED_MODEL_ID
O modelo registrado para o qual se deseja obter ou gerenciar permissões.
Opções
permissões de obtenção de permissões de registro de modelos 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]
Argumentos
REGISTERED_MODEL_ID
O modelo registrado para o qual se deseja obter ou gerenciar permissões.
Opções
permissões do conjunto de registros de modelos do databricks
Defina as permissões registradas do modelo, substituindo as permissões existentes, se elas existirem. Exclui todas as permissões diretas se nenhuma for especificada. Os objetos podem herdar permissões do objeto raiz.
databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]
Argumentos
REGISTERED_MODEL_ID
O modelo registrado para o qual se deseja obter ou gerenciar permissões.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
permissões de atualização do registro do modelo databricks
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]
Argumentos
REGISTERED_MODEL_ID
O modelo registrado para o qual se deseja obter ou gerenciar permissões.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Bandeiras globais
--debug
Se deve habilitar o registro de depuração.
-h ou --help
Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file string
Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
--log-format Formato
O tipo de formato do log, text ou json. O valor de default é text.
--log-level string
Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.
-o, --output Tipo
O tipo de saída do comando, text ou json. O valor de default é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT será usado.
--progress-format Formato
O formato para exibir o progresso logs: default, append, inplace ou json
-t, --target string
Se aplicável, o destino do pacote a ser usado