Environment Classe

Configura um ambiente python reproduzível para experimentos de aprendizado de máquina.

Um ambiente define pacotes do Python, variáveis de ambiente e configurações do Docker que são usadas em experimentos de aprendizado de máquina, incluindo preparação de dados, treinamento e implantação em um serviço Web. Um ambiente é gerenciado e com versão em um Azure Machine Learning Workspace. Você pode atualizar um ambiente existente e recuperar uma versão para reutilização. Os ambientes são exclusivos para o workspace no qual são criados e não podem ser usados em workspaces diferentes.

Para obter mais informações sobre ambientes, consulte Criar e gerenciar ambientes reutilizáveis.

Construtor de ambiente de classe.

Construtor

Environment(name, **kwargs)

Parâmetros

Nome	Description
name Obrigatório	string O nome do ambiente. Observação Não inicie o nome do ambiente com "Microsoft" ou "AzureML". Os prefixos "Microsoft" e "AzureML" são reservados para ambientes coletados. Para obter mais informações sobre ambientes coletados, consulte Criar e gerenciar ambientes reutilizáveis.

Comentários

O Azure Machine Learning fornece ambientes coletados, que são ambientes predefinidos que oferecem bons pontos de partida para a criação de seus próprios ambientes. Os ambientes coletados são apoiados por imagens do Docker armazenadas em cache, fornecendo um custo de preparação de execução reduzido. Para obter mais informações sobre ambientes coletados, consulte Criar e gerenciar ambientes reutilizáveis.

Há várias maneiras pelas quais o ambiente é criado no Azure Machine Learning, incluindo quando você:

Inicialize um novo objeto Environment.
Use um dos métodos da classe Environment: from_conda_specification, from_pip_requirementsou from_existing_conda_environment.
Use o submit método da classe Experiment para enviar uma execução de experimento sem especificar um ambiente, inclusive com um Estimator objeto.

O exemplo a seguir mostra como criar uma instância de um novo ambiente.


   from azureml.core import Environment
   myenv = Environment(name="myenv")

Você pode gerenciar um ambiente registrando-o. Isso permite que você acompanhe as versões do ambiente e reutilize-as em execuções futuras.


   myenv.register(workspace=ws)

Para obter mais exemplos de como trabalhar com ambientes, consulte o Jupyter Notebook usando ambientes.

Variáveis

Nome	Description
Environment.databricks	A seção configura as dependências da biblioteca azureml.core.databricks.DatabricksSection.
docker	DockerSection Esta seção define as configurações relacionadas à imagem final do Docker criada para as especificações do ambiente e se os contêineres do Docker devem ser usados para criar o ambiente.
inferencing_stack_version	string Esta seção especifica a versão da pilha de inferência adicionada à imagem. Para evitar adicionar uma pilha de inferência, não defina esse valor. Valor válido: "latest".
python	PythonSection Esta seção especifica qual ambiente e interpretador do Python usar na computação de destino.
spark	SparkSection A seção define as configurações do Spark. Ele só é usado quando a estrutura é definida como PySpark.
r	RSection Esta seção especifica qual ambiente R usar na computação de destino.
version	string A versão do ambiente.
asset_id	string ID do ativo. Popula quando um ambiente é registrado.

Métodos

add_private_pip_wheel	Carregue o arquivo de roda pip privado no disco para o blob de armazenamento do Azure anexado ao workspace. Gera uma exceção se uma roda pip privada com o mesmo nome já existir no blob de armazenamento do workspace.
build	Crie uma imagem do Docker para esse ambiente na nuvem.
build_local	Crie o ambiente local do Docker ou do Conda.
clone	Clone o objeto de ambiente. Retorna uma nova instância do objeto de ambiente com um novo nome.
from_conda_specification	Crie um objeto de ambiente a partir de um arquivo YAML de especificação de ambiente. Para obter um arquivo YAML de especificação de ambiente, consulte Gerenciando ambientes no guia do usuário do Conda.
from_docker_build_context	Crie um objeto de ambiente a partir de um contexto de build do Docker.
from_docker_image	Crie um objeto de ambiente a partir de uma imagem base do Docker com dependenies de python opcionais. A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements são mutuamente exclusivos.
from_dockerfile	Crie um objeto de ambiente a partir de um Dockerfile com dependenies de python opcionais. A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements são mutuamente exclusivos.
from_existing_conda_environment	Crie um objeto de ambiente criado a partir de um ambiente conda localmente existente. Para obter uma lista de ambientes conda existentes, execute `conda env list`. Para obter mais informações, consulte Gerenciar ambientes no guia do usuário do Conda.
from_pip_requirements	Crie um objeto de ambiente criado a partir de um arquivo de requisitos pip. A dependência de pip desafixada será adicionada se pip_version não for especificado.
get	Retorne o objeto de ambiente. Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Somente um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos forem perdidos, a versão mais recente do objeto Environment será retornada.
get_image_details	Retorne os detalhes da imagem.
label	Rotule o objeto de ambiente em seu workspace com os valores especificados.
list	Retornar um dicionário que contém ambientes no workspace.
load_from_directory	Carregue uma definição de ambiente dos arquivos em um diretório.
register	Registre o objeto de ambiente em seu workspace.
save_to_directory	Salve uma definição de ambiente em um diretório em um formato facilmente editável.

