Environment Classe

Referência

Configura um ambiente Python reproduzível para experimentações de machine learning.

Um Ambiente define pacotes Python, variáveis de ambiente e definições do Docker que são utilizadas em experimentações de machine learning, incluindo na preparação, preparação e implementação de dados num serviço Web. Um Ambiente é gerido e tem um controlo de versão num Azure Machine Learning Workspace. Pode atualizar um ambiente existente e obter uma versão para reutilizar. Os ambientes são exclusivos da área de trabalho em que são criados e não podem ser utilizados em diferentes áreas de trabalho.

Para obter mais informações sobre ambientes, veja Criar e gerir 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

Name	Description
name Necessário	string O nome do ambiente. Nota Não inicie o nome do ambiente com "Microsoft" ou "AzureML". Os prefixos "Microsoft" e "AzureML" estão reservados para ambientes organizados. Para obter mais informações sobre ambientes organizados, veja Criar e gerir ambientes reutilizáveis.

Observações

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

Existem várias formas de criar o ambiente no Azure Machine Learning, incluindo quando:

Inicializar um novo objeto de Ambiente.
Utilize um dos métodos de classe Ambiente: from_conda_specification, from_pip_requirementsou from_existing_conda_environment.
Utilize o submit método da classe Experimentação para submeter uma execução de experimentação sem especificar um ambiente, incluindo com um Estimator objeto.

O exemplo seguinte mostra como instanciar um novo ambiente.


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

Pode gerir um ambiente ao registá-lo. Ao fazê-lo, pode controlar as versões do ambiente e reutilizá-las em execuções futuras.


   myenv.register(workspace=ws)

Para obter mais exemplos de trabalho com ambientes, veja o Jupyter Notebook Utilizar ambientes.

Variáveis

Name	Description
Environment.databricks	A secção configura as dependências da biblioteca azureml.core.databricks.DatabricksSection.
docker	DockerSection Esta secção configura as definições relacionadas com a imagem final do Docker criada com base nas especificações do ambiente e se pretende utilizar contentores do Docker para criar o ambiente.
inferencing_stack_version	string Esta secção especifica a versão da pilha de inferência adicionada à imagem. Para evitar adicionar uma pilha de inferência, não defina este valor. Valor válido: "mais recente".
python	PythonSection Esta secção especifica o ambiente python e o interpretador a utilizar na computação de destino.
spark	SparkSection A secção configura as definições do Spark. Só é utilizado quando a arquitetura está definida como PySpark.
r	RSection Esta secção especifica o ambiente R a utilizar na computação de destino.
version	string A versão do ambiente.
asset_id	string ID do Recurso. Preenche quando um ambiente é registado.

Métodos

add_private_pip_wheel	Carregue o ficheiro de roda pip privado no disco para o blob de armazenamento do Azure anexado à área de trabalho. Gera uma exceção se já existir uma roda pip privada com o mesmo nome no blob de armazenamento da área de trabalho.
build	Crie uma imagem do Docker para este ambiente na cloud.
build_local	Crie o ambiente local do Docker ou conda.
clone	Clone o objeto de ambiente. Devolve uma nova instância de objeto de ambiente com um novo nome.
from_conda_specification	Crie um objeto de ambiente a partir de um ficheiro YAML de especificação de ambiente. Para obter um ficheiro YAML de especificação de ambiente, veja Gerir ambientes no guia de utilizador 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 de docker base com dependenies de 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 a partir de um Dockerfile com dependenies de 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_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, veja Managing environments in the conda user guide ( Gerir ambientes no guia de utilizador conda).
from_pip_requirements	Crie um objeto de ambiente criado a partir de um ficheiro de requisitos pip. A dependência pip não suportada será adicionada se pip_version não for especificada.
get	Devolver o objeto de ambiente. Se a etiqueta for especificada, será devolvido o objeto anteriormente etiquetado com o valor. Só é possível especificar um dos parâmetros de versão ou etiqueta. Se ambos não tiverem sido apresentados, será devolvida a versão mais recente do objeto Ambiente.
get_image_details	Devolva os detalhes da Imagem.
label	Etiquetar objeto de ambiente na área de trabalho com os valores especificados.
list	Devolver um dicionário que contém ambientes na área de trabalho.
load_from_directory	Carregar uma definição de ambiente a partir dos ficheiros num diretório.
register	Registe o objeto de ambiente na área de trabalho.
save_to_directory	Guarde uma definição de ambiente num diretório num formato facilmente editável.

add_private_pip_wheel

Carregue o ficheiro de roda pip privado no disco para o blob de armazenamento do Azure anexado à área de trabalho.

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

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parâmetros

