Compartilhar via

az ml environment

Note

Essa referência faz parte da extensão ml da CLI do Azure (versão 2.15.0 ou superior). A extensão instalará 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

Nome Description Tipo Status
az ml environment archive

Arquivar um ambiente.

 Extension GA
az ml environment create

Criar um ambiente.

 Extension GA
az ml environment list

Listar ambientes em um espaço de trabalho.

 Extension GA
az ml environment restore

Restaure um ambiente arquivado.

 Extension GA
az ml environment share

Compartilhe um ambiente específico do workspace para o registro.

 Extension GA
az ml environment show

Mostrar detalhes de um ambiente.

 Extension GA
az ml environment update

Atualize um ambiente.

 Extension GA

az ml environment archive

Arquivar um ambiente.

O arquivamento de um ambiente irá ocultá-lo por padrão em consultas de lista ( az ml environment list ). Você ainda pode continuar a referenciar e usar um ambiente Arquivado em seus fluxos de trabalho. É possível arquivar um contêiner de ambiente ou uma versão de ambiente específica. O arquivamento de um contêiner de ambiente arquivará todas as versões do ambiente sob o nome fornecido. Você pode restaurar um ambiente arquivado usando az ml environment restoreo . Se todo o contêiner do ambiente estiver arquivado, você não poderá restaurar versões individuais do ambiente - você precisará 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 Exigidos

--name -n

Nome do ambiente.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--label -l

Rótulo do ambiente.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

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 workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 workspace com 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 com base em 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 com base em 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 build

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 com base em uma especificação do 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--build-context -b

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

--conda-file -c

Caminho local para um arquivo de especificação do Conda. --image/-i também deve ser especificado se esse 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 no diretório especificado por --build-context/-b. Se omitido, './Dockerfile' será usado.

Propriedade Valor
Valor padrão: /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 yaml para o 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 aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
--os-type

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

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

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.

--tags

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

--version -v

Versão do ambiente.

--workspace-name -w

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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 workspace

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 workspace

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

Liste todos os ambientes em um workspace 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--archived-only

Listar apenas ambientes arquivados.

Propriedade Valor
Valor padrão: False
--include-archived

Listar ambientes arquivados e ambientes ativos.

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

Número máximo de resultados a serem retornados.

--name -n

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

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--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 workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ml environment restore

Restaure um ambiente arquivado.

Quando um ambiente arquivado for 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 com esse nome. Não será possível restaurar apenas uma versão de ambiente específica se todo o contêiner de ambiente for arquivado - você precisará restaurar todo o contêiner. 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 Exigidos

--name -n

Nome do ambiente.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--label -l

Rótulo do ambiente.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

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 workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ml environment share

Compartilhe um ambiente específico do workspace para o registro.

Copie um ambiente existente de um workspace para um registro para reutilização entre workspaces.

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

Exemplos

Compartilhar um ambiente existente do workspace 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 Exigidos

--name -n

Nome do ambiente.

--registry-name

Registro de destino.

--share-with-name

Nome do ambiente com o qual será criado.

--share-with-version

Versão do ambiente com o qual será criado.

--version -v

Versão do ambiente.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

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

--name -n

Nome do ambiente.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--label -l

Rótulo do ambiente.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--resource-group -g

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 workspace do Azure ML. Você pode configurar o workspace padrão usando az configure --defaults workspace=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az ml environment update

Atualize um ambiente.

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

--name -n

Nome do ambiente.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: False
--label -l

Rótulo do ambiente.

--registry-name

Se fornecido, o comando terá como destino o registro em vez de um workspace. Portanto, o grupo de recursos e o workspace não serão necessários.

--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--version -v

Versão do ambiente.

--workspace-name -w

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False