add_private_pip_wheel

Carregue o arquivo de roda pip privado no disco para o blob de armazenamento do Azure anexado ao workspace.

Gera uma exceção se uma roda pip privada com o mesmo nome já existir no blob de armazenamento do workspace.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O objeto de workspace a ser usado para registrar a roda pip privada.
file_path Obrigatório	str Caminho para a roda pip local no disco, incluindo a extensão de arquivo.
exist_ok	bool Indica se uma exceção deve ser gerada se a roda já existir. Valor padrão: False

Retornos

Tipo	Description
str	Retorna o URI completo para a roda pip carregada no armazenamento de blobs do Azure a ser usado nas dependências do Conda.

build

Crie uma imagem do Docker para esse ambiente na nuvem.

build(workspace, image_build_compute=None)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace e seu Registro de Contêiner do Azure associado onde a imagem é armazenada.
image_build_compute	str O nome da computação em que o build de imagem ocorrerá Valor padrão: None

Retornos

Tipo	Description
ImageBuildDetails	Retorna o objeto de detalhes do build da imagem.

build_local

Crie o ambiente local do Docker ou do Conda.

build_local(workspace, platform=None, **kwargs)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace.
platform	str Plataforma. Um dos Linux, Windows ou OSX. A plataforma atual será usada por padrão. Valor padrão: None
kwargs Obrigatório	dict Argumentos de palavra-chave avançados

Retornos

Tipo	Description
str	Transmite a saída interna do Docker ou do Conda criada para o console.

Comentários

Os exemplos a seguir mostram como criar um ambiente local. Verifique se o workspace está instanciado como um objeto azureml.core.workspace.Workspace válido

Criar ambiente conda local


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace)

Criar ambiente local do Docker


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True)

Criar imagem do Docker localmente e, opcionalmente, efetuá-la por push para o registro de contêiner associado ao workspace


   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True, pushImageToWorkspaceAcr=True)

clone

Clone o objeto de ambiente.

Retorna uma nova instância do objeto de ambiente com um novo nome.

clone(new_name)

Parâmetros

Nome	Description
new_name Obrigatório	str Novo nome do ambiente

Retornos

Tipo	Description
Environment	Novo objeto de ambiente

from_conda_specification

Crie um objeto de ambiente a partir de um arquivo YAML de especificação de ambiente.

Para obter um arquivo YAML de especificação de ambiente, consulte Gerenciando ambientes no guia do usuário do Conda.

static from_conda_specification(name, file_path)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
file_path Obrigatório	str O caminho do arquivo YAML da especificação do ambiente conda.

Retornos

Tipo	Description
Environment	O objeto de ambiente.

from_docker_build_context

Crie um objeto de ambiente a partir de um contexto de build do Docker.

static from_docker_build_context(name, docker_build_context)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
docker_build_context Obrigatório	DockerBuildContext O objeto DockerBuildContext.

Retornos

Tipo	Description
Environment	O objeto de ambiente.

from_docker_image

Crie um objeto de ambiente a partir de uma imagem base do Docker com dependenies de python opcionais.

A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements são mutuamente exclusivos.

static from_docker_image(name, image, container_registry=None, conda_specification=None, pip_requirements=None)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
image Obrigatório	str nome de imagem totalmente qualificado.
conda_specification	str arquivo de especificação conda. Valor padrão: None
container_registry	ContainerRegistry detalhes do repositório de contêiner privado. Valor padrão: None
pip_requirements	str arquivo de requisitos pip. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto de ambiente.

