EnvironmentOperations Класс

  • Ссылка

EnvironmentOperations.

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

Наследование
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
EnvironmentOperations

Конструктор

EnvironmentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, **kwargs: Any)

Параметры

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
Обязательно

Переменные области для классов операций объекта MLClient.

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
Обязательно

Общая конфигурация для классов операций объекта MLClient.

service_client
Union[ <xref:azure.ai.ml._restclient.v2023_04_01_preview._azure_machine_learning_workspaces.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview._azure_machine_learning_workspaces. AzureMachineLearningWorkspaces>]
Обязательно

Клиент службы, позволяющий конечным пользователям работать с ресурсами рабочей области Машинного обучения Azure (ServiceClient042023Preview или ServiceClient102021Dataplane).

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Обязательно

Все классы операций объекта MLClient.

Методы

archive

Архивация среды или версии среды.
create_or_update

Возвращает созданный или обновленный ресурс среды.
get

Возвращает указанный ресурс среды.
list

Вывод списка всех ресурсов среды в рабочей области.
restore

Восстановление архивной версии среды.
share

Примечание

Это экспериментальный метод, который может быть изменен в любое время. Дополнительные сведения см. по адресу https://aka.ms/azuremlexperimental.

Предоставление общего доступа к ресурсу среды из рабочей области в реестр.

archive

Архивация среды или версии среды.

archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Параметры

name
str
Обязательно

Имя среды.

version
str
Обязательно

Версия среды.

label
str
Обязательно

Метка среды. (взаимоисключающий с версией)

Примеры

Пример архивирования.


   ml_client.environments.archive("create-environment", "2.0")

create_or_update

Возвращает созданный или обновленный ресурс среды.

create_or_update(environment: Environment) -> Environment

Параметры

environment
<xref:azure.ai.ml.entities._assets.Environment>
Обязательно

Объект среды

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

Созданный или обновленный объект Environment

Возвращаемый тип

Environment

Исключения

ValidationException

Возникает, если не удается успешно проверить среду. Подробные сведения будут указаны в сообщении об ошибке.

EmptyDirectoryError

Возникает, если указанный локальный путь указывает на пустой каталог.

Примеры

Создание среды.


   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )
   ml_client.environments.create_or_update(env_docker_context)

get

Возвращает указанный ресурс среды.

get(name: str, version: str | None = None, label: str | None = None) -> Environment

Параметры

name
str
Обязательно

Имя среды.

version
str
Обязательно

Версия среды.

label
str
Обязательно

Метка среды. (взаимоисключающий с версией)

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

Объект среды

Возвращаемый тип

Environment

Исключения

ValidationException

Возникает, если не удается успешно проверить среду. Подробные сведения будут указаны в сообщении об ошибке.

Примеры

Получите пример.


   ml_client.environments.get("create-environment", "2.0")

list

Вывод списка всех ресурсов среды в рабочей области.

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Environment]

Параметры

name
Optional[str]
Обязательно

Имя среды.

list_view_type

Тип представления для включения и исключения (например) архивных сред. По умолчанию: ACTIVE_ONLY.

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

Итератор, подобный экземпляру объектов Среды.

Возвращаемый тип

ItemPaged[Environment]

Примеры

Пример списка.


   ml_client.environments.list()

restore

Восстановление архивной версии среды.

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Параметры

name
str
Обязательно

Имя среды.

version
str
Обязательно

Версия среды.

label
str
Обязательно

Метка среды. (взаимоисключающий с версией)

Примеры

Пример восстановления.


   ml_client.environments.restore("create-environment", "2.0")

share

Примечание

Это экспериментальный метод, который может быть изменен в любое время. Дополнительные сведения см. по адресу https://aka.ms/azuremlexperimental.

Предоставление общего доступа к ресурсу среды из рабочей области в реестр.

share(name: str, version: str, *, share_with_name: str, share_with_version: str, registry_name: str) -> Environment

Параметры

name
str
Обязательно

Имя ресурса среды.

version
str
Обязательно

Версия ресурса среды.

share_with_name
str

Имя ресурса среды для совместного использования.

share_with_version
str

Версия ресурса среды для совместного использования.

registry_name
str

Имя целевого реестра.

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

Объект ресурса среды.

Возвращаемый тип

Environment