Compartilhar via


Grupo de comandos experiments

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.

O experiments grupo de comandos dentro da CLI do Databricks permite que você crie, edite, exclua e gerencie experimentos no MLflow. Confira Organizar execuções de treinamento com experimentos do MLflow.

experimentos do Databricks criar-experimento

Crie um experimento com um nome. Retorna a ID do experimento recém-criado. Valida se outro experimento com o mesmo nome ainda não existe e falha se outro experimento com o mesmo nome já existir.

Lança RESOURCE_ALREADY_EXISTS se houver um experimento com o nome fornecido.

databricks experiments create-experiment NAME [flags]

Arguments

NAME

    Nome do experimento.

Opções

--artifact-location string

    Local em que todos os artefatos do experimento são armazenados.

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

criação e execução de experimentos do databricks

Crie uma nova execução em um experimento. Uma execução geralmente se refere a uma única execução de um pipeline de aprendizado de máquina ou ETL de dados. O MLflow usa execuções para acompanhar o mlflowParam, o mlflowMetric e o mlflowRunTag associados a uma única rodada.

databricks experiments create-run [flags]

Arguments

None

Opções

--experiment-id string

    ID do experimento associado.

--json JSON

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

--run-name string

    O nome da execução.

--start-time int

    Timestamp Unix em milissegundos do início da execução.

--user-id string

    ID do usuário executando a execução.

Sinalizadores globais

experimentos do Databricks excluir-experimento

Marcar um experimento e metadados associados, execuções, métricas, parâmetros e marcações para exclusão. Se o experimento usar FileStore, os artefatos associados ao experimento também serão excluídos.

databricks experiments delete-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID do experimento associado.

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

execução de exclusão de experimentos do databricks

Marcar uma execução para exclusão.

databricks experiments delete-run RUN_ID [flags]

Arguments

RUN_ID

    ID da execução a ser excluída.

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

Exclusão de execuções de experimentos do Databricks

A exclusão em massa é executada em um experimento que foi criado antes ou no carimbo de data/hora especificado. Exclui no máximo max_runs por solicitação. Para chamar essa API de um Databricks Notebook em Python, você pode usar o exemplo de código do cliente em

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    O ID do experimento que contém os processos a serem excluídos.

MAX_TIMESTAMP_MILLIS

    O carimbo de data/hora máximo de criação em milissegundos desde a época do UNIX para excluir as execuções. Somente as execuções criadas antes ou nesse carimbo de data/hora são excluídas.

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

--max-runs int

    Um inteiro positivo opcional que indica o número máximo de execuções a serem excluídas.

Sinalizadores globais

databricks experimentos delete-tag

Exclua uma marcação em uma execução. As tags são metadados de execução que podem ser atualizados durante e após a conclusão de uma execução.

databricks experiments delete-tag RUN_ID KEY [flags]

Arguments

RUN_ID

    ID da execução sob a qual a marcação foi registrada. Required.

KEY

    Nome da marcação. O tamanho máximo é de 255 bytes. Required.

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

recuperar-experimentos-por-nome do databricks

Obtenha metadados para um experimento com o nome especificado.

Esse comando retornará experimentos excluídos, mas preferirá o experimento ativo se um experimento ativo e excluído compartilhar o mesmo nome. Se vários experimentos excluídos compartilharem o mesmo nome, a API retornará um deles.

Gerará RESOURCE_DOES_NOT_EXIST se não houver nenhum experimento com o nome especificado.

databricks experiments get-by-name EXPERIMENT_NAME [flags]

Arguments

EXPERIMENT_NAME

    Nome do experimento associado.

Opções

Sinalizadores globais

experimentos do Databricks obter-experimento

Obtenha metadados para um experimento com a ID especificada. Esse comando funciona em experimentos excluídos.

databricks experiments get-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID do experimento associado.

Opções

Sinalizadores globais

databricks obter histórico de experimentos

Obtenha uma lista de todos os valores para a métrica especificada para uma determinada execução.

databricks experiments get-history METRIC_KEY [flags]

Arguments

METRIC_KEY

    Nome da métrica.

Opções

--max-results int

    Número máximo de registros de métrica a serem retornados por solicitação paginada.

--page-token string

    Token que indica a página do histórico de métricas a ser buscada.

--run-id string

    ID da execução da qual buscar valores de métrica.

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução da qual buscar valores de métrica.

Sinalizadores globais

get-run de experimentos do databricks

Obtenha os metadados, as métricas, os parâmetros e as etiquetas para uma execução. No caso em que várias métricas com a mesma chave são registradas durante uma execução, retorne apenas o valor com o carimbo de data/hora mais recente.

Se houver vários valores com o carimbo de data/hora mais recente, retorne o máximo desses valores.

