Environment Classe

Configura um ambiente 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 usados 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 versionado em um Aprendizado Workspacede Máquina do Azure. Você pode atualizar um ambiente existente e recuperar uma versão para reutilizar. Os ambientes são exclusivos do espaço de trabalho em que são criados e não podem ser usados em espaços de trabalho diferentes.

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

Construtor Class Environment.

Construtor

Environment(name, **kwargs)

Parâmetros

Name	Description
name Necessá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 com curadoria. Para obter mais informações sobre ambientes com curadoria, consulte Criar e gerenciar ambientes reutilizáveis.

Observações

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

Há várias maneiras pelas quais o ambiente é criado no Aprendizado de Máquina do Azure, inclusive quando você:

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

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 permite rastrear 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 Usando ambientes.

Variáveis

Name	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 de acordo com 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 a adição de uma pilha de inferência, não defina esse valor. Valor válido: "mais recente".
python	PythonSection Esta seção especifica qual ambiente Python e interpretador usar na computação de destino.
spark	SparkSection A seção define as configurações do Spark. Ele só é usado quando a estrutura está 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. Preenche quando um ambiente é registrado.

Métodos

add_private_pip_wheel	Carregue o arquivo pip wheel privado no disco para o blob de armazenamento do Azure anexado ao espaço de trabalho. Lança uma exceção se uma roda pip privada com o mesmo nome já existir no blob de armazenamento do espaço de trabalho.
build	Crie uma imagem do Docker para esse ambiente na nuvem.
build_local	Crie o Docker local ou o ambiente 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 compilação do Docker.
from_docker_image	Crie um objeto de ambiente a partir de uma imagem docker base com dependências python opcionais. A camada Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements excluem-se mutuamente.
from_dockerfile	Crie um objeto de ambiente a partir de um Dockerfile com dependências python opcionais. A camada Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements excluem-se mutuamente.
from_existing_conda_environment	Crie um objeto de ambiente criado a partir de um ambiente conda existente localmente. Para obter uma lista de ambientes conda existentes, execute `conda env list`. Para obter mais informações, consulte Gerenciando 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 não fixada será adicionada se pip_version não for especificado.
get	Retornar o objeto de ambiente. Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Apenas 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 espaço de trabalho com os valores especificados.
list	Retornar um dicionário contendo ambientes no espaço de trabalho.
load_from_directory	Carregue uma definição de ambiente dos arquivos em um diretório.
register	Registre o objeto de ambiente em seu espaço de trabalho.
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 pip wheel privado no disco para o blob de armazenamento do Azure anexado ao espaço de trabalho.

Lança uma exceção se uma roda pip privada com o mesmo nome já existir no blob de armazenamento do espaço de trabalho.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parâmetros

Name	Description
workspace Necessário	Workspace O objeto de espaço de trabalho a ser usado para registrar a roda pip privada.
file_path Necessário	str Caminho para a roda pip local no disco, incluindo a extensão do arquivo.
exist_ok	bool Indica se uma exceção deve ser lançada se a roda já existir. Default value: False

Devoluções

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

build

Crie uma imagem do Docker para esse ambiente na nuvem.

build(workspace, image_build_compute=None)

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho e seu Registro de Contêiner do Azure associado onde a imagem está armazenada.
image_build_compute	str O nome de computação onde a compilação da imagem ocorrerá Default value: None

Devoluções

Tipo	Description
ImageBuildDetails	Retorna o objeto de detalhes da compilação da imagem.

build_local

Crie o Docker local ou o ambiente conda.

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

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho.
platform	str Plataforma. Um de Linux, Windows ou OSX. A plataforma atual será usada por padrão. Default value: None
kwargs Necessário	dict Argumentos avançados de palavras-chave

Devoluções

Tipo	Description
str	Transmite a saída contínua do Docker ou conda built para o console.

Observações

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

Construa um ambiente de conda local


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

Crie um 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)

Crie a imagem do docker localmente e, opcionalmente, envie-a por push para o registro de contêiner associado ao espaço de trabalho


   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

Name	Description
new_name Necessário	str Novo nome do ambiente

