Ambiente Classe

Configura um ambiente python reprodutível para experiências de aprendizagem automática.

Um Ambiente define pacotes Python, variáveis ambientais e configurações de Docker que são usadas em experiências de machine learning, incluindo na preparação de dados, formação e implementação para um serviço web. Um Ambiente é gerido e versado numa Aprendizagem Automática Workspace Azure. 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 diferentes espaços de trabalho.

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

Herança
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Ambiente

Construtor

Environment(name, **kwargs)

Parâmetros

name
string

O nome do ambiente.

Nota

Não inicie o seu nome ambiental com "Microsoft" ou "AzureML". Os prefixos "Microsoft" e "AzureML" são reservados para ambientes com curadoria. Para obter mais informações sobre ambientes curados, consulte Criar e gerir ambientes reutilizáveis.

Observações

A Azure Machine Learning oferece ambientes curados, que são ambientes predefinidos que oferecem bons pontos de partida para a construção dos seus próprios ambientes. Os ambientes curados são apoiados por imagens em cache do Docker, proporcionando um custo de preparação de corrida reduzido. Para obter mais informações sobre ambientes curados, consulte Criar e gerir ambientes reutilizáveis.

Há várias formas de criar o ambiente na Aprendizagem Automática Azure, incluindo quando:

O exemplo a seguir mostra como instantaneamente um novo ambiente.


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

Você pode gerir um ambiente registando-o. Ao fazê-lo, permite-lhe acompanhar as versões do ambiente e reutilizá-las em futuras corridas.


   myenv.register(workspace=ws)

Para obter mais amostras de trabalho com ambientes, consulte o Caderno Jupyter Utilizando ambientes.

Variáveis

Environment.databricks

A secção configura as dependências da biblioteca azureml.core.databricks.DatabricksSection.

estivador
DockerSection

Esta secção configura as definições relacionadas com a imagem final do Docker construída de acordo com as especificações do ambiente e se deve utilizar recipientes Docker para construir o ambiente.

inferencing_stack_version
string

Esta secção especifica a versão da pilha de inferenculação adicionada à imagem. Para evitar adicionar uma pilha de inferenculação, não desafie este valor. Valor válido: "mais recente".

environment_variables
<xref:dict>

Um dicionário de variáveis ambientais nomes e valores. Estas variáveis ambientais são definidas no processo em que o script do utilizador é executado.

python
Secção Python

Esta secção especifica qual o ambiente python e intérprete a utilizar no cálculo do alvo.

spark
SparkSection

A secção configura as definições de faísca. Só é utilizado quando a estrutura é definida para PySpark.

r
RSection

Esta secção especifica qual o ambiente R a utilizar no cálculo do alvo.

versão
string

A versão do ambiente.

Métodos

add_private_pip_wheel

Faça o upload do ficheiro de roda de pip privado no disco para a bolha de armazenamento Azure anexada ao espaço de trabalho.

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

compilar

Construa uma imagem docker para este ambiente na nuvem.

build_local

Construa o ambiente local de Docker ou Conda.

clone

Clone o objeto ambiental.

Devolve um novo objeto ambiente com um novo nome.

from_conda_specification

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

Para obter um ficheiro YAML de especificação ambiental, consulte Ambientes de gestão no guia do utilizador da conda.

from_docker_image

Crie objeto ambiente a partir de uma imagem base estivador com dependenies de python opcionais.

A camada de python será adicionada ao ambiente se for especificada conda_specification ou pip_requirements. conda_specification e pip_requirements são mutuamente exclusivos.

from_dockerfile

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

A camada de python será adicionada ao ambiente se for especificada conda_specification ou pip_requirements. conda_specification e pip_requirements são mutuamente exclusivos.

from_existing_conda_environment

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

Para obter uma lista dos ambientes conda existentes, corra conda env list . Para obter mais informações, consulte Gerir ambientes no guia do utilizador da Conda.

from_pip_requirements

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

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

get

Devolva o objeto ambiente.

Se a etiqueta for especificada, o objeto previamente rotulado com o valor será devolvido. Apenas um dos parâmetros de versão ou etiqueta pode ser especificado. Se ambos falharem, a versão mais recente do objeto Ambiente será devolvida.

get_image_details

Devolva os detalhes da Imagem.

etiqueta

Rotular o objeto ambiente no seu espaço de trabalho com os valores especificados.

lista

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

load_from_directory

Carregue uma definição de ambiente dos ficheiros num diretório.

registar

Registe o objeto ambiente no seu espaço de trabalho.

save_to_directory

Guarde uma definição de ambiente para um diretório num formato facilmente editável.

add_private_pip_wheel

Faça o upload do ficheiro de roda de pip privado no disco para a bolha de armazenamento Azure anexada ao espaço de trabalho.

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

add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parâmetros

área de trabalho
Workspace

O objeto do espaço de trabalho a utilizar para registar a roda de pip privada.

file_path
<xref:str>

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

exist_ok
<xref:bool>
valor predefinido: False

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

Devoluções

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

Tipo de retorno

<xref:str>

compilar

Construa uma imagem docker para este ambiente na nuvem.

build(workspace, image_build_compute=None)

Parâmetros

área de trabalho
Workspace

O espaço de trabalho e o seu registo associado do contentor Azure onde a imagem está armazenada.

image_build_compute
<xref:str>
valor predefinido: None

O nome computacional onde a imagem será construída

Devoluções

Devolve o objeto de detalhes de construção de imagem.

Tipo de retorno

build_local

Construa o ambiente local de Docker ou Conda.

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

Parâmetros

área de trabalho
Workspace

