Environment Clase

Referencia

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

Un entorno define los paquetes de Python, las variables de entorno y la configuración de Docker que se usan en los experimentos de aprendizaje automático, incluida la preparación de datos, el entrenamiento y la implementación en un servicio web. Un entorno se administra y se crean sus versiones en un elemento Workspace de Azure Machine Learning. 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 más información sobre los entornos, consulte Creación y administración de entornos reutilizables.

Constructor de entorno de clase.

Herencia: azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement

Environment

Constructor

Environment(name, **kwargs)

Parámetros

Nombre	Description
name Requerido	string El nombre del entorno. Nota No comience el nombre del entorno con "Microsoft" o "AzureML". Los prefijos "Microsoft" y "AzureML" están reservados para entornos seleccionados. Para más información sobre los entornos seleccionados, consulte Creación y uso de entornos de software en Azure Machine Learning.

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 en caché, lo que reduce el costo de preparación de la ejecución. Para más información sobre los entornos seleccionados, consulte Creación y uso de entornos de software en Azure Machine Learning.

Hay varias maneras de crear el entorno en Azure Machine Learning, entre ellas, cuando:

Se inicializa un nuevo objeto de entorno.
Se usa uno de los métodos de clase Environment: from_conda_specification, from_pip_requirements o from_existing_conda_environment.
Se usa el método submit de la clase Experiment para enviar una ejecución de experimento sin especificar un entorno, por ejemplo, con un objeto Estimator.

En el siguiente ejemplo, se muestra cómo crear una instancia de un nuevo entorno.


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

Para administrar un entorno, regístrelo. Esto le permite realizar un seguimiento de las versiones del entorno y reutilizarlas en futuras ejecuciones.


   myenv.register(workspace=ws)

Para ver más ejemplos de cómo trabajar con entornos, consulte Uso de entornos de Jupyter Notebook.

Variables

Nombre	Description
Environment.databricks	La sección configura las dependencias de la biblioteca azureml.core.databricks.DatabricksSection.
docker	DockerSection En esta sección, se configuran los valores relacionados con la imagen final de Docker creada según las especificaciones del entorno y se indica si se van a usar contenedores de Docker para crear el entorno.
inferencing_stack_version	string En esta sección, se especifica la versión de la 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 qué entorno e intérprete de Python se usarán en el proceso de destino.
spark	SparkSection Sección que define la configuración de Spark. Solo se usa cuando el marco se establece en PySpark.
r	RSection En esta sección, se especifica qué entorno de R se usará en el destino de proceso.
version	string Versión del entorno.
asset_id	string Identificador del recurso. Se rellena cuando se registra un entorno.

Métodos

add_private_pip_wheel	Carga el archivo de rueda de pip privada en disco en el blob de almacenamiento de Azure asociado al área de trabajo. Produce una excepción si ya existe una rueda de pip privada con el mismo nombre en el blob de almacenamiento del área de trabajo.
build	Crea una imagen de Docker para este entorno en la nube.
build_local	Compila el entorno local de Docker o Conda.
clone	Clona el objeto de entorno. Devuelve una nueva instancia del objeto de entorno con un nuevo nombre.
from_conda_specification	Crea 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	Crea un objeto de entorno a partir de una imagen de Docker base con funciones 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	Crea un objeto de entorno a partir de un entorno de Conda existente localmente. Para obtener una lista de los entornos de Conda existentes, ejecute `conda env list`. Para más información, consulte Administración de entornos en la guía del usuario de Conda.
from_pip_requirements	Crea un objeto de entorno creado a partir de un archivo de requisitos de pip. Si se especifica pip_version, se agregará una dependencia de pip desanclada.
get	Devuelve el objeto de entorno. Si se especifica la etiqueta, se devolverá el objeto etiquetado previamente con el valor. Solo se puede especificar un parámetro de versión o de etiqueta. Si faltan ambos, se devolverá la versión más reciente del objeto Environment.
get_image_details	Devuelve los detalles de la imagen.
label	Etiqueta el objeto de entorno del área de trabajo con los valores especificados.
list	Devuelve un diccionario que contiene los entornos del área de trabajo.
load_from_directory	Carga una definición de entorno a partir de los archivos de un directorio.
register	Registra el objeto de entorno en el área de trabajo.
save_to_directory	Guarda una definición de entorno en un directorio en un formato fácilmente editable.

