你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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)

仅限关键字的参数

名称	说明
name	Optional[str] 命令作业或组件的名称。
version	Optional[str] 命令作业或组件的版本。
description	Optional[str] 组件的说明。默认值为“None”。
tags	Optional[dict] 标记字典。可以添加、删除和更新标记。默认值为“None”。
display_name	Optional[str] 组件的显示名称。
command	Optional[str] 要执行的命令。
code	用于运行作业的源代码。可以是指向远程位置的本地路径或“http：”、“https：”或“azureml：”URL。
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

资源 ID。

类型	说明
Optional[str]	资源的全局 ID，Azure 资源管理器 (ARM) ID。

inputs

组件的输入。

类型	说明
dict	组件的输入。

instance_count

计算目标要使用的实例或节点数。

类型	说明
int	实例或节点数。

is_deterministic

组件是否是确定性的。

类型	说明
bool	组件是否是确定性的

outputs

组件的输出。

类型	说明
dict	组件的输出。

resources

命令组件或作业的计算资源配置。

类型	说明
JobResourceConfiguration	命令组件或作业的计算资源配置。

type

组件的类型，默认值为“command”。

类型	说明
str	组件的类型。

version

组件的版本。

类型	说明
str	组件的版本。

Share via