Environment Класс

Настраивает воспроизводимую среду Python для экспериментов машинного обучения.

Среда определяет пакеты Python, переменные среды и параметры Docker, используемые в экспериментах машинного обучения, включая подготовку данных, обучение и развертывание в веб-службе. Среда управляется и версией в машинном обучении WorkspaceAzure. Можно обновить существующую среду и получить версию для повторного использования. Среды являются эксклюзивными для рабочей области, в которую они создаются, и их нельзя использовать в разных рабочих областях.

Дополнительные сведения о средах см. в статье "Создание и управление повторно используемыми средами".

Конструктор среды класса.

Конструктор

Environment(name, **kwargs)

Параметры

Имя	Описание
name Обязательно	string Имя среды. Замечание Не запускайте имя среды с помощью Microsoft или AzureML. Префиксы Microsoft и AzureML зарезервированы для курируемых сред. Дополнительные сведения о курируемых средах см. в статье "Создание и управление повторно используемыми средами".

Имя

Описание

name

Обязательно

string

Имя среды.

Замечание

Не запускайте имя среды с помощью Microsoft или AzureML. Префиксы Microsoft и AzureML зарезервированы для курируемых сред. Дополнительные сведения о курируемых средах см. в статье "Создание и управление повторно используемыми средами".

Машинное обучение Azure предоставляет проверенные среды, которые являются предопределенными средами, которые предлагают хорошие начальные точки для создания собственных сред. Управляемые среды поддерживаются кэшированными образами Docker, что позволяет сократить затраты на подготовку. Дополнительные сведения о курируемых средах см. в статье "Создание и управление повторно используемыми средами".

Существует несколько способов создания среды в Машинном обучении Azure, в том числе при выполнении следующих действий.

Инициализация нового объекта Environment.
Используйте один из методов класса Environment: from_conda_specification, from_pip_requirementsили from_existing_conda_environment.
submit Используйте метод класса Experiment для отправки эксперимента без указания среды, включая Estimator объект.

В следующем примере показано, как создать экземпляр новой среды.


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

Вы можете управлять средой, регистрируя ее. Это позволяет отслеживать версии среды и повторно использовать их в будущих запусках.


   myenv.register(workspace=ws)

Дополнительные примеры работы с средами см. в среде Jupyter Notebook Using.

Переменные

Имя	Описание
Environment.databricks	В разделе настраивается зависимости библиотеки azureml.core.databricks.DatabricksSection.
docker	DockerSection В этом разделе настраивается параметры, связанные с окончательным образом Docker, созданным в соответствии с спецификациями среды, и следует ли использовать контейнеры Docker для сборки среды.
inferencing_stack_version	string В этом разделе указывается версия стека вывода, добавленная в образ. Чтобы избежать добавления стека вывода, не устанавливайте это значение. Допустимое значение: "latest".
python	PythonSection В этом разделе указывается, какая среда Python и интерпретатор используются в целевом вычислении.
spark	SparkSection В разделе настраиваются параметры Spark. Он используется только в том случае, если для платформы задано значение PySpark.
r	RSection В этом разделе указывается, какая среда R используется в целевом вычислении.
version	string Версия среды.
asset_id	string Идентификатор ресурса. Заполняется при регистрации среды.

Методы

