PipelineComponent Class

Pipeline component, currently used to store components in an azure.ai.ml.dsl.pipeline.

Inheritance

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

PipelineComponent

Constructor

PipelineComponent(*, name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, inputs: Dict | None = None, outputs: Dict | None = None, jobs: Dict[str, BaseNode] | None = None, is_deterministic: bool | None = None, **kwargs: Any)

Parameters

Name	Description
name Required	str Name of the component.
version Required	str Version of the component.
description Required	str Description of the component.
tags Required	dict Tag dictionary. Tags can be added, removed, and updated.
display_name Required	str Display name of the component.
inputs Required	dict Component inputs.
outputs Required	dict Component outputs.
jobs Required	Dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>] Id to components dict inside the pipeline definition.
is_deterministic Required	bool Whether the pipeline component is deterministic.

Keyword-Only Parameters

Name	Description
name Required
version Required
description Required
tags Required
display_name Required
inputs Required
outputs Required
jobs Required
is_deterministic Required

Methods

dump	Dump the component content into a file in yaml format.

dump

Dump the component content into a file in yaml format.

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

Parameters

Name	Description
dest Required	Union[<xref:PathLike>, str, IO[AnyStr]] The destination to receive this component's content. Must be either a path to a local file, or an already-open file stream. If dest is a file path, a new file will be created, and an exception is raised if the file exists. If dest is an open file, the file will be written to directly, and an exception will be raised if the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type	Description
Optional[SystemData]	The creation metadata for the resource.

display_name

Display name of the component.

Returns

Type	Description
str	Display name of the component.

id

The resource ID.

Returns

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.

inputs

Inputs of the component.

Returns

Type	Description
dict	Inputs of the component.

is_deterministic

Whether the component is deterministic.

Returns

Type	Description
bool	Whether the component is deterministic

jobs

Return a dictionary from component variable name to component object.

Returns

Type	Description
Dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]	Dictionary mapping component variable names to component objects.

outputs

Outputs of the component.

Returns

Type	Description
dict	Outputs of the component.

type

Type of the component, default is 'command'.

Returns

Type	Description
str	Type of the component.

version

Version of the component.

Returns

Type	Description
str	Version of the component.