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

Pipeline 类

  • 参考

管道节点的基类，用于管道组件版本消耗。 不应直接实例化此类。 相反，应使用 @pipeline 修饰器创建管道节点。

继承
azure.ai.ml.entities._builders.base_node.BaseNode
Pipeline

构造函数

Pipeline(*, component: Component | str, inputs: Dict[str, Input | str | bool | int | float | Enum] | None = None, outputs: Dict[str, str | Output] | None = None, settings: PipelineJobSettings | None = None, **kwargs)

参数

component
Union[Component, str]
必需

要为步骤运行的管道组件/作业的 ID 或实例。

inputs
Optional[Dict[str, Union[ <xref:azure.ai.ml.entities.Input>, str, bool, int, float, <xref:Enum>, <xref:"Input">]]]<xref:./>
必需

管道节点的输入。

outputs
Optional[Dict[str, Union[str, <xref:azure.ai.ml.entities.Output>, <xref:"Output">]]]
必需

管道节点的输出。

settings
Optional[PipelineJobSettings]
必需

管道节点的设置，仅对根管道作业生效。

方法

clear
copy
dump

将作业内容转储到 YAML 格式的文件中。
fromkeys

使用可迭代键并将值设置为 value 的新字典。
get

如果 key 在字典中，则返回 key 的值，否则返回默认值。
items
keys
pop

如果未找到密钥，则返回默认值（如果给定）;否则，引发 KeyError。
popitem

删除并返回 (键、值) 对作为 2 元组。

对以 LIFO (后进先出) 顺序返回。 如果 dict 为空，则引发 KeyError。
setdefault

如果键不在字典中，则插入值为默认值的键。

如果 key 在字典中，则返回 key 的值，否则返回默认值。
update

如果 E 存在并且具有 .keys () 方法，则对于 E 中的 k： D[k] = E[k] 如果 E 存在且缺少 .keys () 方法，则 为 k，在 E 中为 v：D[k] = v 在任一情况下，这后跟：f 中的 k： D[k] = F[k] = F[k]
values

clear 

clear() -> None.  Remove all items from D.

copy 

copy() -> a shallow copy of D

dump

将作业内容转储到 YAML 格式的文件中。

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

参数

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必需

要向其写入 YAML 内容的本地路径或文件流。 如果 dest 是文件路径，则将创建一个新文件。 如果 dest 是打开的文件，则将直接写入该文件。

kwargs
dict

要传递给 YAML 序列化程序的其他参数。

例外

FileExistsError

如果 dest 是文件路径且文件已存在，则引发。

IOError

如果 dest 是打开的文件且文件不可写，则引发。

fromkeys

使用可迭代键并将值设置为 value 的新字典。

fromkeys(value=None, /)

参数

type
必需
iterable
必需
value
默认值: None

get

如果 key 在字典中，则返回 key 的值，否则返回默认值。

get(key, default=None, /)

参数

key
必需
default
默认值: None

items 

items() -> a set-like object providing a view on D's items

keys 

keys() -> a set-like object providing a view on D's keys

pop

如果未找到密钥，则返回默认值（如果给定）;否则，引发 KeyError。

pop(k, [d]) -> v, remove specified key and return the corresponding value.

popitem

删除并返回 (键、值) 对作为 2 元组。

对以 LIFO (后进先出) 顺序返回。 如果 dict 为空，则引发 KeyError。

popitem()

setdefault

如果键不在字典中，则插入值为默认值的键。

如果 key 在字典中，则返回 key 的值，否则返回默认值。

setdefault(key, default=None, /)

参数

key
必需
default
默认值: None

update

如果 E 存在并且具有 .keys () 方法，则对于 E 中的 k： D[k] = E[k] 如果 E 存在且缺少 .keys () 方法，则 为 k，在 E 中为 v：D[k] = v 在任一情况下，这后跟：f 中的 k： D[k] = F[k] = F[k]

update([E], **F) -> None.  Update D from dict/iterable E and F.

values 

values() -> an object providing a view on D's values

属性

base_path

资源的基路径。

返回

资源的基路径。

返回类型

str

component

要为步骤运行的管道组件/作业的 ID 或实例。

返回

管道组件/作业的 ID 或实例。

返回类型

Union[str, Component]

creation_context

资源的创建上下文。

返回

资源的创建元数据。

返回类型

Optional[SystemData]

id

资源 ID。

返回

资源的全局 ID，Azure 资源管理器 (ARM) ID。

返回类型

Optional[str]

inputs

获取 对象的输入。

返回

包含 对象的输入的字典。

返回类型

Dict[str, Union[Input, str, bool, int, float]]

log_files

作业输出文件。

返回

日志名称和 URL 的字典。

返回类型

Optional[Dict[str, str]]

name

获取节点的名称。

返回

节点的名称。

返回类型

str

outputs

获取 对象的输出。

返回

包含 对象的输出的字典。

返回类型

Dict[str, Union[str, Output]]

settings

管道的设置。

注意：仅当将节点创建为作业时，设置才可用。 即 ml_client.jobs.create_or_update (节点) 。

返回

管道的设置。

返回类型

PipelineJobSettings

status

作业的状态。

返回的常见值包括“正在运行”、“已完成”和“失败”。 所有可能的值为：

  • NotStarted - 这是客户端 Run 对象在云提交之前处于的临时状态。

  • 正在启动 - 运行已开始在云中处理。 调用方此时具有运行 ID。

  • 预配 - 正在为给定的作业提交创建按需计算。

  • 准备 - 运行环境正在准备中，处于以下两个阶段之一：

    • Docker 映像生成

    • Conda 环境设置

  • 已排队 - 作业在计算目标上排队。 例如，在 BatchAI 中，作业处于排队状态

    等待所有请求的节点准备就绪时。

  • 正在运行 - 作业已开始在计算目标上运行。

  • 正在完成 - 用户代码执行已完成，运行处于后处理阶段。

  • 已请求取消 - 已请求取消作业。

  • 已完成 - 运行已成功完成。 这包括用户代码执行和运行

    后期处理阶段。

  • 失败 - 运行失败。 通常，运行上的 Error 属性会提供有关原因的详细信息。

  • 已取消 - 遵循取消请求并指示运行现已成功取消。

  • 未响应 - 对于启用了检测信号的运行，最近未发送任何检测信号。

返回

作业的状态。

返回类型

Optional[str]

studio_url

Azure ML Studio 终结点。

返回

作业详细信息页的 URL。

返回类型

Optional[str]

type

作业的类型。

返回

作业的类型。

返回类型

Optional[str]