Environment Clase

Configura un entorno de Python reproducible para experimentos de aprendizaje automático.

Un entorno define paquetes de Python, variables de entorno y configuración de Docker que se usan en experimentos de aprendizaje automático, incluida la preparación, el entrenamiento y la implementación de datos en un servicio web. Un entorno se administra y tiene versiones en una instancia de Azure Machine Learning Workspace. Puede actualizar un entorno existente y recuperar una versión para reutilizarla. Los entornos son exclusivos del área de trabajo en la que se crean y no se pueden usar en distintas áreas de trabajo.

Para obtener más información sobre los entornos, consulte Creación y administración de entornos reutilizables.

Constructor de entorno de clase.

Constructor

Environment(name, **kwargs)

Parámetros

Nombre	Description
name Requerido	string Nombre del entorno. Nota: No inicie el nombre del entorno con "Microsoft" ni "AzureML". Los prefijos "Microsoft" y "AzureML" están reservados para entornos mantenidos. Para obtener más información sobre los entornos mantenidos, consulte Creación y administración de entornos reutilizables.

Comentarios

Azure Machine Learning proporciona entornos mantenidos, que son entornos predefinidos que ofrecen buenos puntos de partida para crear sus propios entornos. Los entornos mantenidos están respaldados por imágenes de Docker almacenadas en caché, lo que proporciona un costo de preparación de ejecución reducido. Para obtener más información sobre los entornos mantenidos, consulte Creación y administración de entornos reutilizables.

Hay varias formas de crear el entorno en Azure Machine Learning, incluido cuando:

Inicialice un nuevo objeto Environment.
Use uno de los métodos de clase Environment: from_conda_specification, from_pip_requirementso from_existing_conda_environment.
Use el submit método de la clase Experiment para enviar una ejecución de experimento sin especificar un entorno, incluido con un Estimator objeto .

En el ejemplo siguiente se muestra cómo crear instancias de un nuevo entorno.


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

Puede administrar un entorno registrándolo. Si lo hace, puede realizar un seguimiento de las versiones del entorno y reutilizarlas en ejecuciones futuras.


   myenv.register(workspace=ws)

Para obtener más ejemplos de cómo trabajar con entornos, consulte Jupyter Notebook Using environments (Uso de entornos de Jupyter Notebook).

Variables

Nombre	Description
Environment.databricks	En la sección se configuran las dependencias de la biblioteca azureml.core.databricks.DatabricksSection.
docker	DockerSection En esta sección se configuran las opciones relacionadas con la imagen final de Docker compilada en las especificaciones del entorno y si se usan contenedores de Docker para compilar el entorno.
inferencing_stack_version	string En esta sección se especifica la versión de pila de inferencia agregada a la imagen. Para evitar agregar una pila de inferencia, no establezca este valor. Valor válido: "latest" (más reciente).
python	PythonSection En esta sección se especifica el entorno y el intérprete de Python que se van a usar en el proceso de destino.
spark	SparkSection Sección que define la configuración de Spark. Solo se usa cuando framework se establece en PySpark.
r	RSection En esta sección se especifica el entorno de R que se va a usar en el proceso de destino.
version	string Versión del entorno.
asset_id	string Id. de recurso. Rellena cuando se registra un entorno.

Métodos

add_private_pip_wheel	Cargue el archivo de rueda de pip privado en el disco en el blob de Azure Storage conectado al área de trabajo. Produce una excepción si ya existe una rueda pip privada con el mismo nombre en el blob de almacenamiento del área de trabajo.
build	Cree una imagen de Docker para este entorno en la nube.
build_local	Compile el entorno local de Docker o conda.
clone	Clone el objeto de entorno. Devuelve una nueva instancia del objeto de entorno con un nuevo nombre.
from_conda_specification	Cree un objeto de entorno a partir de un archivo YAML de especificación de entorno. Para obtener un archivo YAML de especificación de entorno, consulte Administración de entornos en la guía del usuario de Conda.
from_docker_build_context	Cree un objeto de entorno a partir de un contexto de compilación de Docker.
from_docker_image	Cree un objeto de entorno a partir de una imagen base de Docker con dependencias opcionales de Python. La capa de Python se agregará al entorno si se especifica conda_specification o pip_requirements. conda_specification y pip_requirements son mutuamente excluyentes.
from_dockerfile	Cree un objeto de entorno a partir de un Dockerfile con dependencias opcionales de Python. La capa de Python se agregará al entorno si se especifica conda_specification o pip_requirements. conda_specification y pip_requirements son mutuamente excluyentes.
from_existing_conda_environment	Cree un objeto de entorno creado a partir de un entorno de conda existente localmente. Para obtener una lista de entornos de Conda existentes, ejecute `conda env list`. Para obtener más información, consulte Administración de entornos en la guía del usuario de Conda.
from_pip_requirements	Cree un objeto de entorno creado a partir de un archivo de requisitos pip. Se agregará la dependencia pip desanclada si no se especifica pip_version .
get	Devuelve el objeto de entorno. Si se especifica la etiqueta , se devolverá el objeto etiquetado previamente con el valor . Solo se puede especificar uno de los parámetros de versión o etiqueta. Si se pierden ambos, se devolverá la versión más reciente del objeto Environment.
get_image_details	Devuelve los detalles de la imagen.
label	Etiquete el objeto de entorno en el área de trabajo con los valores especificados.
list	Devuelve un diccionario que contiene entornos en el área de trabajo.
load_from_directory	Cargue una definición de entorno a partir de los archivos de un directorio.
register	Registre el objeto de entorno en el área de trabajo.
save_to_directory	Guarde una definición de entorno en un directorio en un formato fácil de editar.