add_private_pip_wheel	Отправьте файл частного колеса pip на диск в большой двоичный объект хранилища Azure, подключенный к рабочей области. Создает исключение, если частное колесо pip с тем же именем уже существует в BLOB-объекте хранилища рабочей области.
build	Создайте образ Docker для этой среды в облаке.
build_local	Создайте локальную среду Docker или conda.
clone	Клонируйте объект среды. Возвращает новый экземпляр объекта среды с новым именем.
from_conda_specification	Создайте объект среды из файла YAML спецификации среды. Сведения о получении файла YAML спецификации среды см. в руководстве по управлению средами в руководстве пользователя conda.
from_docker_build_context	Создайте объект среды из контекста сборки Docker.
from_docker_image	Создайте объект среды из базового образа Docker с необязательными зависимостями Python. Уровень Python будет добавлен в среду, если указан conda_specification или pip_requirements. conda_specification и pip_requirements являются взаимоисключающими.
from_dockerfile	Создайте объект среды из Dockerfile с необязательными зависимостями Python. Уровень Python будет добавлен в среду, если указан conda_specification или pip_requirements. conda_specification и pip_requirements являются взаимоисключающими.
from_existing_conda_environment	Создайте объект среды, созданный из локально существующей среды conda. Чтобы получить список существующих сред conda, выполните команду `conda env list`. Дополнительные сведения см. в руководстве пользователя по управлению средами conda.
from_pip_requirements	Создайте объект среды, созданный из файла требований pip. Если pip_version не указана pip_version, будет добавлена открепленная зависимость pip.
get	Возвращает объект среды. Если указана метка, объект, ранее помеченный значением, будет возвращен. Можно указать только один из параметров версии или метки. Если оба отсутствуют, будет возвращена последняя версия объекта Environment.
get_image_details	Верните сведения о изображении.
label	Объект среды метки в рабочей области с указанными значениями.
list	Возвращает словарь, содержащий среды в рабочей области.
load_from_directory	Загрузите определение среды из файлов в каталоге.
register	Зарегистрируйте объект среды в рабочей области.
save_to_directory	Сохраните определение среды в каталоге в легко редактируемом формате.

add_private_pip_wheel

Отправьте файл частного колеса pip на диск в большой двоичный объект хранилища Azure, подключенный к рабочей области.

Создает исключение, если частное колесо pip с тем же именем уже существует в BLOB-объекте хранилища рабочей области.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Параметры

Имя	Описание
workspace Обязательно	Workspace Объект рабочей области, используемый для регистрации частного колеса pip.
file_path Обязательно	str Путь к локальному колесу pip на диске, включая расширение файла.
exist_ok	bool Указывает, следует ли вызывать исключение, если колесо уже существует. Default value: False

Возвращаемое значение

Тип	Описание
str	Возвращает полный универсальный код ресурса (URI) отправленного колеса pip в хранилище BLOB-объектов Azure для использования в зависимости conda.

build

Создайте образ Docker для этой среды в облаке.

build(workspace, image_build_compute=None)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область и связанный с ним реестр контейнеров Azure, где хранится образ.
image_build_compute	str Имя вычисления, в котором будет выполняться сборка образа Default value: None

Возвращаемое значение

Тип	Описание
ImageBuildDetails	Возвращает объект сведений о сборке образа.

build_local

Создайте локальную среду Docker или conda.

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область.
platform	str Платформа. Одна из Linux, Windows или OSX. Текущая платформа будет использоваться по умолчанию. Default value: None
kwargs Обязательно	dict Расширенные аргументы ключевых слов

Возвращаемое значение

Тип	Описание
str	Потоковая передача встроенных выходных данных Docker или conda в консоль.

clone

Клонируйте объект среды.

Возвращает новый экземпляр объекта среды с новым именем.

clone(new_name)

Параметры

Имя	Описание
new_name Обязательно	str Новое имя среды

Возвращаемое значение

Тип	Описание
Environment	Новый объект среды

from_conda_specification

Создайте объект среды из файла YAML спецификации среды.

Сведения о получении файла YAML спецификации среды см. в руководстве по управлению средами в руководстве пользователя conda.

static from_conda_specification(name, file_path)

Параметры

Имя	Описание
name Обязательно	str Имя среды.
file_path Обязательно	str Путь к файлу YAML спецификации среды conda.

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

from_docker_build_context

Создайте объект среды из контекста сборки Docker.

static from_docker_build_context(name, docker_build_context)

Параметры

Имя	Описание
name Обязательно	str Имя среды.
docker_build_context Обязательно	DockerBuildContext Объект DockerBuildContext.

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

from_docker_image

Создайте объект среды из базового образа Docker с необязательными зависимостями Python.

Уровень Python будет добавлен в среду, если указан conda_specification или pip_requirements. conda_specification и pip_requirements являются взаимоисключающими.

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

Параметры

Имя	Описание
name Обязательно	str Имя среды.
image Обязательно	str полное имя изображения.
conda_specification	str Файл спецификации conda. Default value: None
container_registry	ContainerRegistry сведения о частном репозитории контейнеров. Default value: None
pip_requirements	str Файл требований pip. Default value: None

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

from_dockerfile

Создайте объект среды из Dockerfile с необязательными зависимостями Python.

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

