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

ComponentOperations Класс

  • Ссылка

ComponentOperations.

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

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

Конструктор

ComponentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, preflight_operation: DeploymentsOperations | None = None, **kwargs: Dict)

Параметры

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

Операция область.

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

Конфигурация операции.

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

Клиент службы для операций API.

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

Контейнер для всех доступных операций.

preflight_operation
Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
значение по умолчанию: None

Операция предварительной проверки для развертываний.

kwargs
Dict
Обязательно

Дополнительные аргументы ключевое слово.

Методы

archive

Архивация компонента.
create_or_update

Создайте или обновите указанный компонент. Если есть встроенные определенные сущности, например Среда, Код, они будут созданы вместе с компонентом.
download

Примечание

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

Скачайте указанный компонент и его зависимости в локальную среду. Локальный компонент можно использовать для создания компонента в другой рабочей области или для автономной разработки.
get

Возвращает сведения об указанном компоненте.
list

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

Восстановление архивированного компонента.
validate

Примечание

Это экспериментальный метод, который может быть изменен в любое время. Дополнительные сведения см. по адресу 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.components.archive(name=component_example.name)

create_or_update

Создайте или обновите указанный компонент. Если есть встроенные определенные сущности, например Среда, Код, они будут созданы вместе с компонентом.

create_or_update(component: Component | function, version=None, *, skip_validation: bool = False, **kwargs) -> Component

Параметры

component
Union[Component, FunctionType]
Обязательно

Объект компонента или компонентная функция mldesigner, создающая объект компонента

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

Версия компонента для переопределения.

skip_validation
bool

следует ли пропустить проверку перед созданием или обновлением компонента. Значение по умолчанию — False.

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

Указанный объект компонента.

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

Component

Исключения

ValidationException

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

AssetException

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

ComponentException

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

ModelException

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

EmptyDirectoryError

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

Примеры

Пример создания компонента.


   from azure.ai.ml import load_component
   from azure.ai.ml.entities._component.component import Component

   component_example = load_component(
       source="./sdk/ml/azure-ai-ml/tests/test_configs/components/helloworld_component.yml",
       params_override=[{"version": "1.0.2"}],
   )
   component = ml_client.components.create_or_update(component_example)

download

Примечание

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

Скачайте указанный компонент и его зависимости в локальную среду. Локальный компонент можно использовать для создания компонента в другой рабочей области или для автономной разработки.

download(name: str, download_path: PathLike | str = '.', *, version: str = None) -> None

Параметры

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

Имя компонента кода.

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

Локальный путь в качестве назначения загрузки по умолчанию использует текущий рабочий каталог текущего пользователя. Будет создан, если не существует.

version
Optional[str]

Версия компонента.

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

Указанный объект компонента.

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

Component

Исключения

OSError

Возникает, если download_path указывает на существующий каталог, который не является пустым. идентифицируется и извлекается. Подробные сведения будут указаны в сообщении об ошибке.

get

Возвращает сведения об указанном компоненте.

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

Параметры

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

Имя компонента кода.

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

Версия компонента.

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

Метка компонента, взаимоисключаемая с версией.

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

Указанный объект компонента.

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

Component

Исключения

ValidationException

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

Примеры

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


   ml_client.components.get(name=component_example.name, version="1.0.2")

list

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

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

Параметры

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

Имя компонента, если оно не задано, выведите список всех компонентов рабочей области

list_view_type

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

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

Итератор, например экземпляр объектов компонента

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

ItemPaged[Component]

Примеры

Пример компонента списка.


   print(ml_client.components.list())

restore

Восстановление архивированного компонента.

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

Параметры

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

Имя компонента.

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

Версия компонента.

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

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

Примеры

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


   ml_client.components.restore(name=component_example.name)

validate

Примечание

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

проверка указанного компонента. Если есть встроенные определенные сущности, например Среда, Код, они не будут созданы.

validate(component: Component | function, raise_on_failure: bool = False, **kwargs) -> ValidationResult

Параметры

component
Union[Component, FunctionType]
Обязательно

Объект компонента или компонентная функция mldesigner, создающая объект компонента

raise_on_failure
bool
Обязательно

Следует ли вызывать исключение при ошибке проверки. Значение по умолчанию — False.

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

Все ошибки проверки

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

ValidationResult