PipelineDraft 类

参考

表示可用于提交运行和创建已发布管道的可变管道。

使用 PipelineDraft 在 Pipelines 上进行迭代。可以从头开始创建 PipelineDraft、从另一个 PipelineDraft 创建 PipelineDraft，或从现有管道创建 PipelineDraft：Pipeline、PublishedPipeline 或 PipelineRun。

继承: builtins.object

PipelineDraft

构造函数

PipelineDraft(workspace, id, name=None, description=None, experiment_name=None, tags=None, properties=None, graph_draft_id=None, parent_pipeline_id=None, parent_pipeline_run_id=None, parent_step_run_ids=None, parent_pipeline_draft_id=None, last_submitted_pipeline_run_id=None, _pipeline_draft_provider=None)

参数

workspace: Workspace

必需

此 PipelineDraft 的工作区对象。

id: str

必需

PipelineDraft 的 ID。

name: str

必需

PipelineDraft 的名称。

description: str

必需

PipelineDraft 的说明。

experiment_name: str

必需

PipelineDraft 的试验名称。

tags: Dict[str, str]

必需

PipelineDraft 的可选标记字典。

properties: Dict[str, str]

必需

PipelineDraft 的可选属性字典。

graph_draft_id: str

必需

与 PipelineDraft 关联的图草稿的 ID。

parent_pipeline_id: str

必需

父 PublishedPipeline 的 ID。

parent_pipeline_run_id: str

必需

父 PipelineRun 的 ID。

parent_step_run_ids: list

必需

父 PipelineRun 的 StepRun ID 列表。

parent_pipeline_draft_id: str

必需

父 PipelineDraft 的 ID。

last_submitted_pipeline_run_id: str

必需

上次提交的 PipelineRun 的 ID。

_pipeline_draft_provider: <xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>

必需

（仅供内部使用。） PipelineDraft 提供程序。

注解

可以使用 create 函数从 Pipeline 创建的 PipelineDraft。示例如下：


   from azureml.pipeline.core import Pipeline, PipelineDraft
   from azureml.pipeline.steps import PythonScriptStep

   train_step = PythonScriptStep(name="Training_Step",
                                 script_name="train.py",
                                 compute_target=aml_compute_target,
                                 source_directory=".")
   pipeline = Pipeline(workspace=ws, steps=[train_step])
   pipeline_draft = PipelineDraft.create(workspace=ws,
                                         name="TestPipelineDraft",
                                         description="draft description",
                                         experiment_name="helloworld",
                                         pipeline=pipeline,
                                         continue_on_step_failure=True,
                                         tags={'dev': 'true'},
                                         properties={'train': 'value'})

PipelineDraft.create() 的管道参数也可以是 PublishedPipeline、PipelineRun 或其他 PipelineDraft。

若要从 PipelineDraft 提交运行，请使用 submit_run 方法：


   pipeline_run = pipeline_draft.submit_run()

若要更新 PipelineDraft，请使用 update 方法。管道草稿的 update() 函数可用于更新名称、说明、试验名称、管道参数分配、步骤失败时是否继续设置，以及与 PipelineDraft 关联的管道。


   new_train_step = PythonScriptStep(name="New_Training_Step",
                                     script_name="train.py",
                                     compute_target=aml_compute_target,
                                     source_directory=source_directory)

   new_pipeline = Pipeline(workspace=ws, steps=[new_train_step])

   pipeline_draft.update(name="UpdatedPipelineDraft",
                         description="has updated train step",
                         pipeline=new_pipeline)

方法

create	创建 PipelineDraft。
delete	删除 PipelineDraft。
get	获取具有给定 ID 的 PipelineDraft。
get_graph	获取与 PipelineDraft 关联的图。
list	获取工作区中的所有管道草稿。
publish	从 PipelineDraft 发布 PublishedPipeline。
save	将 PipelineDraft YAML 保存到文件。
submit_run	从 PipelineDraft 提交 PipelineRun。
update	更新 PipelineDraft。将更新提供的字段。

create

创建 PipelineDraft。

static create(workspace, pipeline, name=None, description=None, experiment_name=None, pipeline_parameters=None, continue_on_step_failure=None, tags=None, properties=None, _workflow_provider=None, _service_endpoint=None)

参数

workspace: Workspace

必需

此 PipelineDraft 所属的工作区对象。

pipeline: PublishedPipeline 或 Pipeline 或 PipelineRun 或 PipelineDraft

必需

已发布的管道，或管道。

name: str

默认值: None

PipelineDraft 的名称；仅当从 Pipeline 创建时才需要指定。

description: str

默认值: None

PipelineDraft 的说明；仅当从 Pipeline 创建时才需要指定。

experiment_name: str

默认值: None

PipelineDraft 的试验名称；仅当从 Pipeline 创建时才需要指定。

pipeline_parameters: Dict[str, str]

默认值: None

PipelineDraft 的管道参数分配的可选字典；仅当从 Pipeline 创建时才需要指定。

