experiments 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.
O grupo de comandos experiments dentro do Databricks CLI permite criar, editar, excluir e gerenciar experimentos no MLflow. Consulte Organizar treinamento de execução com experimentos de MLflow.
databricks experimentos create-experiment
Crie um experimento com um nome. Retorna o ID do experimento recém-criado. Valida que 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 existir um experimento com o nome dado.
databricks experiments create-experiment NAME [flags]
Argumentos
NAME
Nome do experimento.
Opções
--artifact-location string
Local onde todos os artefatos do experimento estão armazenados.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
experimentos do databricks criar-execução
Crie uma nova execução dentro de um experimento. Uma execução é geralmente uma única execução de um pipeline de aprendizado de máquina ou ETL de dados. O MLflow utiliza execuções para rastrear mlflowParam, mlflowMetric e mlflowRunTag associados a uma única execução.
databricks experiments create-run [flags]
Argumentos
Nenhuma
Opções
--experiment-id string
ID do experimento associado.
--json JSON
As strings JSON 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 momento em que a execução começou.
--user-id string
ID do usuário que está executando a execução.
databricks experimentos delete-experiment
Marque um experimento e os metadados, execução, métricas, parâmetros e tags associados para exclusão. Se o experimento usar o FileStore, os artefatos associados ao experimento também serão excluídos.
databricks experiments delete-experiment EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
ID do experimento associado.
Opções
--json JSON
As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação
experimentos do Databricks excluir execução
Marque uma execução para exclusão.
databricks experiments delete-run RUN_ID [flags]
Argumentos
RUN_ID
ID da execução a ser excluída.
Opções
--json JSON
As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação
experimentos do databricks excluir-execução
Execução de exclusão em massa em um experimento que foi criado antes ou na data e hora especificadas. Exclui no máximo max_runs por solicitação. Para chamar esta API a partir de um Databricks Notebook em Python, é possível utilizar o trecho de código do cliente em
databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]
Argumentos
EXPERIMENT_ID
A identificação da experiência que contém a execução a ser excluída.
MAX_TIMESTAMP_MILLIS
O carimbo de data/hora máximo em milissegundos desde a época UNIX para exclusão da execução. Apenas as execuções criadas antes ou neste momento são excluídas.
Opções
--json JSON
As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação
--max-runs int
Um número inteiro positivo opcional que indica o número máximo de execuções a serem excluídas.
databricks experiments delete-tag
Excluir uma etiqueta de uma execução. As tags são metadados de execução que podem ser atualizados durante uma execução e após a conclusão da mesma.
databricks experiments delete-tag RUN_ID KEY [flags]
Argumentos
RUN_ID
ID da execução em que a tag foi registrada. Obrigatório.
KEY
Nome da etiqueta. O tamanho máximo é de 255 bytes. Obrigatório.
Opções
--json JSON
As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação
experimentos de databricks get-by-name
Obtenha metadados para um experimento com o nome especificado.
Este comando retornará os experimentos excluídos, mas dará preferência ao experimento ativo se um experimento ativo e um excluído tiverem o mesmo nome. Se várias experiências excluídas compartilharem o mesmo nome, a API retornará uma delas.
Lança RESOURCE_DOES_NOT_EXIST se não existir nenhum experimento com o nome especificado.
databricks experiments get-by-name EXPERIMENT_NAME [flags]
Argumentos
EXPERIMENT_NAME
Nome do experimento associado.
Opções
Databricks | experimentos | get-experiment
Obtenha metadados para um experimento com o ID especificado. Este comando funciona em experiências excluídas.
databricks experiments get-experiment EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
ID do experimento associado.
Opções
experimentos do databricks obter-história
Obtenha uma lista de todos os valores para as métricas especificadas para uma determinada execução.
databricks experiments get-history METRIC_KEY [flags]
Argumentos
METRIC_KEY
Nome das métricas.
Opções
--max-results int
Número máximo de registros métricas a serem retornados por solicitação paginada.
--page-token string
tokens indicando a página de métricas história a ser buscada.
--run-id string
ID da execução da qual os valores métricas devem ser obtidos.
--run-uuid string
Obsoleto, use --run_id em vez disso. ID da execução da qual os valores métricas devem ser obtidos.
experimentos do databricks obter execução
Obtenha os metadados, métricas, parâmetros e tags para uma execução. No caso em que várias métricas com o mesmo key são registros para uma execução, retorne apenas o valor com o timestamp 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]
Argumentos
RUN_ID
ID da execução a ser buscada. Deve ser fornecido.
Opções
--run-uuid string
Obsoleto, use --run_id em vez disso. ID da execução a ser buscada.
artefatos da lista de experimentos de databricks
Listar artefatos para uma execução. Usa um prefixo artifact_path opcional que, se especificado, contém somente artefatos com o prefixo especificado. Serão recuperados no máximo 1000 artefatos para volumes d Unity Catalog. Utilize o comando databricks fs ls para listar artefatos nos volumes do Unity Catalog, que suporta paginação.
databricks experiments list-artifacts [flags]
Argumentos
Nenhuma
Opções
--page-token string
Os tokens que indicam a página dos resultados do artefato a ser buscada.
--path string
Filtre artefatos que correspondam a esse caminho (um caminho relativo do diretório raiz de artefatos).
--run-id string
ID da execução cujos artefatos serão listados.
--run-uuid string
Obsoleto, use --run_id em vez disso. ID da execução cujos artefatos serão listados.
lista de experimentos de databricks - experimentos
Obtenha uma lista de todos os experimentos.
databricks experiments list-experiments [flags]
Argumentos
Nenhuma
Opções
--max-results int
Número máximo de experimentos desejados.
--page-token string
tokens indicando a página das experiências a serem buscadas.
--view-type ViewType
Qualificador para o tipo de experimento a ser devolvido. Valores suportados: ACTIVE_ONLY, ALL, DELETED_ONLY
experimentos do databricks log-lotes
Registre várias métricas, parâmetros e tags para uma execução. Se algum dado falhar em persistir, o servidor responderá com um erro (código de status diferente de 200). Para substituir o comportamento e os limites de solicitação, consulte Experimentos.
databricks experiments log-batch [flags]
Argumentos
Nenhuma
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--run-id string
ID da execução em log em.
experimentos do databricks log-inputs
Este comando é experimental.
registra entradas, como conjuntos de dados e modelos, em uma execução do MLflow.
databricks experiments log-inputs RUN_ID [flags]
Argumentos
RUN_ID
ID da execução em log em
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
experimentos do Databricks log-métricas
Registre as métricas para a execução. Uma métrica é um valor par keye ( key, valor float) com um timestamp associado. Exemplos incluem as diversas métricas que representam a precisão do modelo de ML. As métricas podem ser registradas várias vezes.
databricks experiments log-metric KEY VALUE TIMESTAMP [flags]
Argumentos
KEY
Nome das métricas.
VALUE
Valor duplicado das métricas que são logs.
TIMESTAMP
Carimbo de data/hora Unix em milissegundos no momento em que as métricas foram registradas.
Opções
--dataset-digest string
resumo do conjunto de dados do dataset associado às métricas, por exemplo
--dataset-name string
O nome do dataset associado às métricas.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--model-id string
ID dos modelos registrados associados às métricas, se aplicável.
--run-id string
log ID da execução sob a qual as métricas devem ser executadas.
--run-uuid string
Obsoleto, use --run_id em vez disso. log ID da execução sob a qual as métricas devem ser executadas.
--step int
Etapa em que as métricas devem ser log adas.
experimentos com o Databricks modelos de logged
registrar um modelo.
Este comando é experimental.
databricks experiments log-model [flags]
Argumentos
Nenhuma
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @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 em log em.
experimentos do databricks log-param
registrar um parâmetro utilizado para a execução. Um parâmetro é um valor par keye ( key de strings, valor de strings). Exemplos incluem hiperparâmetros utilizados para o treinamento de modelos de ML e datas e valores constantes utilizados em um pipeline ETL. Um parâmetro pode ser registrado apenas uma vez por execução.
databricks experiments log-param KEY VALUE [flags]
Argumentos
KEY
Nome do parâmetro. O tamanho máximo é de 255 bytes.
VALUE
valor das strings do parâmetro que está sendo registrado. O tamanho máximo é de 500 bytes.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--run-id string
ID da execução sob a qual o parâmetro deve ser e log ado.
--run-uuid string
log ID da execução sob a qual o parâmetro deve ser obtido.
experimentos de restauração de databricks
Restaure um experimento marcado para exclusão. Isso também restaura os metadados, execução, métricas, parâmetros e tags associados. Se o experimento usar o FileStore, os artefatos subjacentes associados ao experimento também serão restaurados.
Lança RESOURCE_DOES_NOT_EXIST se o experimento nunca foi criado ou foi excluído permanentemente.
databricks experiments restore-experiment EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
ID do experimento associado.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks experimentos restaurar execução
Restaurar uma execução excluída. Isso também restaura os metadados, execução, métricas, parâmetros e tags associados.
Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se a execução nunca foi criada ou foi excluída permanentemente.
databricks experiments restore-run RUN_ID [flags]
Argumentos
RUN_ID
ID da execução a ser restaurada.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks experimentos restaurar-execução
Executar restauração em massa em um experimento que foi excluído no máximo na data e hora especificadas. Restaura no máximo max_runs por solicitação.
databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]
Argumentos
EXPERIMENT_ID
A identificação da experiência que contém a execução a ser restaurada.
MIN_TIMESTAMP_MILLIS
O carimbo de data/hora mínimo em milissegundos desde a época UNIX para restaurar a execução. Apenas as execuções excluídas após este carimbo de data/hora serão restauradas.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--max-runs int
Um número inteiro positivo opcional que indica o número máximo de execuções a serem restauradas.
databricks experimentos de busca-experimentos
Pesquisa experimentos que atendam aos critérios de pesquisa especificados.
databricks experiments search-experiments [flags]
Argumentos
Nenhuma
Opções
--filter string
strings representando uma condição de filtro " SQL "
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--max-results int
Número máximo de experimentos desejados.
--page-token string
tokens indicando a página das experiências a serem buscadas.
--view-type ViewType
Qualificador para o tipo de experimento a ser devolvido. Valores suportados: ACTIVE_ONLY, ALL, DELETED_ONLY
Pesquisa de experiências do Databricks - execução
Pesquisas por execução que satisfazem as expressões. As expressões de pesquisa podem utilizar as chaves mlflowMetric e mlflowParam.
databricks experiments search-runs [flags]
Argumentos
Nenhuma
Opções
--filter string
Uma expressão de filtro sobre parâmetros, métricas e tags, que permite retornar um subconjunto de execuções.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--max-results int
Número máximo de execuções desejado.
--page-token string
tokens para a página atual de execução.
--run-view-type ViewType
Exibir apenas os ativos, apenas os excluídos ou todos os executados. Valores suportados: ACTIVE_ONLY, ALL, DELETED_ONLY
databricks experimentos set-experiment-tag
Define uma tag em um experimento. As tags do experimento são metadados que podem ser atualizados.
databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]
Argumentos
EXPERIMENT_ID
ID do experimento no qual a tag será e log ada. Deve ser fornecido.
KEY
Nome da etiqueta. São suportadas chaves com tamanho até 250 bytes.
VALUE
valor das strings da tag que está sendo registrada. Valores de até 64 KB de tamanho são suportados.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
conjunto de experimentos de databricks
Define uma etiqueta em uma execução. As tags são metadados de execução que podem ser atualizados durante uma execução e após a conclusão da mesma.
databricks experiments set-tag KEY VALUE [flags]
Argumentos
KEY
Nome da etiqueta. São suportadas chaves com tamanho até 250 bytes.
VALUE
valor das strings da tag que está sendo registrada. Valores de até 64 KB de tamanho são suportados.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--run-id string
ID da execução sob a qual a tag deve ser e log ada.
--run-uuid string
Obsoleto, use --run_id em vez disso. ID da execução sob a qual a tag deve ser e log ada.
experimento de atualização de experimentos de databricks
Atualize um experimento.
databricks experiments update-experiment EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
ID do experimento associado.
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, o nome do experimento é alterado para o novo nome.
atualização da execução de experimentos do databricks
Atualizar uma execução.
databricks experiments update-run [flags]
Argumentos
Nenhuma
Opções
--end-time int
Carimbo de data/hora Unix em milissegundos do momento em que a execução foi concluída.
--json JSON
As cadeias de caracteres JSON ou o caminho @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
Obsoleto, use --run_id em vez disso. ID da execução a ser atualizada.
--status UpdateRunStatus
Status atualizado da execução. Valores suportados: FAILED, FINISHED, KILLED, RUNNING, SCHEDULED
experimentos de databricks obtêm níveis de permissão
Obtenha os níveis de permissão do experimento.
databricks experiments get-permission-levels EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
A experiência para a qual se deseja obter ou gerenciar permissões.
Opções
experimentos de databricks obtêm permissões
Obtenha as permissões de um experimento. Os experimentos podem herdar permissões de seu objeto raiz.
databricks experiments get-permissions EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
A experiência para a qual se deseja obter ou gerenciar permissões.
Opções
conjuntos de permissões de experimentos de databricks
Defina as permissões do experimento.
Define as permissões em um objeto, 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 experiments set-permissions EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
A experiência para a 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 de experimentos do databricks
Atualize as permissões do experimento. Os experimentos podem herdar permissões de seu objeto raiz.
databricks experiments update-permissions EXPERIMENT_ID [flags]
Argumentos
EXPERIMENT_ID
A experiência para a 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