Compartilhar via

az ml job

  • Referência

Observação

Essa referência faz parte da extensão ml para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az ml job . Saiba mais sobre extensões.

Gerenciar trabalhos de ML do Azure.

Um trabalho do Azure ML executa uma tarefa em um destino de computação especificado. Você pode configurar trabalhos para expandir o treinamento de modelo no Azure. O Azure ML dá suporte a diferentes tipos de trabalho com recursos diferentes. Por exemplo, o trabalho mais básico, um trabalho de comando, executa um comando em um contêiner do Docker e pode ser aproveitado para treinamento distribuído e de nó único. Um trabalho de varredura executa uma varredura de hiperparâmetro em um espaço de pesquisa especificado para ajustar os hiperparâmetros de um modelo.

Os trabalhos também permitem o rastreamento sistemático para seus fluxos de trabalho e experimentação de ML. Depois que um trabalho é criado, o Azure ML mantém um registro de execução para o trabalho que inclui os metadados, quaisquer métricas, logs e artefatos gerados durante o trabalho, o código que foi executado e o ambiente de ML do Azure usado. Todos os registros de execução dos seus trabalhos podem ser exibidos no estúdio do Azure ML.

Comandos

Nome Description Tipo Status
az ml job archive

Arquivar um trabalho.

 Extensão GA
az ml job cancel

Cancelar um trabalho.

 Extensão GA
az ml job connect-ssh

Configure a conexão ssh e envie a solicitação para o serviço SSH em execução dentro do contêiner do usuário por meio da Tundra.

 Extensão GA
az ml job create

Crie um trabalho.

 Extensão GA
az ml job download

Baixe todos os arquivos relacionados ao trabalho.

 Extensão GA
az ml job list

Listar trabalhos em um espaço de trabalho.

 Extensão GA
az ml job restore

Restaurar um trabalho arquivado.

 Extensão GA
az ml job show

Mostrar detalhes de um trabalho.

 Extensão GA
az ml job show-services

Mostrar serviços de um trabalho por nó.

 Extensão GA
az ml job stream

Transmita logs de trabalho para o console.

 Extensão GA
az ml job update

Atualizar um trabalho.

 Extensão GA
az ml job validate

Validar um trabalho. Esse comando funciona apenas para trabalhos de pipeline por enquanto.

 Extensão GA

az ml job archive

Arquivar um trabalho.

O arquivamento de um trabalho o ocultará por padrão das consultas de lista (az ml job list). Você ainda pode continuar a referenciar e usar um trabalho arquivado em seus fluxos de trabalho. Somente trabalhos concluídos podem ser arquivados.

az ml job archive --name
                  --resource-group
                  --workspace-name

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job cancel

Cancelar um trabalho.

az ml job cancel --name
                 --resource-group
                 --workspace-name

Exemplos

Cancelar um trabalho pelo nome

az ml job cancel --name my-job-id --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job connect-ssh

Configure a conexão ssh e envie a solicitação para o serviço SSH em execução dentro do contêiner do usuário por meio da Tundra.

az ml job connect-ssh --name
                      --resource-group
                      --workspace-name
                      [--node-index]
                      [--private-key-file-path]

Exemplos

Configure a conexão ssh e envie a solicitação para o serviço SSH.

az ml job connect-ssh --name my-job-id --node-index 0 --private-key-file-path "C:/Temp/.ssh/id_rsa" --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--node-index -i

O índice do nó a ser conectado através do ssh.

Valor padrão: 0
--private-key-file-path -f

O caminho para o arquivo de arquivo de chave privada.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job create

Crie um trabalho.

Para criar um trabalho, você normalmente precisará configurar qualquer código a ser executado, um ambiente encapsulando as dependências, um destino de computação para executar o trabalho e quaisquer configurações adicionais específicas do trabalho. Quando um trabalho é criado, ele é enviado para execução em relação ao recurso de computação especificado.

az ml job create --file
                 --resource-group
                 --workspace-name
                 [--name]
                 [--save-as]
                 [--set]
                 [--skip-validation]
                 [--stream]
                 [--web]

Exemplos

Criar um trabalho a partir de um arquivo de especificação YAML

az ml job create --file job.yml --resource-group my-resource-group --workspace-name my-workspace

Crie um trabalho a partir de um arquivo de especificação YAML e abra os detalhes de execução do trabalho no portal de estúdio do Azure ML

az ml job create --file job.yml --web --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--file -f

Caminho local para o arquivo YAML que contém a especificação de trabalho do Azure ML. Os documentos de referência do YAML para o trabalho podem ser encontrados em: https://aka.ms/ml-cli-v2-job-command-yaml-reference, https://aka.ms/ml-cli-v2-job-sweep-yaml-reference, https://aka.ms/ml-cli-v2-job-pipeline-yaml-reference.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--name -n

Nome do trabalho.

--save-as -a

Arquivo no qual o estado do trabalho criado no formato YAML será gravado.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--skip-validation

Ignorar validação na criação do recurso. Observe que os recursos dependentes não ignorarão sua validação na criação.

