Partilhar via


model-registry grupo de comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-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 disposições de Dados de Uso.

Note

Esta referência de API documenta APIs para o Registo de Modelos do Workspace. Em vez disso, a Databricks recomenda o uso de Modelos no Unity Catalog . Os modelos no Unity Catalog oferecem governança centralizada de modelos, acesso entre diferentes espaços de trabalho, rastreabilidade e implantação. O Registro do Modelo de Espaço de Trabalho será preterido no futuro.

O model-registry grupo de comandos dentro da CLI Databricks permite-lhe gerir todo o ciclo de vida dos Modelos MLflow. O Registro de Modelo de Espaço de Trabalho é 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 MLflow.

databricks model-registry aprovar-pedido-de-transição

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

    Fase-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

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

Bandeiras globais

databricks modelo-registro criar-comentário

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 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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

databricks registo-de-modelo criar-modelo

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

Lança RESOURCE_ALREADY_EXISTS se existir um modelo registado com o nome fornecido.

databricks model-registry create-model NAME [flags]

Arguments

NAME

    Registar modelos com este nome

Opções

--description string

    Descrição opcional para o modelo registado.

--json JSON

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

Bandeiras globais

Databricks registo de modelo criar versão do modelo

Crie uma versão do modelo.

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

Arguments

NAME

    Registar modelo com este nome

SOURCE

    URI que indica a localização dos artefatos do modelo.

Opções

--description string

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

--json JSON

    A cadeia de caracteres JSON embutida 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 executado no servidor de rastreamento MLflow.

--run-link string

    MLflow run link - este é o link exato da execução que gerou esta versão do modelo, potencialmente hospedada em outra instância do MLflow.

Bandeiras globais

Databricks registo de modelos criar pedido de transição

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

    Fase-alvo da transição. Os valores válidos são:

  • Nenhum: O estágio inicial de uma versão do modelo.
  • Preparação: Estágio de preparação ou pré-produção.
  • Produção: Fase de produção.
  • Arquivado: Fase arquivada.

Valores suportados: [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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

databricks modelo-registro criar-webhook

Note

Este comando está em Pré-visualização Pública.

Crie 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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--model-name string

    Nome do modelo cujos eventos acionariam esse webhook.

--status RegistryWebhookStatus

    Habilite ou desative o acionamento do webhook ou coloque o webhook no modo de teste. Valores suportados: [ATIVO, DESATIVADO, MODO_TESTE]

Bandeiras globais

databricks registro de modelo eliminar comentário

Excluir 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

Bandeiras globais

Databricks Modelo-Registro-Exclusão-Modelo

Exclua um modelo registrado.

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

Bandeiras globais

databricks modelo-registro apagar-etiqueta-do-modelo

Exclua a etiqueta de um modelo registado.

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

Arguments

NAME

    Nome do modelo registrado no qual a tag foi registrada.

KEY

    Nome da tag. O nome deve ser uma correspondência exata; a exclusão de caracteres curinga não é suportada. O tamanho máximo é de 250 bytes.

Opções

Bandeiras globais

databricks model-registry apagar-versão-do-modelo

Exclua uma versão do modelo.

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

Arguments

NAME

    Nome do modelo registado

VERSION

    Número da versão do modelo

Opções

Bandeiras globais

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]

Arguments

NAME

    Nome do modelo registrado no qual a tag foi registrada.

VERSION

    Número da versão do modelo em que a tag foi registrada.

KEY

    Nome da tag. O nome deve ser uma correspondência exata; a exclusão de caracteres curinga não é suportada. O tamanho máximo é de 250 bytes.

Opções

Bandeiras globais

Databricks model-registry eliminar pedido de transição

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]

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Fase-alvo do pedido de transição. Os valores válidos são:

  • Nenhum: O estágio inicial de uma versão do modelo.
  • Preparação: Estágio de preparação ou pré-produção.
  • Produção: Fase de produção.
  • Arquivado: Fase arquivada.

