CommandComponent Класс

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

Наследование

azure.ai.ml.entities._component.component.Component

CommandComponent

azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand

CommandComponent

azure.ai.ml.entities._component._additional_includes.AdditionalIncludesMixin

CommandComponent

Конструктор

CommandComponent(*, name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, command: str | None = None, code: PathLike | str | None = None, environment: Environment | str | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution | PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None, resources: JobResourceConfiguration | None = None, inputs: Dict | None = None, outputs: Dict | None = None, instance_count: int | None = None, is_deterministic: bool = True, additional_includes: List | None = None, properties: Dict | None = None, **kwargs: Any)

Параметры Keyword-Only

Имя	Описание
name	Optional[str] Имя задания или компонента command.
version	Optional[str] Версия задания или компонента Command.
description	Optional[str] Описание компонента. Значение по умолчанию — None (Нет).
tags	Optional[dict] Словарь тегов. Теги можно добавлять, удалять и обновлять. Значение по умолчанию — None (Нет).
display_name	Optional[str] Отображаемое имя компонента.
command	Optional[str] Команда для выполнения.
code	Исходный код для запуска задания. Может быть локальным путем или URL-адресом "http:", "https:" или "azureml:", указывающим на удаленное расположение.
environment	Optional[Union[str, Environment]] Среда, в которой будет выполняться задание.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] Конфигурация для распределенных заданий. Значение по умолчанию — None (Нет).
resources	Optional[JobResourceConfiguration] Конфигурация вычислительного ресурса для команды.
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Сопоставление имен входных данных с источниками входных данных, используемыми в задании. Значение по умолчанию — None (Нет).
outputs	Optional[dict[str, Union[str, Output]]] Сопоставление имен выходных данных с источниками выходных данных, используемыми в задании. Значение по умолчанию — None (Нет).
instance_count	Optional[int] Количество экземпляров или узлов, используемых целевым объектом вычислений. По умолчанию равен 1.
is_deterministic	Optional[bool] Указывает, будет ли команда возвращать те же выходные данные при одинаковых входных данных. Значение по умолчанию — True. При значении True, если команда (компонент) детерминирована и была выполнена ранее в текущей рабочей области с теми же входными данными и параметрами, она будет повторно использовать результаты предыдущего отправленного задания при использовании в качестве узла или шага в конвейере. В этом сценарии вычислительные ресурсы не будут использоваться. значение по умолчанию: True
additional_includes	Optional[List[str]] Список общих дополнительных файлов, которые будут включены в компонент. Значение по умолчанию — None (Нет).
properties	Optional[dict[str, str]] Словарь свойств задания. Значение по умолчанию — None (Нет).

Примеры

Создание CommandComponent.

   from azure.ai.ml.entities import CommandComponent

   component = CommandComponent(
       name="sample_command_component_basic",
       display_name="CommandComponentBasic",
       description="This is the basic command component",
       tags={"tag": "tagvalue", "owner": "sdkteam"},
       version="1",
       outputs={"component_out_path": {"type": "uri_folder"}},
       command="echo Hello World",
       code="./src",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
   )

Методы

dump	Дамп содержимого компонента в файл в формате yaml.

dump

Дамп содержимого компонента в файл в формате yaml.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Параметры

Имя	Описание
dest Обязательно	Union[<xref:PathLike>, str, IO[AnyStr]] Назначение для получения содержимого этого компонента. Должен быть либо путь к локальному файлу, либо уже открытый файловый поток. Если dest — это путь к файлу, будет создан новый файл, а если файл существует, возникает исключение. Если dest является открытым файлом, файл будет записан в напрямую, а если файл недоступен для записи, будет создано исключение.

Атрибуты

base_path

Базовый путь к ресурсу.

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

Тип	Описание
str	Базовый путь к ресурсу.

creation_context

Контекст создания ресурса.

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

Тип	Описание
Optional[SystemData]	Метаданные создания для ресурса.

display_name

Отображаемое имя компонента.

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

Тип	Описание
str	Отображаемое имя компонента.

distribution

Конфигурация для компонента или задания распределенных команд.

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

Тип	Описание
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	Конфигурация распределения.

id

Идентификатор ресурса.

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

Тип	Описание
Optional[str]	Глобальный идентификатор ресурса, идентификатор Azure Resource Manager (ARM).

inputs

Входные данные компонента.

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

Тип	Описание
dict	Входные данные компонента.

instance_count

Количество экземпляров или узлов, используемых целевым объектом вычислений.

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

Тип	Описание
int	Количество экземпляров или узлов.

is_deterministic

Является ли компонент детерминированным.

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

Тип	Описание
bool	Является ли компонент детерминированным

outputs

Выходные данные компонента.

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

Тип	Описание
dict	Выходные данные компонента.

resources

Конфигурация вычислительного ресурса для компонента или задания команды.

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

Тип	Описание
JobResourceConfiguration	Конфигурация вычислительного ресурса для компонента или задания команды.

type

Тип компонента по умолчанию — command.

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

Тип	Описание
str	Тип компонента.

version

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

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

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