continue_on_step_failure: bool

默认值: None

指示 PipelineDraft 的“当某个步骤运行失败时是否继续执行 PipelineRun”设置；仅当从 Pipeline 创建时才需要指定。

tags: Dict[str, str]

默认值: None

PipelineDraft 的可选标记字典；仅当从 Pipeline 创建时才需要指定。

properties: Dict[str, str]

默认值: None

PipelineDraft 的可选属性字典；仅当从 Pipeline 创建时才需要指定。

_service_endpoint: str

默认值: None

服务终结点。

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

创建的 PipelineDraft。

返回类型

PipelineDraft

delete

删除 PipelineDraft。

delete(_workflow_provider=None)

参数

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

get

获取具有给定 ID 的 PipelineDraft。

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

参数

workspace: Workspace

必需

在其中创建了 PipelineDraft 的工作区。

id: str

必需

PipelineDraft 的 ID。

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

_service_endpoint: str

默认值: None

服务终结点。

PipelineDraft 对象

返回类型

PipelineDraft

get_graph

获取与 PipelineDraft 关联的图。

get_graph(_workflow_provider=None)

参数

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

图对象。

返回类型

Graph

list

获取工作区中的所有管道草稿。

static list(workspace, tags=None, _workflow_provider=None)

参数

workspace: Workspace

必需

要从中列出草稿的工作区。

tags: dict

默认值: None

如果指定，则返回与指定的 {"tag": "value"} 匹配的草稿。

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

PipelineDraft 对象的列表。

返回类型

list

publish

从 PipelineDraft 发布 PublishedPipeline。

publish(_workflow_provider=None)

参数

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

创建的 PublishedPipeline。

返回类型

PublishedPipeline

save

将 PipelineDraft YAML 保存到文件。

save(path=None, _workflow_provider=None)

参数

path: str

默认值: None

要将 YAML 保存到的路径。如果该路径为目录，则 PipelineDraft YAML 文件将保存到 path/pipeline_name.yml。如果该路径为 None，则使用当前目录。

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

返回类型

None

submit_run

从 PipelineDraft 提交 PipelineRun。

submit_run(_workflow_provider=None)

参数

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

提交的 PipelineRun。

返回类型

PipelineRun

update

更新 PipelineDraft。

将更新提供的字段。

update(pipeline=None, name=None, description=None, experiment_name=None, tags=None, pipeline_parameters=None, continue_on_step_failure=None, _workflow_provider=None)

参数

pipeline: Pipeline

默认值: None

草稿的已更新管道。

name: str

默认值: None

PipelineDraft 的名称。

description: str

默认值: None

PipelineDraft 的说明。

experiment_name: str

默认值: None

PipelineDraft 的试验名称。

tags: Dict[str, str]

默认值: None

PipelineDraft 的标记字典。

pipeline_parameters: Dict[str, str]

默认值: None

PipelineDraft 的管道参数分配。

continue_on_step_failure: bool

默认值: None

PipelineDraft 的“当某个步骤运行失败时是否继续执行 PipelineRun”设置。

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

默认值: None

（仅供内部使用。）工作流提供程序。

属性

description

获取 PipelineDraft 的说明。

说明字符串。

返回类型

str

id

获取 PipelineDraft 的 ID。

ID。

返回类型

str

last_submitted_pipeline_run_id

获取 PipelineDraft 的上次提交 PipelineRun 的 ID。

PipelineRun ID。

返回类型

str

name

PipelineDraft 的名称。

名称。

返回类型

str

parent_pipeline_draft_id

获取 PipelineDraft 的父 PipelineDraft 的 ID。

PipelineDraft ID。

返回类型

str

parent_pipeline_id

获取 PipelineDraft 的父 PublishedPipeline 的 ID。

PublishedPipeline ID。

返回类型

str

parent_pipeline_run_id

获取 PipelineDraft 的父 PipelineRun 的 ID。

PipelineRun ID。

返回类型

str

parent_step_run_ids

获取 PipelineDraft 的父 PipelineRun 的 StepRun ID 列表。

StepRun ID 的列表。

返回类型

list

properties

获取 PipelineDraft 的属性。

属性字典。

返回类型

dict

PipelineDraft 类

构造函数

参数

注解

方法

create

参数

返回

返回类型

delete

参数

get

参数

返回

返回类型

get_graph

参数

返回

返回类型

list

参数

返回

返回类型

publish

参数

返回

返回类型

save

参数

返回类型

submit_run

参数

返回

返回类型

update

参数

属性

description

返回

返回类型

id

返回

返回类型

last_submitted_pipeline_run_id

返回

返回类型

name

返回

返回类型

parent_pipeline_draft_id

返回

返回类型

parent_pipeline_id

返回

返回类型

parent_pipeline_run_id

返回

返回类型

parent_step_run_ids

返回

返回类型

properties

返回

返回类型

tags

返回

返回类型

反馈