Ambiente Classe

Configura um ambiente de 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, incluindo a preparação, o treinamento e a implantação de dados para um serviço Web. Um ambiente é gerenciado e tem controle de versão em um Azure Machine Learning Workspace . Você pode atualizar um ambiente existente e recuperar uma versão para reutilização. Os ambientes são exclusivos para o 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.

Herança
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Ambiente

Construtor

Environment(name, **kwargs)

Parâmetros

name
string

O nome do ambiente.

Observação

Não inicie o nome do seu ambiente com "Microsoft" ou "AzureML". Os prefixos "Microsoft" e "AzureML" são reservados para ambientes organizados. Para obter mais informações sobre ambientes organizados, consulte criar e gerenciar ambientes reutilizáveis.

Comentários

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

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

O exemplo a seguir mostra como criar uma instância de um novo ambiente.


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

Você pode gerenciar um ambiente registrando-o. Isso permite que você acompanhe as versões do ambiente e reutilize-as em execuções futuras.


   myenv.register(workspace=ws)

Para obter mais exemplos de como trabalhar com ambientes, consulte o Jupyter Notebook usando ambientes.

Variáveis

Ambiente. databricks

A seção configura as dependências de biblioteca azureml. Core. databricks. DatabricksSection.

docker
DockerSection

Esta seção define as configurações relacionadas à imagem final do Docker criada nas 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 inferência adicionada à imagem. Para evitar a adição de uma pilha inferência, não defina esse valor. Valor válido: "latest".

environment_variables
<xref:dict>

Um dicionário de nomes e valores de variáveis de ambiente. Essas variáveis de ambiente são definidas no processo em que o script do usuário é executado.

python
PythonSection

Esta seção especifica qual ambiente e intérprete do 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 de R usar na computação de destino.

version
string

A versão do ambiente.

Métodos

add_private_pip_wheel

Carregue o arquivo de roda de Pip particular no disco para o blob de armazenamento do Azure anexado ao espaço de trabalho.

Gera uma exceção se uma roda Pip privada com o mesmo nome já existe no blob de armazenamento do espaço de trabalho.

compilar

Crie uma imagem do Docker para esse ambiente na nuvem.

build_local

Crie o ambiente local do Docker ou do 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 de YAML de especificação de ambiente, consulte Gerenciando ambientes no guia do usuário do Conda.

from_docker_image

Crie um objeto de ambiente a partir de uma imagem base do Docker com o Python dependenies opcional.

A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. conda_specification e pip_requirements são mutuamente exclusivos.

from_dockerfile

Criar objeto de ambiente de um dockerfile com Python dependenies opcional.

A camada do 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 existente localmente.

Para obter uma lista de ambientes Conda existentes, execute conda env list . Para obter mais informações, consulte Managing Environments in the Conda User Guide.

from_pip_requirements

Crie um objeto de ambiente criado a partir de um arquivo de requisitos de Pip.

A dependência Pip desafixada será adicionada se pip_version não for especificada.

get

Retornar o objeto de ambiente.

Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Somente um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto de ambiente será retornada.

get_image_details

Retornar os detalhes da imagem.

label

Rotular 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

Carregar 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 de roda de Pip particular no disco para o blob de armazenamento do Azure anexado ao espaço de trabalho.

Gera uma exceção se uma roda Pip privada com o mesmo nome já existe no blob de armazenamento do espaço de trabalho.

add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parâmetros

workspace
Workspace

O objeto de espaço de trabalho a ser usado para registrar a roda de Pip particular.

file_path
<xref:str>

Caminho para a roda do Pip local no disco, incluindo a extensão do arquivo.

exist_ok
<xref:bool>
valor padrão: False

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

Retornos

Retorna o URI completo para a roda de Pip carregada no armazenamento de BLOBs do Azure para usar em dependências Conda.

Tipo de retorno

<xref:str>

compilar

Crie uma imagem do Docker para esse ambiente na nuvem.

build(workspace, image_build_compute=None)

Parâmetros

workspace
Workspace

O espaço de trabalho e seu registro de contêiner do Azure associado onde a imagem está armazenada.

image_build_compute
<xref:str>
valor padrão: None

O nome de computação em que a criação da imagem ocorrerá

Retornos

Retorna o objeto de detalhes de compilação de imagem.

Tipo de retorno

build_local

