Environment Класс
Настраивает воспроизводимую среду Python для экспериментов с машинным обучением.
Среда определяет пакеты Python, переменные среды и параметры Docker, используемые в экспериментах машинного обучения, включая подготовку данных, обучение и развертывание в веб-службе. Управление средой и ее версиями осуществляется в Машинном обучении Azure Workspace. Вы можете обновить существующую среду и получить версию для повторного использования. Среды являются уникальными для рабочей области, в которой они созданы, и не могут быть использованы в других рабочих областях.
Дополнительные сведения о средах см. в статье Создание повторно используемых сред и управление ими.
Конструктор среды класса.
- Наследование
-
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElementEnvironment
Конструктор
Environment(name, **kwargs)
Параметры
- name
- string
Имя среды.
Примечание
Не начинайте имя среды с "Microsoft" или "AzureML". Префиксы "Microsoft" и "AzureML" зарезервированы для курируемых сред. Для получения дополнительной информации о курируемых средах см. Создание повторно используемых сред и управление ими.
Комментарии
Машинное обучение Azure предоставляет курируемые среды, являющиеся предварительно заданными средами, предлагающими хорошие отправные точки для создания собственных сред. Курируемые среды поддерживаются кэшированными образами Docker, что обеспечивает снижение затрат на подготовку к запуску. Для получения дополнительной информации о курируемых средах см. Создание повторно используемых сред и управление ими.
Существует ряд способов создания сред в Машинном обучении Azure, включая следующие шаги:
Инициализация нового объекта среды.
Использование одного из методов класса среды: from_conda_specification, from_pip_requirements или from_existing_conda_environment.
Использование метода submit класса эксперимента, чтобы отправить запуск эксперимента без указания среды, в том числе с помощью объекта Estimator.
В следующем примере показано, как создавать экземпляр новой среды.
from azureml.core import Environment
myenv = Environment(name="myenv")
Вы можете управлять средой, зарегистрировав ее. Это позволяет отслеживать версии среды и повторно использовать их в будущих запусках.
myenv.register(workspace=ws)
Дополнительные примеры работы со средами см. в Jupyter Notebook Использование сред.
Переменные
- 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 wheel на диске в хранилище BLOB-объектов Azure, подключенное к рабочей области. Создает исключение, если в хранилище BLOB-объектов рабочей области уже существует частное pip wheel с тем же именем. |
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, выполните команду |
from_pip_requirements |
Создайте объект среды из файла требований PIP. Открепленная зависимость PIP будет добавлена, если не указан параметр pip_version. |
get |
Возвращает объект среды. Если указана метка, будет возвращен объект, ранее помеченный значением. Можно указать только одну из версий или один из параметров метки. Если оба этих параметра отсутствуют, будет возвращена последняя версия объекта среды. |
get_image_details |
Возвращает сведения об образе. |
label |
Пометка объекта среды в рабочей области с указанными значениями. |
list |
Возврат словаря, содержащего среды в рабочей области. |
load_from_directory |
Загрузка определения среды из файлов в каталоге. |
register |
Регистрация объекта среды в рабочей области. |
save_to_directory |
Сохранение определения среды в каталоге в удобном для редактирования формате. |
add_private_pip_wheel
Отправка закрытого файла pip wheel на диске в хранилище BLOB-объектов Azure, подключенное к рабочей области.
Создает исключение, если в хранилище BLOB-объектов рабочей области уже существует частное pip wheel с тем же именем.
static add_private_pip_wheel(workspace, file_path, exist_ok=False)
Параметры
- workspace
- Workspace
Объект рабочей области, используемый для регистрации частного pip wheel.
- exist_ok
- bool
Указывает, следует ли создавать исключение, если wheel уже существует.
Возвращаемое значение
Возвращает полный URI переданного pip wheel в хранилище BLOB-объектов Azure для использования в зависимостях Conda.
Возвращаемый тип
build
Создание образа Docker для этой среды в облаке.
build(workspace, image_build_compute=None)
Параметры
- workspace
- Workspace
Рабочая область и связанный с ней Реестр контейнеров Azure, где хранится образ.
- image_build_compute
- str
Имя вычислений, где будет происходить сборка образа
Возвращаемое значение
Возвращает объект сведений о сборке образа.
Возвращаемый тип
build_local
Создание локальной среды Docker или Conda.
build_local(workspace, platform=None, **kwargs)
Параметры
- platform
- str
Платформа. Одна из Linux, Windows или OSX. Текущая платформа будет использоваться по умолчанию.
Возвращаемое значение
Передает потоки выходных данных сборки текущей среды Docker или Conda на консоль.
Возвращаемый тип
Комментарии
В следующих примерах показано, как создать локальную среду. Убедитесь, что экземпляр рабочей области создан как допустимый объект azureml.core.workspace.Workspace
Создание локальной среды Conda
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace)
Создание локальной среды Docker
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace, useDocker=True)
Создание образа Docker локально и при необходимости отправка его в реестр контейнеров, связанный с рабочей областью
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(new_name)
Параметры
Возвращаемое значение
Новый объект среды
Возвращаемый тип
from_conda_specification
Создание объекта среды из файла YAML спецификации среды.
Для получения файла YAML спецификации среды см. Управление средами в руководстве пользователя Conda.
static from_conda_specification(name, file_path)
Параметры
Возвращаемое значение
Объект среды.
Возвращаемый тип
from_docker_build_context
Создание объекта среды из контекста сборки Docker.
static from_docker_build_context(name, docker_build_context)
Параметры
Возвращаемое значение
Объект среды.
Возвращаемый тип
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)
Параметры
- container_registry
- ContainerRegistry
сведения о репозитории закрытых контейнеров.
Возвращаемое значение
Объект среды.
Возвращаемый тип
Комментарии
Если базовый образ относится к частному репозиторию, для которого требуется авторизация, а авторизация не установлена на уровне рабочей области AzureML, container_registry является обязательным
from_dockerfile
Создайте объект среды из Dockerfile с необязательными зависимостями Python.
Слой Python будет добавлен в среду, если указан параметр conda_specification или pip_requirements. conda_specification и pip_requirements являются взаимоисключающими.
static from_dockerfile(name, dockerfile, conda_specification=None, pip_requirements=None)
Параметры
Возвращаемое значение
Объект среды.
Возвращаемый тип
from_existing_conda_environment
Создайте объект среды из локально существующей среды Conda.
Для получения списка существующих сред Conda, выполните команду conda env list
. Для получения дополнительной информации см. Управление средами в руководстве пользователя Conda.
static from_existing_conda_environment(name, conda_environment_name)
Параметры
Возвращаемое значение
Объект среды или None, если экспорт файла спецификации Conda завершается ошибкой.
Возвращаемый тип
from_pip_requirements
Создайте объект среды из файла требований PIP.
Открепленная зависимость PIP будет добавлена, если не указан параметр pip_version.
static from_pip_requirements(name, file_path, pip_version=None)
Параметры
Возвращаемое значение
Объект среды.
Возвращаемый тип
get
Возвращает объект среды.
Если указана метка, будет возвращен объект, ранее помеченный значением. Можно указать только одну из версий или один из параметров метки. Если оба этих параметра отсутствуют, будет возвращена последняя версия объекта среды.
static get(workspace, name, version=None, label=None)
Параметры
Возвращаемое значение
Объект среды.
Возвращаемый тип
get_image_details
Возвращает сведения об образе.
get_image_details(workspace)
Параметры
Возвращаемое значение
Возвращает сведения об изображении в качестве словаря
Возвращаемый тип
label
Пометка объекта среды в рабочей области с указанными значениями.
static label(workspace, name, version, labels)
Параметры
list
Возврат словаря, содержащего среды в рабочей области.
static list(workspace)
Параметры
Возвращаемое значение
Словарь объектов среды.
Возвращаемый тип
load_from_directory
Загрузка определения среды из файлов в каталоге.
static load_from_directory(path)
Параметры
register
Регистрация объекта среды в рабочей области.
register(workspace)
Параметры
- name
- str
Возвращаемое значение
Возвращает объект среды
Возвращаемый тип
save_to_directory
Сохранение определения среды в каталоге в удобном для редактирования формате.
save_to_directory(path, overwrite=False)
Параметры
- overwrite
- bool
В случае, если существующий каталог должен быть перезаписан. Значение по умолчанию — false.
Атрибуты
environment_variables
Используйте объект azureml.core.RunConfiguration для задания переменных среды выполнения.
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по