Valor padrão: False
--stream -s

Indica se os logs do trabalho devem ser transmitidos para o console.

Valor padrão: False
--web -e

Mostrar os detalhes de execução do trabalho no estúdio do Azure ML em um navegador da Web.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job download

Baixe todos os arquivos relacionados ao trabalho.

Os arquivos serão baixados em uma pasta com o nome do trabalho.

az ml job download --name
                   --resource-group
                   --workspace-name
                   [--all]
                   [--download-path]
                   [--output-name]

Exemplos

Baixar os logs e as saídas de um trabalho para o diretório de trabalho atual

az ml job download --name my-job --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--all

Baixe todas as saídas do trabalho.

Valor padrão: False
--download-path -p

Caminho para o qual baixar os arquivos de trabalho. Se omitidos, os arquivos de trabalho serão baixados para o diretório atual.

--output-name

O nome da saída definida pelo usuário para download. Isso deve corresponder a uma chave no dicionário de saídas de um trabalho. Se omitido, os arquivos de saída de artefato padrão do trabalho serão baixados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job list

Listar trabalhos em um espaço de trabalho.

az ml job list --resource-group
               --workspace-name
               [--all-results {false, true}]
               [--archived-only]
               [--include-archived]
               [--max-results]
               [--parent-job-name]

Exemplos

Liste todos os status de trabalhos em um espaço de trabalho usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

az ml job list --query "[].{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--all-results

Retorna todos os resultados.

Valores aceitos: false, true
Valor padrão: False
--archived-only

Listar somente trabalhos arquivados.

Valor padrão: False
--include-archived

Listar trabalhos arquivados e trabalhos ativos.

Valor padrão: False
--max-results -r

Número máximo de resultados a serem retornados. O padrão é 50.

Valor padrão: 50
--parent-job-name -p

Nome do trabalho pai. Listará todos os trabalhos cuja parent_job_name corresponda ao nome fornecido.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job restore

Restaurar um trabalho arquivado.

Quando um trabalho arquivado é restaurado, ele não será mais oculto das consultas de lista (az ml job list).

az ml job restore --name
                  --resource-group
                  --workspace-name

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job show

Mostrar detalhes de um trabalho.

az ml job show --name
               --resource-group
               --workspace-name
               [--web]

Exemplos

Mostrar o status de um trabalho usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

az ml job show --name my-job-id --query "{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--web -e

Mostrar os detalhes de execução do trabalho no estúdio do Azure ML em um navegador da Web.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job show-services

Mostrar serviços de um trabalho por nó.

az ml job show-services --name
                        --resource-group
                        --workspace-name
                        [--node-index]

Exemplos

Mostrar os serviços de um trabalho por nó usando o argumento --query para executar uma consulta JMESPath nos resultados dos comandos.

az ml job show-services --name my-job-id --node-index 0 --query "{Name:name,Jobstatus:status}"  --output table --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--node-index -i

O índice do nó para o qual os serviços devem ser mostrados.

Valor padrão: 0
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job stream

Transmita logs de trabalho para o console.

az ml job stream --name
                 --resource-group
                 --workspace-name

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job update

Atualizar um trabalho.

Somente as propriedades 'tags' e 'properties' podem ser atualizadas.

az ml job update --name
                 --resource-group
                 --workspace-name
                 [--add]
                 [--force-string]
                 [--remove]
                 [--set]
                 [--web]

Parâmetros Exigidos

--name -n

Nome do trabalho.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

Valor padrão: False
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Valor padrão: []
--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

Valor padrão: []
--web -e

Mostrar os detalhes de execução do trabalho no estúdio do Azure ML em um navegador da Web.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az ml job validate

Validar um trabalho. Esse comando funciona apenas para trabalhos de pipeline por enquanto.

Esse comando validará um arquivo de especificação YAML para verificar se ele é válido para a criação de trabalho e retornará todos os problemas encontrados. A validação inclui principalmente a verificação local do esquema, como campos ausentes, ambiente sem versão especificada, código referido a um caminho local inexistente; Ele também verificará a existência de destinos de computação referenciados no espaço de trabalho de destino. O resultado da validação será impresso no console, incluindo erros e avisos. Somente erros farão com que a validação falhe. Um trabalho aprovado na validação poderá ser enviado. Esse comando funciona apenas para trabalhos de pipeline por enquanto.

az ml job validate --file
                   --resource-group
                   --workspace-name
                   [--set]

Exemplos

Valide um arquivo de especificação YAML para verificar se ele é válido para a criação de trabalho.

az ml job validate --file job.yml --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Exigidos

--file -f

Caminho local para o arquivo YAML que contém a especificação de trabalho do Azure ML. Os documentos de referência do YAML para o trabalho podem ser encontrados em: https://aka.ms/ml-cli-v2-job-pipeline-yaml-reference.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--workspace-name -w

Nome do espaço de trabalho do Azure ML. Você pode configurar o espaço de trabalho padrão usando az configure --defaults workspace=<name>o .

Parâmetros Opcionais

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.