Devoluções

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

Name	Description
name Necessário	str O nome do ambiente.
file_path Necessário	str O caminho do arquivo YAML de especificação do ambiente conda.

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

from_docker_build_context

Crie um objeto de ambiente a partir de um contexto de compilação do Docker.

static from_docker_build_context(name, docker_build_context)

Parâmetros

Name	Description
name Necessário	str O nome do ambiente.
docker_build_context Necessário	DockerBuildContext O objeto DockerBuildContext.

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

from_docker_image

Crie um objeto de ambiente a partir de uma imagem docker base com dependências python opcionais.

A camada Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements excluem-se mutuamente.

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

Parâmetros

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

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

Observações

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

from_dockerfile

Crie um objeto de ambiente a partir de um Dockerfile com dependências python opcionais.

A camada Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements excluem-se mutuamente.

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

Parâmetros

Name	Description
name Necessário	str O nome do ambiente.
dockerfile Necessário	str Conteúdo do Dockerfile ou caminho para o arquivo.
conda_specification	str arquivo de especificação conda. Default value: None
pip_requirements	str arquivo de requisitos pip. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

from_existing_conda_environment

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

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

static from_existing_conda_environment(name, conda_environment_name)

Parâmetros

Name	Description
name Necessário	str O nome do ambiente.
conda_environment_name Necessário	str O nome de um ambiente de conda existente localmente.

Devoluções

Tipo	Description
Environment	O objeto de ambiente ou None 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 não fixada será adicionada se pip_version não for especificado.

static from_pip_requirements(name, file_path, pip_version=None)

Parâmetros

Name	Description
name Necessário	str O nome do ambiente.
file_path Necessário	str O caminho do arquivo de requisitos pip.
pip_version	str Versão Pip para ambiente conda. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

get

Retornar o objeto de ambiente.

Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Apenas 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

Name	Description
workspace Necessário	Workspace O espaço de trabalho que contém o ambiente.
name Necessário	str O nome do ambiente a ser retornado.
version	str A versão do ambiente a retornar. Default value: None
label	str Valor do rótulo do ambiente. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

get_image_details

Retorne os detalhes da imagem.

get_image_details(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho.

Devoluções

Tipo	Description
DockerImageDetails	Devolve os detalhes da imagem como ditado

label

Rotule o objeto de ambiente em seu espaço de trabalho com os valores especificados.

static label(workspace, name, version, labels)

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho
name Necessário	str Nome do ambiente
version Necessário	str Versão do ambiente
labels Necessário	list[str] Valores para rotular Ambiente com

list

Retornar um dicionário contendo ambientes no espaço de trabalho.

static list(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho a partir do qual listar ambientes.

Devoluções

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

Name	Description
path Necessário	str Caminho para o diretório de origem.

register

Registre o objeto de ambiente em seu espaço de trabalho.

register(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace O espaço de trabalho
name Necessário	str

Devoluções

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

Name	Description
path Necessário	str Caminho para o diretório de destino.
overwrite	bool Se um diretório existente deve ser substituído. O padrão false. Default value: False

Atributos

environment_variables

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

Feedback

Esta página foi útil?

Partilhar via

Environment Classe

Construtor

Parâmetros

Observações

Variáveis

Métodos

add_private_pip_wheel

Parâmetros

Devoluções

build

Parâmetros

Devoluções

build_local

Parâmetros

Devoluções

Observações

clone

Parâmetros

Devoluções

from_conda_specification

Parâmetros

Devoluções

from_docker_build_context

Parâmetros

Devoluções

from_docker_image

Parâmetros

Devoluções

Observações

from_dockerfile

Parâmetros

Devoluções

from_existing_conda_environment

Parâmetros

Devoluções

from_pip_requirements

Parâmetros

Devoluções

get

Parâmetros

Devoluções

get_image_details

Parâmetros

Devoluções

label

Parâmetros

list

Parâmetros

Devoluções

load_from_directory

Parâmetros

register

Parâmetros

Devoluções

save_to_directory

Parâmetros

Atributos

environment_variables

Feedback