Environment Classe

Referência

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

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

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

Construtor de Ambiente de Classe.

Herança: azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement

Environment

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, confira Criar e gerenciar ambientes reutilizáveis.

Comentários

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

Há várias maneiras de criar o ambiente no Azure Machine Learning, inclusive quando você:

Inicializa um novo objeto Ambiente.
Use um dos métodos da classe Ambiente: from_conda_specification, from_pip_requirements ou from_existing_conda_environment.
Use o método submit da classe Experiment para enviar um experimento executado sem especificar um ambiente, inclusive com um objeto Estimator.

O exemplo a seguir mostra como instanciar um novo ambiente.


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

Você pode gerenciar um ambiente registrando-o. Isso permitirá acompanhar as versões do ambiente e reutilizá-las em execuções futuras.


   myenv.register(workspace=ws)

Para obter mais exemplos de trabalho com ambientes, consulte o Jupyter Notebook Usar ambientes.

Variáveis

Nome	Description
Environment.databricks	A seção configura as dependências da biblioteca azureml.core.databricks.DatabricksSection.
docker	DockerSection Essa seção define as configurações relacionadas à imagem final do Docker compilada de acordo com as especificações do ambiente, e se os contêineres do Docker deverão ser usados para compilar o ambiente.
inferencing_stack_version	string Essa 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 Essa seção especifica qual ambiente e interpretador Python usar na computação de destino.
spark	SparkSection A seção define as configurações do Spark. Ela só é usada quando a estrutura é definida como PySpark.
r	RSection Esta seção especifica qual ambiente do R usar na computação de destino.
version	string A versão do ambiente.
asset_id	string ID do ativo. Preenche quando um ambiente é registrado.

Métodos

add_private_pip_wheel	Upload do arquivo de roda de pip privado no disco para o blob de armazenamento do Azure anexado ao workspace. Lança uma exceção se uma roda de pip privada com o mesmo nome já existir no blob de armazenamento do workspace.
build	Compila uma imagem do Docker para esse ambiente na nuvem.
build_local	Compila o ambiente local do Docker ou do Conda.
clone	Clona o objeto de ambiente. Retorna uma nova instância do objeto de ambiente com um novo nome.
from_conda_specification	Cria 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 Gerenciar ambientes no guia do usuário do Conda.
from_docker_build_context	Crie um objeto de ambiente com base em um contexto de build do Docker.
from_docker_image	Cria um objeto ambiente a partir de uma imagem base do Docker com dependências do Python opcionais. A camada 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 de um Dockerfile com dependenies opcionais do Python. A camada 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	Cria um objeto de ambiente criado a partir de um ambiente do Conda existente localmente. Para obter uma lista de ambientes do Conda existentes, execute `conda env list`. Para obter mais informações, consulte Gerenciar ambientes no guia do usuário do Conda.
from_pip_requirements	Cria um objeto de ambiente criado a partir de um arquivo de requisitos de pip. A dependência de pip não fixada será adicionada se pip_version não for especificado.
get	Retorna o objeto ambiente. Se o rótulo estiver especificado, o objeto previamente rotulado com o valor retornará. Apenas um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto Ambiente retornará.
get_image_details	Retorna os detalhes da Imagem.
label	Rotula o objeto Ambiente no workspace com os valores especificados.
list	Retorna um dicionário que contém ambientes no workspace.
load_from_directory	Carrega uma definição de ambiente dos arquivos em um diretório.
register	Registra o objeto Ambiente no workspace.
save_to_directory	Salva uma definição de ambiente em um diretório em um formato facilmente editável.

add_private_pip_wheel

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

Lança uma exceção se uma roda de 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 de pip privado.
file_path Obrigatório	str Caminho para a roda de pip local no disco, incluindo a extensão de arquivo.
exist_ok	bool Indica se é preciso lançar uma exceção, se a roda já existir. Valor padrão: False

Retornos

Tipo	Description
str	Retorna o URI completo para a roda de pip carregada no armazenamento de blobs do Azure para usar em dependências de conda.

build

Compila 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 da imagem ocorrerá Valor padrão: None

Retornos

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

build_local

Compila 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 de 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 contínua do Docker ou Co conda para o console.

Comentários

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

Compilar ambiente do Conda local


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

Compilar ambiente do Docker local


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

Compilar a imagem do Docker localmente e, opcionalmente, enviar por push para o registro de contêiner associado 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

Clona 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

Cria 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 Gerenciar 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 de especificação do ambiente do Conda.

Retornos

Tipo	Description
Environment	O objeto ambiente.

from_docker_build_context

Crie um objeto de ambiente com base em 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 ambiente.

from_docker_image

Cria um objeto ambiente a partir de uma imagem base do Docker com dependências do Python opcionais.

A camada 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 do 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 de pip. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto 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 de um Dockerfile com dependenies opcionais do Python.

A camada 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 do Dockerfile ou caminho para o arquivo.
conda_specification	str arquivo de especificação do Conda. Valor padrão: None
pip_requirements	str arquivo de requisitos de pip. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto ambiente.

from_existing_conda_environment

Cria um objeto de ambiente criado a partir de um ambiente do Conda existente localmente.

Para obter uma lista de ambientes do 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 do Conda existente localmente.

Retornos

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

from_pip_requirements

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

A dependência de pip não fixada 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 de pip.
pip_version	str Versão de pip para o ambiente do Conda. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto ambiente.

get

Retorna o objeto ambiente.

Se o rótulo estiver especificado, o objeto previamente rotulado com o valor retornará. Apenas um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto Ambiente retornará.

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 retornada. Valor padrão: None
label	str Valor do rótulo do ambiente. Valor padrão: None

Retornos

Tipo	Description
Environment	O objeto ambiente.

get_image_details

Retorna 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 dict

label

Rotula o objeto Ambiente no workspace com os valores especificados.

static label(workspace, name, version, labels)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O espaço de trabalho
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

list

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

static list(workspace)

Parâmetros

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

Retornos

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

load_from_directory

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

static load_from_directory(path)

Parâmetros

Nome	Description
path Obrigatório	str O caminho do diretório de origem.

register

Registra o objeto Ambiente no workspace.

register(workspace)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O espaço de trabalho
name Obrigatório	str

Retornos

Tipo	Description
Environment	Retorna o objeto Ambiente

save_to_directory

Salva 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 Especifica um caminho para o diretório de destino.
overwrite	bool Se um diretório existente deverá ser substituído. O padrão é false. Valor padrão: False

Atributos

environment_variables

Use o objeto azureml.core.RunConfiguration para definir variáveis de tempo de execução.

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

Recursos adicionais