Environment Classe

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
string
Necessário

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:

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

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

workspace
Workspace
Necessário

O objeto da área de trabalho a utilizar para registar a roda pip privada.

file_path
str
Necessário

Caminho para a roda pip local no disco, incluindo a extensão de ficheiro.

exist_ok
bool
valor predefinido: False

Indica se pretende lançar uma exceção se a roda já existir.

Devoluções

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

Tipo de retorno

str

build

Crie uma imagem do Docker para este ambiente na cloud.

build(workspace, image_build_compute=None)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho e o respetivo Azure Container Registry associado onde a imagem é armazenada.

image_build_compute
str
valor predefinido: None

O nome da computação onde a compilação da imagem será realizada

Devoluções

Devolve o objeto de detalhes da compilação da imagem.

Tipo de retorno

build_local

Crie o ambiente local do Docker ou conda.

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

Parâmetros

workspace
Workspace
Necessário

A área de trabalho.

platform
str
valor predefinido: None

Plataforma. Um de Linux, Windows ou OSX. A plataforma atual será utilizada por predefinição.

kwargs
dict
Necessário

Argumentos de palavras-chave avançadas

Devoluções

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

Tipo de retorno

str

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

new_name
str
Necessário

Novo nome do ambiente

Devoluções

Novo objeto de ambiente

Tipo de retorno

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
str
Necessário

O nome do ambiente.

file_path
str
Necessário

O caminho de ficheiro YAML da especificação do ambiente conda.

Devoluções

O objeto de ambiente.

Tipo de retorno

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
str
Necessário

O nome do ambiente.

docker_build_context
DockerBuildContext
Necessário

O objeto DockerBuildContext.

Devoluções

O objeto de ambiente.

Tipo de retorno

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
str
Necessário

O nome do ambiente.

image
str
Necessário

nome de imagem completamente qualificado.

conda_specification
str
valor predefinido: None

ficheiro de especificação conda.

container_registry
ContainerRegistry
valor predefinido: None

detalhes do repositório de contentor privado.

pip_requirements
str
valor predefinido: None

ficheiro de requisitos pip.

Devoluções

O objeto de ambiente.

Tipo de retorno

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
str
Necessário

O nome do ambiente.

dockerfile
str
Necessário

Conteúdo do Dockerfile ou caminho para o ficheiro.

conda_specification
str
valor predefinido: None

ficheiro de especificação conda.

pip_requirements
str
valor predefinido: None

ficheiro de requisitos pip.

Devoluções

O objeto de ambiente.

Tipo de retorno

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
str
Necessário

O nome do ambiente.

conda_environment_name
str
Necessário

O nome de um ambiente conda localmente existente.

Devoluções

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

Tipo de retorno

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
str
Necessário

O nome do ambiente.

file_path
str
Necessário

O caminho do ficheiro de requisitos pip.

pip_version
str
valor predefinido: None

Versão pip para o ambiente conda.

Devoluções

O objeto de ambiente.

Tipo de retorno

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

workspace
Workspace
Necessário

A área de trabalho que contém o ambiente.

name
str
Necessário

O nome do ambiente a devolver.

version
str
valor predefinido: None

A versão do ambiente a devolver.

label
str
valor predefinido: None

Valor da etiqueta de ambiente.

Devoluções

O objeto de ambiente.

Tipo de retorno

get_image_details

Devolva os detalhes da Imagem.

get_image_details(workspace)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho.

Devoluções

Devolve os detalhes da imagem como ditado

Tipo de retorno

label

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

static label(workspace, name, version, labels)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho

name
str
Necessário

Nome do ambiente

version
str
Necessário

Versão do ambiente

labels
list[str]
Necessário

Valores para etiquetar o Ambiente com

list

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

static list(workspace)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho a partir da qual pretende listar ambientes.

Devoluções

Um dicionário de objetos de ambiente.

Tipo de retorno

<xref:builtin.dict>[str, Environment]

load_from_directory

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

static load_from_directory(path)

Parâmetros

path
str
Necessário

Caminho para o diretório de origem.

register

Registe o objeto de ambiente na área de trabalho.

register(workspace)

Parâmetros

workspace
Workspace
Necessário

A área de trabalho

name
str
Necessário

Devoluções

Devolve o objeto de ambiente

Tipo de retorno

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

path
str
Necessário

Caminho para o diretório de destino.

overwrite
bool
valor predefinido: False

Se um diretório existente tiver de ser substituído. Predefinições falso.

Atributos

environment_variables

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