Partilhar via

az ml environment

  • Referência

Nota

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 environment . Saiba mais sobre extensões.

Gerencie ambientes do Azure ML.

Os ambientes do Azure ML definem o ambiente de execução para trabalhos e implantações de ponto de extremidade, encapsulando as dependências para treinamento e inferência. Essas definições de ambiente são incorporadas às imagens do Docker.

Comandos

Name Description Tipo Estado
az ml environment archive

Arquivar um ambiente.

 Extensão GA
az ml environment create

Criar um ambiente.

 Extensão GA
az ml environment list

Listar ambientes em um espaço de trabalho.

 Extensão GA
az ml environment restore

Restaure um ambiente arquivado.

 Extensão GA
az ml environment share

Compartilhe um ambiente específico do espaço de trabalho para o registro.

 Extensão GA
az ml environment show

Mostrar detalhes de um ambiente.

 Extensão GA
az ml environment update

Atualize um ambiente.

 Extensão GA

az ml environment archive

Arquivar um ambiente.

Arquivar um ambiente irá ocultá-lo por padrão das consultas de lista (az ml environment list). Você ainda pode continuar a fazer referência e usar um ambiente arquivado em seus fluxos de trabalho. Você pode arquivar um contêiner de ambiente ou uma versão específica do ambiente. O arquivamento de um contêiner de ambiente arquivará todas as versões do ambiente sob esse nome próprio. Você pode restaurar um ambiente arquivado usando az ml environment restoreo . Se todo o contêiner do ambiente for arquivado, você não poderá restaurar versões individuais do ambiente - será necessário restaurar o contêiner do ambiente.

az ml environment archive --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

Exemplos

Arquivar um contêiner de ambiente (arquiva todas as versões desse ambiente)

az ml environment archive --name my-env --resource-group my-resource-group --workspace-name my-workspace

Arquivar uma versão específica do ambiente

az ml environment archive --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ambiente.

Parâmetros Opcionais

--label -l

Etiqueta do ambiente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do ambiente.

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment create

Criar um ambiente.

Os ambientes podem ser definidos a partir de uma imagem do Docker, Dockerfile ou arquivo Conda. O Azure ML mantém um conjunto de imagens do Docker de CPU e GPU que você pode usar como imagens base. Para obter informações sobre essas imagens, consulte https://github.com/Azure/AzureML-Containers.

O ambiente criado será rastreado no espaço de trabalho sob o nome e a versão especificados.

az ml environment create [--build-context]
                         [--conda-file]
                         [--datastore]
                         [--description]
                         [--dockerfile-path]
                         [--file]
                         [--image]
                         [--name]
                         [--no-wait]
                         [--os-type]
                         [--registry-name]
                         [--resource-group]
                         [--set]
                         [--tags]
                         [--version]
                         [--workspace-name]

Exemplos

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

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

Criar um ambiente a partir de uma imagem do docker

az ml environment create --name my-env --version 1 --file my_env.yml  --image pytorch/pytorch --resource-group my-resource-group --workspace-name my-workspace

Criar um ambiente a partir de um contexto de compilação

az ml environment create --name my-env --version 1 --file my_env.yml  --build-context envs/context/ --dockerfile-path Dockerfile --resource-group my-resource-group --workspace-name my-workspace

Criar um ambiente a partir de uma especificação conda

az ml environment create --name my-env --version 1 --file my_env.yml  --conda-file conda_dep.yml --image mcr.microsoft.com/azureml/openmpi3.1.2-ubuntu18.04 --resource-group my-resource-group --workspace-name my-workspace

Criar um ambiente no registro a partir de um arquivo de especificação YAML

az ml environment create --file my_env.yml --registry-name my-registry-name --resource-group my-resource-group

Parâmetros Opcionais

--build-context -b

Caminho local para o diretório a ser usado como um contexto de compilação do Docker. --build-context/-b e --image/-i são argumentos mutuamente exclusivos.

--conda-file -c

Caminho local para um arquivo de especificação conda. --image/-i também deve ser especificado se este argumento for usado.

--datastore

O armazenamento de dados para o qual carregar o artefato local.

--description

Descrição do ambiente.

--dockerfile-path -d

Caminho relativo para o Dockerfile dentro do diretório especificado por --build-context/-b. Se omitido, './Dockerfile' é usado.

valor predefinido: /Dockerfile
--file -f

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

--image -i

Imagem do Docker. --image/-i e --build-context/-b são argumentos mutuamente exclusivos.

--name -n

Nome do ambiente.

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False
--os-type

Tipo de sistema operacional. Valores permitidos: linux, windows. Padrão: linux.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--set

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

--tags

Pares chave-valor separados por espaço para as tags do objeto.

--version -v

Versão do ambiente.

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment list

Listar ambientes em um espaço de trabalho.