O espaço de trabalho.

plataforma
<xref:str>
valor predefinido: None

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

kwargs
<xref:dict>

Argumentos avançados de palavras-chave

Devoluções

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

Tipo de retorno

<xref:str>

Observações

Os exemplos que se seguem mostram como construir um ambiente local. Certifique-se de que o espaço de trabalho é instantâneo como um azureml.core.workspace válido

Construir ambiente conda local


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

Construir ambiente de estivador local


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

Construa a imagem do estivador localmente e, opcionalmente, empurre-a para o registo do contentor 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 ambiental.

Devolve um novo objeto ambiente com um novo nome.

clone(new_name)

Parâmetros

new_name
<xref:str>

Novo nome ambiental

Devoluções

Novo objeto ambiental

Tipo de retorno

from_conda_specification

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

Para obter um ficheiro YAML de especificação ambiental, consulte Ambientes de gestão no guia do utilizador da conda.

from_conda_specification(name, file_path)

Parâmetros

name
<xref:str>

O nome do ambiente.

file_path
<xref:str>

O caminho de arquivo de especificação ambiente conda YAML.

Devoluções

O objeto do ambiente.

Tipo de retorno

from_docker_image

Crie objeto ambiente a partir de uma imagem base estivador com dependenies de python opcionais.

A camada de python será adicionada ao ambiente se for especificada conda_specification ou pip_requirements. conda_specification e pip_requirements são mutuamente exclusivos.

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

Parâmetros

name
<xref:str>

O nome do ambiente.

image
<xref:str>

nome de imagem totalmente qualificado.

conda_specification
<xref:str>
valor predefinido: None

ficheiro de especificação conda.

container_registry
ContainerRegistry
valor predefinido: None

detalhes privados do repositório de contentores.

pip_requirements
<xref:str>
valor predefinido: None

ficheiro de requisitos de pip.

Devoluções

O objeto do ambiente.

Tipo de retorno

Observações

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

from_dockerfile

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

A camada de python será adicionada ao ambiente se for especificada conda_specification ou pip_requirements. conda_specification e pip_requirements são mutuamente exclusivos.

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

Parâmetros

name
<xref:str>

O nome do ambiente.

dockerfile
<xref:str>

estivar o conteúdo ou caminho para o ficheiro.

conda_specification
<xref:str>
valor predefinido: None

ficheiro de especificação conda.

pip_requirements
<xref:str>
valor predefinido: None

ficheiro de requisitos de pip.

Devoluções

O objeto do ambiente.

Tipo de retorno

from_existing_conda_environment

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

Para obter uma lista dos ambientes conda existentes, corra conda env list . Para obter mais informações, consulte Gerir ambientes no guia do utilizador da Conda.

from_existing_conda_environment(name, conda_environment_name)

Parâmetros

name
<xref:str>

O nome do ambiente.

conda_environment_name
<xref:str>

O nome de um ambiente conda existente localmente.

Devoluções

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

Tipo de retorno

from_pip_requirements

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

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

from_pip_requirements(name, file_path, pip_version=None)

Parâmetros

name
<xref:str>

O nome do ambiente.

file_path
<xref:str>

O caminho do ficheiro de requisitos do pip.

pip_version
<xref:str>
valor predefinido: None

Versão pip para ambiente conda.

Devoluções

O objeto do ambiente.

Tipo de retorno

get

Devolva o objeto ambiente.

Se a etiqueta for especificada, o objeto previamente rotulado com o valor será devolvido. Apenas um dos parâmetros de versão ou etiqueta pode ser especificado. Se ambos falharem, a versão mais recente do objeto Ambiente será devolvida.

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

Parâmetros

área de trabalho
Workspace

O espaço de trabalho que contém o ambiente.

name
<xref:str>

O nome do ambiente para voltar.

versão
<xref:str>
valor predefinido: None

A versão do ambiente para regressar.

etiqueta
<xref:str>
valor predefinido: None

Valor da etiqueta do ambiente.

Devoluções

O objeto do ambiente.

Tipo de retorno

get_image_details

Devolva os detalhes da Imagem.

get_image_details(workspace)

Parâmetros

área de trabalho
Workspace

O espaço de trabalho.

Devoluções

Devolve os detalhes da imagem como dict

Tipo de retorno

etiqueta

Rotular o objeto ambiente no seu espaço de trabalho com os valores especificados.

label(workspace, name, version, labels)

Parâmetros

área de trabalho
Workspace

A área de trabalho

name
<xref:str>

Nome do ambiente

versão
<xref:str>

Versão ambiental

rótulos
list[<xref:str>]

Valores para rotular Ambiente com

lista

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

list(workspace)

Parâmetros

área de trabalho
Workspace

O espaço de trabalho a partir do qual lista ambientes.

Devoluções

Um dicionário de objetos ambientais.

Tipo de retorno

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

load_from_directory

Carregue uma definição de ambiente dos ficheiros num diretório.

load_from_directory(path)

Parâmetros

caminho
<xref:str>

Caminho para o diretório de origem.

registar

Registe o objeto ambiente no seu espaço de trabalho.

register(workspace)

Parâmetros

área de trabalho
Workspace

A área de trabalho

name
<xref:str>

Devoluções

Devolve o objeto ambiental

Tipo de retorno

save_to_directory

Guarde uma definição de ambiente para um diretório num formato facilmente editável.

save_to_directory(path, overwrite=False)

Parâmetros

caminho
<xref:str>

Caminho para o diretório de destino.

sobrepor
<xref:bool>
valor predefinido: False

Se um diretório existente deve ser substituído. Predefinições falsas.