databricks experiments get-run RUN_ID [flags]

Arguments

RUN_ID

    ID da execução a ser buscada. Deve ser fornecido.

Opções

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução a ser buscada.

Sinalizadores globais

experimentos databricks list-artifacts

Liste artefatos para uma execução. Usa um prefixo artifact_path opcional que, se especificado, a resposta contém apenas artefatos com o prefixo especificado. Um máximo de 1000 artefatos será recuperado para volumes do Unity Catalog. Use databricks fs ls para listar artefatos em volumes do Unity Catalog, que dá suporte à paginação.

databricks experiments list-artifacts [flags]

Arguments

None

Opções

--page-token string

    O token que indica a página de resultados do artefato a ser buscado.

--path string

    Filtre artefatos correspondentes a esse caminho (um caminho relativo do diretório do artefato raiz).

--run-id string

    ID da execução cujos artefatos serão listados.

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução cujos artefatos serão listados.

Sinalizadores globais

experimentos de databricks list-experiments

Obtenha uma lista de todos os experimentos.

databricks experiments list-experiments [flags]

Arguments

None

Opções

--max-results int

    Número máximo de experimentos desejados.

--page-token string

    Token que indica a página de experimentos a serem buscados.

--view-type ViewType

    Qualificador para o tipo dos experimentos que devem ser retornados. Valores com suporte: ACTIVE_ONLY, ALL, DELETED_ONLY

Sinalizadores globais

experimentos do databricks log-batch

Registre um lote de métricas, parâmetros e marcas para uma execução. Se os dados não forem mantidos, o servidor responderá com um erro (código de status não 200). Para comportamento de substituição e limites de solicitação, consulte Experimentos.

databricks experiments log-batch [flags]

Arguments

None

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.

--run-id string

    ID da execução para fazer logon.

Sinalizadores globais

databricks experimenta entradas de log

Note

Este comando é experimental.

Registra entradas, como conjuntos de dados e modelos, em uma execução do MLflow.

databricks experiments log-inputs RUN_ID [flags]

Arguments

RUN_ID

    ID da execução para fazer logon

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

Métrica de log de experimentos do databricks

Registre uma métrica para uma execução. Uma métrica é um par chave-valor (chave de cadeia de caracteres, valor flutuante) com um carimbo de data/hora associado. Os exemplos incluem as várias métricas que representam a precisão do modelo de ML. Uma métrica pode ser registrada várias vezes.

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

Arguments

KEY

    Nome da métrica.

VALUE

    Valor duplo da métrica que está sendo registrada.

TIMESTAMP

    O timestamp Unix em milissegundos no instante em que a métrica foi registrada.

Opções

--dataset-digest string

    Resumo do conjunto de dados associado à métrica, por exemplo,

--dataset-name string

    O nome do conjunto de dados associado à métrica.

--json JSON

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

--model-id string

    ID do modelo registrado associado à métrica, se aplicável.

--run-id string

    ID da execução na qual a métrica será registrada no log.

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução na qual a métrica será registrada no log.

--step int

    Etapa na qual registrar a métrica em log.

Sinalizadores globais

modelo de log de experimentos do databricks

Registrar um modelo.

Note

Este comando é experimental.

databricks experiments log-model [flags]

Arguments

None

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.

--model-json string

    Arquivo MLmodel no formato json.

--run-id string

    ID da execução para fazer logon.

Sinalizadores globais

databricks experimentos log-param

Registre um parâmetro usado para uma execução. Um parâmetro é um par chave-valor (chave de cadeia de caracteres, valor da cadeia de caracteres). Exemplos incluem hiperparâmetros usados para treinamento de modelo de ML e datas e valores constantes usados em um pipeline de ETL. Um parâmetro pode ser registrado apenas uma vez para uma execução.

databricks experiments log-param KEY VALUE [flags]

Arguments

KEY

    Nome do parâmetro. O tamanho máximo é de 255 bytes.

VALUE

    Valor da cadeia de caracteres do parâmetro que está sendo registrado. O tamanho máximo é de 500 bytes.

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.

--run-id string

    ID da execução na qual o parâmetro deve ser registrado em log.

--run-uuid string

    [Preterido, use run_id em vez disso] ID da execução em que registrar o parâmetro.

Sinalizadores globais

Experimentos do Databricks "restore-experiment"

Restaurar um experimento marcado para exclusão. Isso também restaura metadados, execuções, métricas, parâmetros e marcas associados. Se o experimento usar FileStore, artefatos subjacentes associados ao experimento também serão restaurados.

Gera RESOURCE_DOES_NOT_EXIST se o experimento nunca tiver sido criado ou tiver sido excluído permanentemente.

databricks experiments restore-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID do experimento associado.

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