az ml environment list [--archived-only]
                       [--include-archived]
                       [--max-results]
                       [--name]
                       [--registry-name]
                       [--resource-group]
                       [--workspace-name]

Exemplos

Listar todos os ambientes em um espaço de trabalho

az ml environment list --resource-group my-resource-group --workspace-name my-workspace

Listar todas as versões de ambiente para o nome especificado em um espaço de trabalho

az ml environment list --name my-env --resource-group my-resource-group --workspace-name my-workspace

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

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

Listar todos os ambientes em um registro

az ml environment list --registry-name my-registry-name --resource-group my-resource-group

Listar todas as versões de ambiente para o nome especificado em um registro

az ml environment list --name my-env --registry-name my-registry-name --resource-group my-resource-group

Parâmetros Opcionais

--archived-only

Listar apenas ambientes arquivados.

valor predefinido: False
--include-archived

Listar ambientes arquivados e ambientes ativos.

valor predefinido: False
--max-results -r

Número máximo de resultados a retornar.

--name -n

Nome do ambiente. Se fornecida, todas as versões de ambiente com esse nome serão retornadas.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

o 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment restore

Restaure um ambiente arquivado.

Quando um ambiente arquivado é restaurado, ele não ficará mais oculto das consultas de lista (az ml environment list). Se um contêiner de ambiente inteiro for arquivado, você poderá restaurar esse contêiner arquivado. Isso restaurará todas as versões do ambiente sob esse nome próprio. Não é possível restaurar apenas uma versão específica do ambiente se todo o contêiner do ambiente estiver arquivado - você precisará restaurar o contêiner inteiro. Se apenas uma versão individual do ambiente foi arquivada, você pode restaurar essa versão específica.

az ml environment restore --name
                          [--label]
                          [--registry-name]
                          [--resource-group]
                          [--version]
                          [--workspace-name]

Exemplos

Restaurar um contêiner de ambiente arquivado (restaura todas as versões desse ambiente)

az ml environment restore --name my-env --resource-group my-resource-group --workspace-name my-workspace

Restaurar uma versão específica do ambiente arquivado

az ml environment restore --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

Parâmetros Obrigatórios

--name -n

Nome do ambiente.

Parâmetros Opcionais

--label -l

Etiqueta do ambiente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do ambiente.

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment share

Compartilhe um ambiente específico do espaço de trabalho para o registro.

Copie um ambiente existente de um espaço de trabalho para um registro para reutilização entre espaços de trabalho.

az ml environment share --name
                        --registry-name
                        --share-with-name
                        --share-with-version
                        --version
                        [--resource-group]
                        [--workspace-name]

Exemplos

Compartilhar um ambiente existente do espaço de trabalho para o registro

az ml environment share --name my-environment --version my-version --resource-group my-resource-group --workspace-name my-workspace --share-with-name new-name-in-registry --share-with-version new-version-in-registry --registry-name my-registry

Parâmetros Obrigatórios

--name -n

Nome do ambiente.

--registry-name

Registo de destino.

--share-with-name

Nome do ambiente a ser criado.

--share-with-version

Versão do ambiente a ser criado.

--version -v

Versão do ambiente.

Parâmetros Opcionais

--resource-group -g

o 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment show

Mostrar detalhes de um ambiente.

az ml environment show --name
                       [--label]
                       [--registry-name]
                       [--resource-group]
                       [--version]
                       [--workspace-name]

Exemplos

Mostrar detalhes de um ambiente com o nome e a versão especificados

az ml environment show --name my-env --version 1 --resource-group my-resource-group --workspace-name my-workspace

Mostrar detalhes de um ambiente no Registro com o nome e a versão especificados

az ml environment show --name my-env --version 1 --registry-name my-registry-name --resource-group my-resource-group

Parâmetros Obrigatórios

--name -n

Nome do ambiente.

Parâmetros Opcionais

--label -l

Etiqueta do ambiente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--resource-group -g

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

--version -v

Versão do ambiente.

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az ml environment update

Atualize um ambiente.

Apenas as propriedades 'description' e 'tags' podem ser atualizadas.

az ml environment update --name
                         [--add]
                         [--force-string]
                         [--label]
                         [--registry-name]
                         [--remove]
                         [--resource-group]
                         [--set]
                         [--version]
                         [--workspace-name]

Parâmetros Obrigatórios

--name -n

Nome do ambiente.

Parâmetros Opcionais

--add

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

valor predefinido: []
--force-string

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

valor predefinido: False
--label -l

Etiqueta do ambiente.

--registry-name

Se fornecido, o comando terá como alvo o registro em vez de um espaço de trabalho. Portanto, o grupo de recursos e o espaço de trabalho não serão necessários.

--remove

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

valor predefinido: []
--resource-group -g

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

--set

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

valor predefinido: []
--version -v

Versão do ambiente.

--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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.