Environment Classe
Configura um ambiente do 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 usadas 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 tem versão em um Azure Machine Learning Workspace. Você pode atualizar um ambiente existente e recuperar uma versão a ser reutilizada. Os ambientes são exclusivos para o workspace em que são criados e não podem ser usados em diferentes workspaces.
Para obter mais informações sobre ambientes, consulte Criar e gerenciar ambientes reutilizáveis.
Construtor de Ambiente de Classe.
- Herança
-
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElementEnvironment
Construtor
Environment(name, **kwargs)
Parâmetros
- name
- 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 coletados. Para obter mais informações sobre ambientes coletados, confira Criar e gerenciar ambientes reutilizáveis.
Comentários
O Azure Machine Learning fornece ambientes selecionados, que são ambientes predefinidos que oferecem bons pontos de partida para compilar seus próprios ambientes. Os ambientes coletados são apoiados por imagens do Docker armazenadas em cache, provisionando um custo reduzido de preparação de execução. Para obter mais informações sobre ambientes coletados, confira Criar e gerenciar ambientes reutilizáveis.
Há várias maneiras de criar o ambiente no Azure Machine Learning, inclusive quando você:
Inicializa um novo objeto Ambiente.
Use um dos métodos da classe Ambiente: from_conda_specification, from_pip_requirements ou from_existing_conda_environment.
Use o método submit da classe Experiment para enviar um experimento executado sem especificar um ambiente, inclusive com um objeto Estimator.
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 permitirá acompanhar 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 Usar ambientes.
Variáveis
- Environment.databricks
A seção configura as dependências da biblioteca azureml.core.databricks.DatabricksSection.
- docker
- DockerSection
Essa seção define as configurações relacionadas à imagem final do Docker compilada de acordo com as especificações do ambiente, e se os contêineres do Docker deverão ser usados para compilar o ambiente.
- inferencing_stack_version
- string
Essa seção especifica a versão da pilha de inferência adicionada à imagem. Para evitar adicionar uma pilha de inferência, não defina esse valor. Valor válido: "latest".
- python
- PythonSection
Essa seção especifica qual ambiente e interpretador 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 do R usar na computação de destino.
- version
- string
A versão do ambiente.
- asset_id
- string
ID do ativo. Popula quando um ambiente é registrado.
Métodos
add_private_pip_wheel |
Upload do arquivo de roda de pip privado no disco para o blob de armazenamento do Azure anexado ao workspace. Lança uma exceção se uma roda de pip privada com o mesmo nome já existir no blob de armazenamento do workspace. |
build |
Compila uma imagem do Docker para esse ambiente na nuvem. |
build_local |
Compila o ambiente local do Docker ou do Conda. |
clone |
Clona o objeto de ambiente. Retorna uma nova instância do objeto de ambiente com um novo nome. |
from_conda_specification |
Cria 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 Gerenciar ambientes no guia do usuário do Conda. |
from_docker_build_context |
Crie um objeto de ambiente a partir de um contexto de build do Docker. |
from_docker_image |
Cria um objeto ambiente a partir de uma imagem base do Docker com dependências do 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 |
Cria um objeto de ambiente criado a partir de um ambiente do Conda existente localmente. Para obter uma lista de ambientes do Conda existentes, execute |
from_pip_requirements |
Cria um objeto de ambiente criado a partir de um arquivo de requisitos de pip. A dependência de pip não fixada será adicionada se pip_version não for especificado. |
get |
Retorna o objeto ambiente. Se o rótulo estiver especificado, o objeto previamente rotulado com o valor retornará. Apenas um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto Ambiente retornará. |
get_image_details |
Retorna os detalhes da Imagem. |
label |
Rotula o objeto Ambiente no workspace com os valores especificados. |
list |
Retorna um dicionário que contém ambientes no workspace. |
load_from_directory |
Carrega uma definição de ambiente dos arquivos em um diretório. |
register |
Registra o objeto Ambiente no workspace. |
save_to_directory |
Salva uma definição de ambiente em um diretório em um formato facilmente editável. |
add_private_pip_wheel
Upload do arquivo de roda de pip privado no disco para o blob de armazenamento do Azure anexado ao workspace.
Lança uma exceção se uma roda de pip privada com o mesmo nome já existir no blob de armazenamento do workspace.
static add_private_pip_wheel(workspace, file_path, exist_ok=False)
Parâmetros
- workspace
- Workspace
O objeto de workspace a ser usado para registrar a roda de pip privado.
- file_path
- str
Caminho para a roda de pip local no disco, incluindo a extensão de arquivo.
Retornos
Retorna o URI completo para a roda de pip carregada no armazenamento de blobs do Azure para usar em dependências de conda.
Tipo de retorno
build
Compila uma imagem do Docker para esse ambiente na nuvem.
build(workspace, image_build_compute=None)
Parâmetros
- workspace
- Workspace
O workspace e seu Registro de Contêiner do Azure associado onde a imagem é armazenada.
Retornos
Retorna o objeto de detalhes de build da imagem.
Tipo de retorno
build_local
Compila o ambiente local do Docker ou do Conda.
build_local(workspace, platform=None, **kwargs)
Parâmetros
- platform
- str
Plataforma. Um de Linux, Windows ou OSX. A plataforma atual será usada por padrão.
Retornos
Transmite a saída contínua do Docker ou Co conda para o console.
Tipo de retorno
Comentários
Os exemplos a seguir mostram como compilar um ambiente local. Verifique se o workspace foi instanciado como um objeto azureml.core.workspace.Workspace válido
Compilar ambiente do Conda local
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace)
Compilar 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)
Compilar a imagem do Docker localmente e, opcionalmente, enviar por push para o registro de contêiner associado workspace
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace, useDocker=True, pushImageToWorkspaceAcr=True)
clone
Clona o objeto de ambiente.
Retorna uma nova instância do objeto de ambiente com um novo nome.
clone(new_name)
Parâmetros
Retornos
Novo objeto de ambiente
Tipo de retorno
from_conda_specification
Cria 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 Gerenciar ambientes no guia do usuário do Conda.
static from_conda_specification(name, file_path)
Parâmetros
Retornos
O objeto ambiente.
Tipo de retorno
from_docker_build_context
Crie um objeto de ambiente a partir de um contexto de build do Docker.
static from_docker_build_context(name, docker_build_context)
Parâmetros
Retornos
O objeto ambiente.
Tipo de retorno
from_docker_image
Cria um objeto ambiente a partir de uma imagem base do Docker com dependências do 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
- container_registry
- ContainerRegistry
detalhes do repositório de contêiner privado.
Retornos
O objeto ambiente.
Tipo de retorno
Comentários
Se a imagem base for do repositório privado que requer autorização e a autorização não estiver definida no nível do workspace do AzureML, container_registry será necessário
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
Retornos
O objeto ambiente.
Tipo de retorno
from_existing_conda_environment
Cria um objeto de ambiente criado a partir de um ambiente do Conda existente localmente.
Para obter uma lista de ambientes do Conda existentes, execute conda env list
. Para obter mais informações, consulte Gerenciar ambientes no guia do usuário do Conda.
static from_existing_conda_environment(name, conda_environment_name)
Parâmetros
Retornos
O objeto ambiente ou None se a exportação do arquivo de especificação do Conda falhar.
Tipo de retorno
from_pip_requirements
Cria um objeto de ambiente criado a partir de um arquivo de requisitos de 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
Retornos
O objeto ambiente.
Tipo de retorno
get
Retorna o objeto ambiente.
Se o rótulo estiver especificado, o objeto previamente rotulado com o valor retornará. Apenas um dos parâmetros de versão ou rótulo pode ser especificado. Se ambos estiverem ausentes, a versão mais recente do objeto Ambiente retornará.
static get(workspace, name, version=None, label=None)
Parâmetros
Retornos
O objeto ambiente.
Tipo de retorno
get_image_details
Retorna os detalhes da Imagem.
get_image_details(workspace)
Parâmetros
Retornos
Retorna os detalhes da imagem como dict
Tipo de retorno
label
Rotula o objeto Ambiente no workspace com os valores especificados.
static label(workspace, name, version, labels)
Parâmetros
list
Retorna um dicionário que contém ambientes no workspace.
static list(workspace)
Parâmetros
Retornos
Um dicionário de objetos Ambiente.
Tipo de retorno
load_from_directory
Carrega uma definição de ambiente dos arquivos em um diretório.
static load_from_directory(path)
Parâmetros
register
Registra o objeto Ambiente no workspace.
register(workspace)
Parâmetros
- name
- str
Retornos
Retorna o objeto Ambiente
Tipo de retorno
save_to_directory
Salva uma definição de ambiente em um diretório em um formato facilmente editável.
save_to_directory(path, overwrite=False)
Parâmetros
- overwrite
- bool
Se um diretório existente deverá ser substituído. O padrão é false.
Atributos
environment_variables
Use o objeto azureml.core.RunConfiguration para definir variáveis de tempo de execução.
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de