add_private_pip_wheel

Cargue el archivo de rueda de pip privado en el disco en el blob de Azure Storage conectado al área de trabajo.

Produce una excepción si ya existe una rueda pip privada con el mismo nombre en el blob de almacenamiento del área de trabajo.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parámetros

Nombre	Description
workspace Requerido	Workspace Objeto de área de trabajo que se va a usar para registrar la rueda de pip privada.
file_path Requerido	str Ruta de acceso a la rueda pip local en el disco, incluida la extensión de archivo.
exist_ok	bool Indica si se va a producir una excepción si la rueda ya existe. Valor predeterminado: False

Devoluciones

Tipo	Description
str	Devuelve el URI completo a la rueda pip cargada en Azure Blob Storage para usarla en las dependencias de Conda.

build

Cree una imagen de Docker para este entorno en la nube.

build(workspace, image_build_compute=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo y su instancia de Azure Container Registry asociada donde se almacena la imagen.
image_build_compute	str Nombre de proceso en el que se realizará la compilación de la imagen Valor predeterminado: None

Devoluciones

Tipo	Description
ImageBuildDetails	Devuelve el objeto de detalles de compilación de la imagen.

build_local

Compile el entorno local de Docker o conda.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo.
platform	str Plataforma. Uno de Linux, Windows o OSX. La plataforma actual se usará de forma predeterminada. Valor predeterminado: None
kwargs Requerido	dict Argumentos de palabra clave avanzadas

Devoluciones

Tipo	Description
str	Transmite la salida integrada de Docker o conda en la consola.

Comentarios

En los ejemplos siguientes se muestra cómo crear un entorno local. Asegúrese de que se crea una instancia del área de trabajo como un objeto azureml.core.workspace.Workspace válido.

Creación de un entorno de Conda local


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

Compilación del entorno de Docker local


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

Compile la imagen de Docker localmente y, opcionalmente, insértela en el registro de contenedor asociado al área de trabajo.


   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 el objeto de entorno.

Devuelve una nueva instancia del objeto de entorno con un nuevo nombre.

clone(new_name)

Parámetros

Nombre	Description
new_name Requerido	str Nuevo nombre de entorno

Devoluciones

Tipo	Description
Environment	Nuevo objeto de entorno

from_conda_specification

Cree un objeto de entorno a partir de un archivo YAML de especificación de entorno.

Para obtener un archivo YAML de especificación de entorno, consulte Administración de entornos en la guía del usuario de Conda.

static from_conda_specification(name, file_path)

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
file_path Requerido	str Ruta de acceso del archivo YAML de especificación del entorno de Conda.

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

from_docker_build_context

Cree un objeto de entorno a partir de un contexto de compilación de Docker.

static from_docker_build_context(name, docker_build_context)

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
docker_build_context Requerido	DockerBuildContext El objeto DockerBuildContext.

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

from_docker_image

Cree un objeto de entorno a partir de una imagen base de Docker con dependencias opcionales de Python.

La capa de Python se agregará al entorno si se especifica conda_specification o pip_requirements. conda_specification y pip_requirements son mutuamente excluyentes.

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

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
image Requerido	str nombre completo de la imagen.
conda_specification	str Archivo de especificación de conda. Valor predeterminado: None
container_registry	ContainerRegistry detalles del repositorio de contenedor privado. Valor predeterminado: None
pip_requirements	str archivo de requisitos de pip. Valor predeterminado: None

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

Comentarios

Si la imagen base procede del repositorio privado que requiere autorización y la autorización no está establecida en el nivel de área de trabajo de AzureML, se requiere container_registry

from_dockerfile

Cree un objeto de entorno a partir de un Dockerfile con dependencias opcionales de Python.

La capa de Python se agregará al entorno si se especifica conda_specification o pip_requirements. conda_specification y pip_requirements son mutuamente excluyentes.

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

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
dockerfile Requerido	str Contenido de Dockerfile o ruta de acceso al archivo.
conda_specification	str Archivo de especificación de conda. Valor predeterminado: None
pip_requirements	str archivo de requisitos de pip. Valor predeterminado: None

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

from_existing_conda_environment

Cree un objeto de entorno creado a partir de un entorno de conda existente localmente.

Para obtener una lista de entornos de Conda existentes, ejecute conda env list. Para obtener más información, consulte Administración de entornos en la guía del usuario de Conda.

static from_existing_conda_environment(name, conda_environment_name)

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
conda_environment_name Requerido	str Nombre de un entorno de Conda existente localmente.

Devoluciones

Tipo	Description
Environment	El objeto de entorno o None si se produce un error al exportar el archivo de especificación de Conda.

from_pip_requirements

Cree un objeto de entorno creado a partir de un archivo de requisitos pip.

Se agregará la dependencia pip desanclada si no se especifica pip_version .

static from_pip_requirements(name, file_path, pip_version=None)

Parámetros

Nombre	Description
name Requerido	str Nombre del entorno.
file_path Requerido	str Ruta de acceso del archivo de requisitos pip.
pip_version	str Versión de Pip para el entorno de Conda. Valor predeterminado: None

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

get

Devuelve el objeto de entorno.

Si se especifica la etiqueta , se devolverá el objeto etiquetado previamente con el valor . Solo se puede especificar uno de los parámetros de versión o etiqueta. Si se pierden ambos, se devolverá la versión más reciente del objeto Environment.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo que contiene el entorno.
name Requerido	str Nombre del entorno que se va a devolver.
version	str Versión del entorno que se va a devolver. Valor predeterminado: None
label	str Valor de etiqueta del entorno. Valor predeterminado: None

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

get_image_details

Devuelve los detalles de la imagen.

get_image_details(workspace)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo.

Devoluciones

Tipo	Description
DockerImageDetails	Devuelve los detalles de la imagen como dict.

label

Etiquete el objeto de entorno en el área de trabajo con los valores especificados.

static label(workspace, name, version, labels)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo
name Requerido	str Nombre del entorno
version Requerido	str Versión del entorno
labels Requerido	list[str] Valores para etiquetar Entorno con

list

Devuelve un diccionario que contiene entornos en el área de trabajo.

static list(workspace)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo desde la que se van a enumerar los entornos.

Devoluciones

Tipo	Description
<xref:builtin.dict>[str, Environment]	Diccionario de objetos de entorno.

load_from_directory

Cargue una definición de entorno a partir de los archivos de un directorio.

static load_from_directory(path)

Parámetros

Nombre	Description
path Requerido	str Ruta de acceso al directorio de origen.

register

Registre el objeto de entorno en el área de trabajo.

register(workspace)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo
name Requerido	str

Devoluciones

Tipo	Description
Environment	Devuelve el objeto de entorno.

save_to_directory

Guarde una definición de entorno en un directorio en un formato fácil de editar.

save_to_directory(path, overwrite=False)

Parámetros

Nombre	Description
path Requerido	str Ruta de acceso al directorio de destino.
overwrite	bool Si se debe sobrescribir un directorio existente. El valor predeterminado es false. Valor predeterminado: False

Atributos

environment_variables

Use el objeto azureml.core.RunConfiguration para establecer variables en tiempo de ejecución.

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

Environment Clase

Constructor

Parámetros

Comentarios

Variables

Métodos

add_private_pip_wheel

Parámetros

Devoluciones

build

Parámetros

Devoluciones

build_local

Parámetros

Devoluciones

Comentarios

clone

Parámetros

Devoluciones

from_conda_specification

Parámetros

Devoluciones

from_docker_build_context

Parámetros

Devoluciones

from_docker_image

Parámetros

Devoluciones

Comentarios

from_dockerfile

Parámetros

Devoluciones

from_existing_conda_environment

Parámetros

Devoluciones

from_pip_requirements

Parámetros

Devoluciones

get

Parámetros

Devoluciones

get_image_details

Parámetros

Devoluciones

label

Parámetros

list

Parámetros

Devoluciones

load_from_directory

Parámetros

register

Parámetros

Devoluciones

save_to_directory

Parámetros

Atributos

environment_variables

Comentarios