restauração de execução de experimentos do Databricks

Restaurar um processo excluído. Isso também restaura metadados, execuções, métricas, parâmetros e marcas associados.

Gera RESOURCE_DOES_NOT_EXIST se a execução nunca tiver sido criada ou tiver sido excluída permanentemente.

databricks experiments restore-run RUN_ID [flags]

Arguments

RUN_ID

    ID da execução a ser restaurada.

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

Restauração de execuções de experimentos do Databricks

A restauração em massa é executada em um experimento que não foi excluído anteriormente ao carimbo de data/hora especificado. Restaura no máximo max_runs por solicitação.

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    O ID do experimento contendo as execuções a serem restauradas.

MIN_TIMESTAMP_MILLIS

    O carimbo de data/hora máximo de exclusão em milissegundos desde a época do UNIX para restaurar as execuções. Somente execuções excluídas não anteriores a esse carimbo de data/hora são restauradas.

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.

--max-runs int

    Um inteiro positivo opcional que indica o número máximo de execuções a serem restauradas.

Sinalizadores globais

experimentos de pesquisa do databricks

Pesquisa experimentos que atendem aos critérios de pesquisa especificados.

databricks experiments search-experiments [flags]

Arguments

None

Opções

--filter string

    Cadeia de caracteres que representa uma condição de filtro SQL

--json JSON

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

--max-results int

    Número máximo de experimentos desejados.

--page-token string

    Token que indica a página de experimentos a serem buscados.

--view-type ViewType

    Qualificador para o tipo dos experimentos que devem ser retornados. Valores com suporte: ACTIVE_ONLY, ALL, DELETED_ONLY

Sinalizadores globais

execuções de experimentos de pesquisa do Databricks

Pesquisa execuções que satisfaçam expressões. As expressões de pesquisa podem usar chaves mlflowMetric e mlflowParam.

databricks experiments search-runs [flags]

Arguments

None

Opções

--filter string

    Uma expressão de filtro em parâmetros, métricas e marcações, que permite retornar um subconjunto de execuções.

--json JSON

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

--max-results int

    Número máximo de processos desejados.

--page-token string

    Token de autenticação para a página atual de execuções.

--run-view-type ViewType

    Se devem ser exibidas apenas ativas, apenas excluídas ou todas as execuções. Valores com suporte: ACTIVE_ONLY, ALL, DELETED_ONLY

Sinalizadores globais

databricks experiments set-experiment-tag

Define uma etiqueta em um experimento. As marcas de experimento são metadados que podem ser atualizados.

databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]

Arguments

EXPERIMENT_ID

    ID do experimento no qual registrar a marcação. Deve ser fornecido.

KEY

    Nome da marcação. Há suporte para chaves de até 250 bytes de tamanho.

VALUE

    Valor da string da marcação que está sendo registrada. Há suporte para valores de até 64 KB 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 configurar etiqueta de experimentos

Define uma marcação em uma execução. As tags são metadados de execução que podem ser atualizados durante e após a conclusão de uma execução.

databricks experiments set-tag KEY VALUE [flags]

Arguments

KEY

    Nome da marcação. Há suporte para chaves de até 250 bytes de tamanho.

VALUE

    Valor da string da marcação que está sendo registrada. Há suporte para valores de até 64 KB 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.

--run-id string

    ID da execução na qual registrar a marcação.

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução na qual registrar a marcação.

Sinalizadores globais

experimentos databricks update-experiment

Atualize um experimento.

databricks experiments update-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID do experimento associado.

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, o nome do experimento será alterado para o novo nome.

Sinalizadores globais

databricks experimentos atualizar-execução

Atualize uma execução.

databricks experiments update-run [flags]

Arguments

None

Opções

--end-time int

    Unix timestamp em milissegundos indicando quando a execução foi concluída.

--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 da execução a ser atualizada.

--run-name string

    Nome atualizado da execução.

--run-uuid string

    Preterido, use --run_id em vez disso. ID da execução a ser atualizada.

--status UpdateRunStatus

    Status atualizado da execução. Valores com suporte: FAILED, FINISHED, KILLED, RUNNING, SCHEDULED

Sinalizadores globais

experimentos do databricks get-permission-levels

Obter níveis de permissão de experimento.

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    O experimento para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

permissões de obtenção de experimentos do databricks

Obtenha as permissões de um experimento. Experimentos podem herdar permissões de seu objeto raiz.

databricks experiments get-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    O experimento para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

databricks experimentos set-permissions

Defina permissões de experimento.

Define permissões em um objeto, 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 experiments set-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    O experimento 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 experimenta permissões de atualização

Atualize as permissões de experimento. Experimentos podem herdar permissões de seu objeto raiz.

databricks experiments update-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    O experimento 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