add_private_pip_wheel

Carga el archivo de rueda de pip privada en disco en el blob de almacenamiento de Azure asociado al área de trabajo.

Produce una excepción si ya existe una rueda de 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 usará para registrar la rueda de pip privada.
file_path Requerido	str Ruta de acceso a la rueda de pip local en disco, incluida la extensión de archivo.
exist_ok	bool Indica si se debe producir una excepción si la rueda ya existe. Valor predeterminado: False

Devoluciones

Tipo	Description
str	Devuelve el identificador URI completo de la rueda de pip cargada en Azure Blob Storage que se usará en las dependencias de Conda.

build

Crea 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 e instancia de Azure Container Registry asociada donde se almacena la imagen.
image_build_compute	str Nombre de proceso donde se llevará a cabo la creación de la imagen Valor predeterminado: None

Devoluciones

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

build_local

Compila 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. Linux, Windows u OSX. De manera predeterminada, se usará la plataforma actual. Valor predeterminado: None
kwargs Requerido	dict Argumentos de palabra clave avanzados

Devoluciones

Tipo	Description
str	Transmite la salida de Docker en curso o la salida integrada de Conda a la consola.

Comentarios

En los ejemplos siguientes, se muestra cómo crear un entorno local. Asegúrese de que se cree 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)

Creación de un 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)

Creación de la imagen de Docker localmente y su inserción opcional 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

Clona 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

Crea 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 El 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 El nombre del entorno.
docker_build_context Requerido	DockerBuildContext Objeto DockerBuildContext.

Devoluciones

Tipo	Description
Environment	Objeto de entorno.

from_docker_image

Crea un objeto de entorno a partir de una imagen de Docker base con funciones 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 El 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 es del repositorio privado que requiere autorización y la autorización no está establecida en el nivel de área de trabajo de AzureML, se necesita 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 El nombre del entorno.
dockerfile Requerido	str Contenido o ruta de acceso de Dockerfile 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

Crea un objeto de entorno a partir de un entorno de Conda existente localmente.

Para obtener una lista de los entornos de Conda existentes, ejecute conda env list. Para 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 El nombre del entorno.
conda_environment_name Requerido	str Nombre de un entorno de Conda existente localmente.

Devoluciones

Tipo	Description
Environment	Objeto de entorno o None (Ninguno) si se produce un error al exportar el archivo de especificación de Conda.

from_pip_requirements

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

Si se especifica pip_version, se agregará una dependencia de pip desanclada.

static from_pip_requirements(name, file_path, pip_version=None)

Parámetros

Nombre	Description
name Requerido	str El nombre del entorno.
file_path Requerido	str Ruta de acceso del archivo de requisitos de 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 un parámetro de versión o de etiqueta. Si faltan 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 devolverá.
version	str Versión del entorno que se devolverá. Valor predeterminado: None
label	str Valor de etiqueta de 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 un diccionario.

label

Etiqueta el objeto de entorno del área de trabajo con los valores especificados.

static label(workspace, name, version, labels)

Parámetros

Nombre	Description
workspace Requerido	Workspace El área de trabajo
name Requerido	str Nombre del entorno
version Requerido	str Versión del entorno.
labels Requerido	list[str] Valores con los que etiquetar el entorno.

list

Devuelve un diccionario que contiene los entornos del área de trabajo.

static list(workspace)

Parámetros

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

Devoluciones

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

load_from_directory

Carga 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

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

register(workspace)

Parámetros

Nombre	Description
workspace Requerido	Workspace El área de trabajo
name Requerido	str

Devoluciones

Tipo	Description
Environment	Devuelve el objeto de entorno.

save_to_directory

Guarda una definición de entorno en un directorio en un formato fácilmente editable.

save_to_directory(path, overwrite=False)

Parámetros

Nombre	Description
path Requerido	str Ruta de acceso al directorio de destino.
overwrite	bool Indica 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.

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

Recursos adicionales