Параметры

Имя	Описание
name Обязательно	str Имя среды.
dockerfile Обязательно	str Содержимое dockerfile или путь к файлу.
conda_specification	str Файл спецификации conda. Default value: None
pip_requirements	str Файл требований pip. Default value: None

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

from_existing_conda_environment

Создайте объект среды, созданный из локально существующей среды conda.

Чтобы получить список существующих сред conda, выполните команду conda env list. Дополнительные сведения см. в руководстве пользователя по управлению средами conda.

static from_existing_conda_environment(name, conda_environment_name)

Параметры

Имя	Описание
name Обязательно	str Имя среды.
conda_environment_name Обязательно	str Имя локально существующей среды conda.

Возвращаемое значение

Тип	Описание
Environment	Объект среды или None, если экспорт файла спецификации conda завершается сбоем.

from_pip_requirements

Создайте объект среды, созданный из файла требований pip.

Если pip_version не указана pip_version, будет добавлена открепленная зависимость pip.

static from_pip_requirements(name, file_path, pip_version=None)

Параметры

Имя	Описание
name Обязательно	str Имя среды.
file_path Обязательно	str Путь к файлу требований к pip.
pip_version	str Версия Pip для среды conda. Default value: None

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

get

Возвращает объект среды.

Если указана метка, объект, ранее помеченный значением, будет возвращен. Можно указать только один из параметров версии или метки. Если оба отсутствуют, будет возвращена последняя версия объекта Environment.

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

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, содержащая среду.
name Обязательно	str Имя возвращаемой среды.
version	str Версия возвращаемой среды. Default value: None
label	str Значение метки среды. Default value: None

Возвращаемое значение

Тип	Описание
Environment	Объект среды.

get_image_details

Верните сведения о изображении.

get_image_details(workspace)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область.

Возвращаемое значение

Тип	Описание
DockerImageDetails	Возвращает сведения о изображении в виде дикта

label

Объект среды метки в рабочей области с указанными значениями.

static label(workspace, name, version, labels)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область
name Обязательно	str Имя среды
version Обязательно	str Версия среды
labels Обязательно	list[str] Значения для метки среды с помощью

list

Возвращает словарь, содержащий среды в рабочей области.

static list(workspace)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область, из которой будет отображаться среда.

Возвращаемое значение

Тип	Описание
<xref:builtin.dict>[str, Environment]	Словарь объектов среды.

load_from_directory

Загрузите определение среды из файлов в каталоге.

static load_from_directory(path)

Параметры

Имя	Описание
path Обязательно	str Путь к исходному каталогу.

register

Зарегистрируйте объект среды в рабочей области.

register(workspace)

Параметры

Имя	Описание
workspace Обязательно	Workspace Рабочая область
name Обязательно	str

Возвращаемое значение

Тип	Описание
Environment	Возвращает объект среды

save_to_directory

Сохраните определение среды в каталоге в легко редактируемом формате.

save_to_directory(path, overwrite=False)

Параметры

Имя	Описание
path Обязательно	str Путь к целевому каталогу.
overwrite	bool Если существующий каталог должен быть перезаписан. Значение по умолчанию — false. Default value: False

Атрибуты

environment_variables

Используйте объект azureml.core.RunConfiguration для задания переменных среды выполнения.

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Environment Класс

Конструктор

Параметры

Комментарии

Переменные

Методы

add_private_pip_wheel

Параметры

Возвращаемое значение

build

Параметры

Возвращаемое значение

build_local

Параметры

Возвращаемое значение

Комментарии

clone

Параметры

Возвращаемое значение

from_conda_specification

Параметры

Возвращаемое значение

from_docker_build_context

Параметры

Возвращаемое значение

from_docker_image

Параметры

Возвращаемое значение

Комментарии

from_dockerfile

Параметры

Возвращаемое значение

from_existing_conda_environment

Параметры

Возвращаемое значение

from_pip_requirements

Параметры

Возвращаемое значение

get

Параметры

Возвращаемое значение

get_image_details

Параметры

Возвращаемое значение

label

Параметры

list

Параметры

Возвращаемое значение

load_from_directory

Параметры

register

Параметры

Возвращаемое значение

save_to_directory

Параметры

Атрибуты

environment_variables

Обратная связь