Valores suportados: [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, apenas 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.

Bandeiras globais

databricks modelo-registro excluir-webhook

Note

Este comando está em Pré-visualização Pública.

Exclui um webhook de registo.

databricks model-registry delete-webhook [flags]

Arguments

None

Opções

--id string

    Webhook ID necessário para excluir um webhook de registro.

Bandeiras globais

Databricks Registo de Modelos obter-últimas-versões

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

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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Registro de Modelos Databricks obter-modelo

Obtenha os detalhes de um modelo. Esta é uma versão do espaço de trabalho Databricks do endpoint MLflow que também devolve o ID do espaço de trabalho Databricks do modelo e o nível de permissão do utilizador que faz a solicitação no modelo.

databricks model-registry get-model NAME [flags]

Arguments

NAME

    Identificador de nome exclusivo do modelo registrado.

Opções

Bandeiras globais

databricks comando de registo de modelo obter-versão-de-modelo

Obtenha uma versão do modelo.

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

Arguments

NAME

    Nome do modelo registado

VERSION

    Número da versão do modelo

Opções

Bandeiras 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 registado

VERSION

    Número da versão do modelo

Opções

Bandeiras globais

databricks modelo-registro lista-modelos

Liste todos os modelos registados disponíveis, até ao limite especificado em max_results.

databricks model-registry list-models [flags]

Arguments

None

Opções

--max-results int

    Número máximo de modelos registados pretendidos.

--page-token string

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

Bandeiras globais

Databricks modelo-registo-lista-pedidos-transição

Obtenha uma lista de todas as solicitações de transição de estágio abertas 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

Bandeiras globais

databricks modelo-registro lista-webhooks

Note

Este comando está em Pré-visualização Pública.

Liste todos os webhooks de 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 do modelo associado.

--page-token string

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

Bandeiras globais

databricks registro de modelo rejeitar pedido 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

    Fase-alvo da transição. Os valores válidos são:

  • Nenhum: O estágio inicial de uma versão do modelo.
  • Preparação: Estágio de preparação ou pré-produção.
  • Produção: Fase de produção.
  • Arquivado: Fase arquivada.

Valores suportados: [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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Databricks Modelo-Registro Renomear-Modelo

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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--new-name string

    Se fornecido, atualiza o nome para este modelo_registado.

Bandeiras globais

Databricks registo de modelos pesquisar versões de modelos

Procure versões específicas dos modelos 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 aceder à próxima página com base na pesquisa anterior.

Bandeiras globais

Databricks registo de modelos pesquisar modelos

Procure modelos registados com base no filtro especificado.

databricks model-registry search-models [flags]

Arguments

None

Opções

--filter string

    Condição do 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 numa consulta de pesquisa anterior.

Bandeiras globais

databricks model-registo set-model-tag

Defina uma tag num modelo registado.

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

Arguments

NAME

    Nome exclusivo do modelo.

KEY

    Nome da tag. O tamanho máximo depende do back-end de armazenamento. Se já existir uma tag com esse nome, seu valor preexistente será substituído pelo valor especificado. Todos os back-ends de armazenamento têm garantido suporte a valores de chaves de até 250 bytes de tamanho.

VALUE

    Valor da cadeia de caracteres da tag que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os back-ends de armazenamento garantem suporte a valores de chave com até 5000 bytes de tamanho.

Opções

--json JSON

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

Bandeiras globais

databricks registo de modelos definir etiqueta de versão do modelo

Defina uma tag 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 tag. O tamanho máximo depende do back-end de armazenamento. Se já existir uma tag com esse nome, seu valor preexistente será substituído pelo valor especificado. Todos os back-ends de armazenamento têm garantido suporte a valores de chaves de até 250 bytes de tamanho.

VALUE

    Valor da cadeia de caracteres da tag que está sendo registrada. O tamanho máximo depende do back-end de armazenamento. Todos os back-ends de armazenamento garantem suporte a valores de chave com até 5000 bytes de tamanho.

Opções

--json JSON

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

Bandeiras globais

databricks modelo-registro teste-registro-webhook

Note

Este comando está em Pré-visualização Pública.

Teste um webhook de registro.

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

Arguments

ID

    Identificador do Webhook

Opções

--event RegistryWebhookEvent

    Se o evento for especificado, o gatilho 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_TO_PRODUCTION_CREATED, TRANSITION_REQUEST_TO_STAGING_CREATED ]

--json JSON

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

Bandeiras globais

Databricks Registo-de-Modelos Transição-de-Estágio

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

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

Arguments

NAME

    Nome do modelo.

VERSION

    Versão do modelo.

STAGE

    Fase-alvo da transição. Os valores válidos são:

  • Nenhum: O estágio inicial de uma versão do modelo.
  • Preparação: Estágio de preparação ou pré-produção.
  • Produção: Fase de produção.
  • Arquivado: Fase arquivada.

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

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

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

Bandeiras globais

databricks atualização-comentário do modelo-registro

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

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

Arguments

ID

    Identificador único de uma atividade

COMMENT

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

Opções

--json JSON

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

Bandeiras globais

Atualizar modelo no registo de modelos do Databricks

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 modelo_registrado.

--json JSON

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

Bandeiras globais

No translation is needed for command usage; however, for clarification, it can be presented as follows: "Comando do Databricks para atualização de versão do modelo: `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 registado

VERSION

    Número da versão do modelo

Opções

--description string

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

--json JSON

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

Bandeiras globais

databricks modelo-registro atualização-webhook

Note

Este comando está em Pré-visualização Pública.

Atualize um webhook de registo.

databricks model-registry update-webhook ID [flags]

Arguments

ID

    ID de Webhook

Opções

--description string

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

--json JSON

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

--status RegistryWebhookStatus

    Habilite ou desative o acionamento do webhook ou coloque o webhook no modo de teste. Valores suportados: [ATIVO, DESATIVADO, MODO_TESTE]

Bandeiras globais

databricks model-registry obter níveis de permissão

Obtenha níveis de permissão dos modelos registados.

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

Bandeiras globais

databricks modelo-registry obter-permissões

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

Bandeiras globais

Registro de Modelos do Databricks Definir Permissões

Defina permissões de modelo registrado, substituindo as permissões existentes, se elas existirem. Exclui 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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Databricks atualização de permissões do registro de modelos

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 embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Bandeiras globais

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

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

--log-file string

    Uma cadeia de caracteres que representa o ficheiro onde os registos de saída são gravados. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo de formato de log, text ou json. O valor predefinido é text.

--log-level string

    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á desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

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

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

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