Comentários

Se a imagem base for do repositório privado que requer autorização e a autorização não estiver definida no nível do workspace do AzureML, container_registry será necessário

from_dockerfile

Crie um objeto de ambiente a partir de um Dockerfile com dependenies de python opcionais.

A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements são mutuamente exclusivos.

static from_dockerfile(name, dockerfile, conda_specification=None, pip_requirements=None)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
dockerfile Obrigatório	str Conteúdo ou caminho do Dockerfile para o arquivo.
conda_specification	str arquivo de especificação conda. Valor padrão: None
pip_requirements	str arquivo de requisitos pip. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto de ambiente.

from_existing_conda_environment

Crie um objeto de ambiente criado a partir de um ambiente conda localmente existente.

Para obter uma lista de ambientes conda existentes, execute conda env list. Para obter mais informações, consulte Gerenciar ambientes no guia do usuário do Conda.

static from_existing_conda_environment(name, conda_environment_name)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
conda_environment_name Obrigatório	str O nome de um ambiente conda localmente existente.

Retornos

Tipo	Description
Environment	O objeto de ambiente ou Nenhum se a exportação do arquivo de especificação conda falhar.

from_pip_requirements

Crie um objeto de ambiente criado a partir de um arquivo de requisitos pip.

A dependência de pip desafixada será adicionada se pip_version não for especificado.

static from_pip_requirements(name, file_path, pip_version=None)

Parâmetros

Nome	Description
name Obrigatório	str O nome do ambiente.
file_path Obrigatório	str O caminho do arquivo de requisitos pip.
pip_version	str Versão do Pip para o ambiente conda. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto de ambiente.

get

Retorne o objeto de ambiente.

Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Somente um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos forem perdidos, a versão mais recente do objeto Environment será retornada.

static get(workspace, name, version=None, label=None)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace que contém o ambiente.
name Obrigatório	str O nome do ambiente a ser retornado.
version	str A versão do ambiente a ser retornado. Valor padrão: None
label	str Valor do rótulo do ambiente. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto de ambiente.

get_image_details

Retorne os detalhes da imagem.

get_image_details(workspace)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace.

Retornos

Tipo	Description
DockerImageDetails	Retorna os detalhes da imagem como ditado

label

Rotule o objeto de ambiente em seu workspace com os valores especificados.

static label(workspace, name, version, labels)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace
name Obrigatório	str Nome do ambiente
version Obrigatório	str Versão do ambiente
labels Obrigatório	list[str] Valores para rotular o Ambiente com

list

Retornar um dicionário que contém ambientes no workspace.

static list(workspace)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace do qual listar ambientes.

Retornos

Tipo	Description
<xref:builtin.dict>[str, Environment]	Um dicionário de objetos de ambiente.

load_from_directory

Carregue uma definição de ambiente dos arquivos em um diretório.

static load_from_directory(path)

Parâmetros

Nome	Description
path Obrigatório	str Caminho para o diretório de origem.

register

Registre o objeto de ambiente em seu workspace.

register(workspace)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace
name Obrigatório	str

Retornos

Tipo	Description
Environment	Retorna o objeto de ambiente

save_to_directory

Salve uma definição de ambiente em um diretório em um formato facilmente editável.

save_to_directory(path, overwrite=False)

Parâmetros

Nome	Description
path Obrigatório	str Caminho para o diretório de destino.
overwrite	bool Se um diretório existente deve ser substituído. O padrão é false. Valor padrão: False

Compartilhar via

Environment Classe

Construtor

Parâmetros

Comentários

Variáveis

Métodos

add_private_pip_wheel

Parâmetros

Retornos

build

Parâmetros

Retornos

build_local

Parâmetros

Retornos

Comentários

clone

Parâmetros

Retornos

from_conda_specification

Parâmetros

Retornos

from_docker_build_context

Parâmetros

Retornos

from_docker_image

Parâmetros

Retornos

Comentários

from_dockerfile

Parâmetros

Retornos

from_existing_conda_environment

Parâmetros

Retornos

from_pip_requirements

Parâmetros

Retornos

get

Parâmetros

Retornos

get_image_details

Parâmetros

Retornos

label

Parâmetros

list

Parâmetros

Retornos

load_from_directory

Parâmetros

register

Parâmetros

Retornos

save_to_directory

Parâmetros

Atributos

environment_variables

Comentários