Crie o ambiente local do Docker ou do Conda.

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

Parâmetros

workspace
Workspace

O workspace.

plataforma
<xref:str>
valor padrão: None

Plataforma. Um dos Linux, Windows ou OSX. A plataforma atual será usada por padrão.

kwargs
<xref:dict>

Argumentos de palavra-chave Advanced

Retornos

Transmite a saída do Docker em andamento ou da Conda criada para o console.

Tipo de retorno

<xref:str>

Comentários

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

Criar ambiente Conda local


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

Criar 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)

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

new_name
<xref:str>

Novo nome do ambiente

Retornos

Novo objeto de ambiente

Tipo de retorno

from_conda_specification

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

Para obter um arquivo de YAML de especificação de ambiente, consulte Gerenciando ambientes no guia do usuário do Conda.

from_conda_specification(name, file_path)

Parâmetros

name
<xref:str>

O nome do ambiente.

file_path
<xref:str>

O caminho do arquivo YAML de especificação de ambiente Conda.

Retornos

O objeto de ambiente.

Tipo de retorno

from_docker_image

Crie um objeto de ambiente a partir de uma imagem base do Docker com o Python dependenies opcional.

A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. 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 da imagem totalmente qualificado.

conda_specification
<xref:str>
valor padrão: None

arquivo de especificação Conda.

container_registry
ContainerRegistry
valor padrão: None

detalhes do repositório de contêiner privado.

pip_requirements
<xref:str>
valor padrão: None

arquivo de requisitos de Pip.

Retornos

O objeto de ambiente.

Tipo de retorno

Comentários

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

Criar objeto de ambiente de um dockerfile com Python dependenies opcional.

A camada do Python será adicionada ao ambiente se conda_specification ou pip_requirements for especificado. 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>

dockerfile o conteúdo ou o caminho para o arquivo.

conda_specification
<xref:str>
valor padrão: None

arquivo de especificação Conda.

pip_requirements
<xref:str>
valor padrão: None

arquivo de requisitos de Pip.

Retornos

O objeto de ambiente.

Tipo de retorno

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 Managing Environments in the Conda User Guide.

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 de Conda existente localmente.

Retornos

O objeto de ambiente ou nenhum se a exportação do arquivo de especificação Conda falhar.

Tipo de retorno

from_pip_requirements

Crie um objeto de ambiente criado a partir de um arquivo de requisitos de Pip.

A dependência Pip desafixada será adicionada se pip_version não for especificada.

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 arquivo de requisitos de Pip.

pip_version
<xref:str>
valor padrão: None

Versão de Pip para o ambiente Conda.

Retornos

O objeto de ambiente.

Tipo de retorno

get

Retornar o objeto de ambiente.

Se o rótulo for especificado, o objeto rotulado anteriormente com o valor será retornado. Somente um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto de ambiente será retornada.

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

Parâmetros

workspace
Workspace

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

name
<xref:str>

O nome do ambiente a ser retornado.

version
<xref:str>
valor padrão: None

A versão do ambiente a ser retornada.

label
<xref:str>
valor padrão: None

Valor do rótulo do ambiente.

Retornos

O objeto de ambiente.

Tipo de retorno

get_image_details

Retornar os detalhes da imagem.

get_image_details(workspace)

Parâmetros

workspace
Workspace

O workspace.

Retornos

Retorna os detalhes da imagem como um Dictation

Tipo de retorno

label

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

label(workspace, name, version, labels)

Parâmetros

workspace
Workspace

O espaço de trabalho

name
<xref:str>

Nome do ambiente

version
<xref:str>

Versão do ambiente

rótulos
list[<xref:str>]

Valores para rotular o ambiente com

list

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

list(workspace)

Parâmetros

workspace
Workspace

O espaço de trabalho do qual listar os ambientes.

Retornos

Um dicionário de objetos de ambiente.

Tipo de retorno

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

load_from_directory

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

load_from_directory(path)

Parâmetros

path
<xref:str>

Caminho para o diretório de origem.

register

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

register(workspace)

Parâmetros

workspace
Workspace

O espaço de trabalho

name
<xref:str>

Retornos

Retorna o objeto de ambiente

Tipo de retorno

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

path
<xref:str>

Caminho para o diretório de destino.

overwrite
<xref:bool>
valor padrão: False

Se um diretório existente deve ser substituído. O padrão é false.