Name	Description
workspace Necessário	Workspace O objeto da área de trabalho a utilizar para registar a roda pip privada.
file_path Necessário	str Caminho para a roda pip local no disco, incluindo a extensão de ficheiro.
exist_ok	bool Indica se pretende lançar uma exceção se a roda já existir. Default value: False

Devoluções

Tipo	Description
str	Devolve o URI completo à roda de pip carregada no armazenamento de blobs do Azure para utilizar nas dependências de conda.

build

Crie uma imagem do Docker para este ambiente na cloud.

build(workspace, image_build_compute=None)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho e o respetivo Azure Container Registry associado onde a imagem é armazenada.
image_build_compute	str O nome da computação onde a compilação da imagem será realizada Default value: None

Devoluções

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

build_local

Crie o ambiente local do Docker ou conda.

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

Parâmetros

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

Devoluções

Tipo	Description
str	Transmite em fluxo a saída incorporada do Docker ou conda para a consola.

Observações

Os exemplos seguintes mostram como criar um ambiente local. Certifique-se de que a área de trabalho é instanciada como um objeto azureml.core.workspace.Workspace válido

Criar um ambiente conda local


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

Criar um ambiente de docker local


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

Crie uma imagem do Docker localmente e, opcionalmente, envie-a para o registo de contentor associado à área 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.

Devolve uma nova instância de 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 ficheiro YAML de especificação de ambiente.

Para obter um ficheiro YAML de especificação de ambiente, veja Gerir ambientes no guia de utilizador 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 de ficheiro YAML da 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 de docker base com dependenies de 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

Name	Description
name Necessário	str O nome do ambiente.
image Necessário	str nome de imagem completamente qualificado.
conda_specification	str ficheiro de especificação conda. Default value: None
container_registry	ContainerRegistry detalhes do repositório de contentor privado. Default value: None
pip_requirements	str ficheiro de requisitos pip. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

Observações

Se a imagem base for do repositório privado que requer autorização e a autorização não estiver definida ao nível da área de trabalho do AzureML, container_registry é necessária

from_dockerfile

Crie um objeto de ambiente a partir de um Dockerfile com dependenies de 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_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 ficheiro.
conda_specification	str ficheiro de especificação conda. Default value: None
pip_requirements	str ficheiro 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 localmente existente.

Para obter uma lista de ambientes conda existentes, execute conda env list. Para obter mais informações, veja Managing environments in the conda user guide ( Gerir ambientes no guia de utilizador 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 conda localmente existente.

Devoluções

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

from_pip_requirements

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

A dependência pip não suportada será adicionada se pip_version não for especificada.

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 ficheiro de requisitos pip.
pip_version	str Versão pip para o ambiente conda. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

get

Devolver o objeto de ambiente.

Se a etiqueta for especificada, será devolvido o objeto anteriormente etiquetado com o valor. Só é possível especificar um dos parâmetros de versão ou etiqueta. Se ambos não tiverem sido apresentados, será devolvida a versão mais recente do objeto Ambiente.

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

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho que contém o ambiente.
name Necessário	str O nome do ambiente a devolver.
version	str A versão do ambiente a devolver. Default value: None
label	str Valor da etiqueta de ambiente. Default value: None

Devoluções

Tipo	Description
Environment	O objeto de ambiente.

get_image_details

Devolva os detalhes da Imagem.

get_image_details(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho.

Devoluções

Tipo	Description
DockerImageDetails	Devolve os detalhes da imagem como ditado

label

Etiquetar objeto de ambiente na área de trabalho com os valores especificados.

static label(workspace, name, version, labels)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho
name Necessário	str Nome do ambiente
version Necessário	str Versão do ambiente
labels Necessário	list[str] Valores para etiquetar o Ambiente com

list

Devolver um dicionário que contém ambientes na área de trabalho.

static list(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho a partir da qual pretende listar ambientes.

Devoluções

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

load_from_directory

Carregar uma definição de ambiente a partir dos ficheiros num diretório.

static load_from_directory(path)

Parâmetros

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

register

Registe o objeto de ambiente na área de trabalho.

register(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace A área de trabalho
name Necessário	str

Devoluções

Tipo	Description
Environment	Devolve o objeto de ambiente

save_to_directory

Guarde uma definição de ambiente num diretório num 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 tiver de ser substituído. Predefinições falso. Default value: False

Atributos

environment_variables

Utilize o objeto azureml.core.RunConfiguration para definir variáveis de runtime.

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

Comentários

Recursos adicionais