CommandComponent Класс
Версия компонента команды, используемая для определения компонента или задания команды.
- Наследование
-
azure.ai.ml.entities._component.component.ComponentCommandComponentazure.ai.ml.entities._job.parameterized_command.ParameterizedCommandCommandComponentazure.ai.ml.entities._component._additional_includes.AdditionalIncludesMixinCommandComponent
Конструктор
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
|
Имя задания или компонента command. |
version
|
Версия задания или компонента Command. |
description
|
Описание компонента. Значение по умолчанию — None (Нет). |
tags
|
Словарь тегов. Теги можно добавлять, удалять и обновлять. Значение по умолчанию — None (Нет). |
display_name
|
Отображаемое имя компонента. |
command
|
Команда для выполнения. |
code
|
Исходный код для запуска задания. Может быть локальным путем или URL-адресом "http:", "https:" или "azureml:", указывающим на удаленное расположение. |
environment
|
Среда, в которой будет выполняться задание. |
distribution
|
Конфигурация для распределенных заданий. Значение по умолчанию — None (Нет). |
resources
|
Конфигурация вычислительного ресурса для команды. |
inputs
|
Сопоставление имен входных данных с источниками входных данных, используемыми в задании. Значение по умолчанию — None (Нет). |
outputs
|
Сопоставление имен выходных данных с источниками выходных данных, используемыми в задании. Значение по умолчанию — None (Нет). |
instance_count
|
Количество экземпляров или узлов, используемых целевым объектом вычислений. По умолчанию равен 1. |
is_deterministic
|
Указывает, будет ли команда возвращать те же выходные данные при одинаковых входных данных. Значение по умолчанию — True. При значении True, если команда (компонент) детерминирована и была выполнена ранее в текущей рабочей области с теми же входными данными и параметрами, она будет повторно использовать результаты предыдущего отправленного задания при использовании в качестве узла или шага в конвейере. В этом сценарии вычислительные ресурсы не будут использоваться. значение по умолчанию: True
|
additional_includes
|
Список общих дополнительных файлов, которые будут включены в компонент. Значение по умолчанию — None (Нет). |
properties
|
Словарь свойств задания. Значение по умолчанию — 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
Обязательно
|
Назначение для получения содержимого этого компонента. Должен быть либо путь к локальному файлу, либо уже открытый файловый поток. Если dest — это путь к файлу, будет создан новый файл, а если файл существует, возникает исключение. Если dest является открытым файлом, файл будет записан в напрямую, а если файл недоступен для записи, будет создано исключение. |
Атрибуты
base_path
creation_context
Контекст создания ресурса.
Возвращаемое значение
Тип | Описание |
---|---|
Метаданные создания для ресурса. |
display_name
distribution
Конфигурация для компонента или задания распределенных команд.
Возвращаемое значение
Тип | Описание |
---|---|
Конфигурация распределения. |
id
Идентификатор ресурса.
Возвращаемое значение
Тип | Описание |
---|---|
Глобальный идентификатор ресурса, идентификатор Azure Resource Manager (ARM). |
inputs
instance_count
Количество экземпляров или узлов, используемых целевым объектом вычислений.
Возвращаемое значение
Тип | Описание |
---|---|
Количество экземпляров или узлов. |
is_deterministic
Является ли компонент детерминированным.
Возвращаемое значение
Тип | Описание |
---|---|
Является ли компонент детерминированным |
outputs
resources
Конфигурация вычислительного ресурса для компонента или задания команды.
Возвращаемое значение
Тип | Описание |
---|---|
Конфигурация вычислительного ресурса для компонента или задания команды. |
type
version
Azure SDK for Python