PipelineDraft 类

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

使用 PipelineDrafts 循环访问管道。可以从头开始创建 PipelineDrafts、另一个 PipelineDraft 或现有管道： Pipeline、 PublishedPipeline或 PipelineRun。

初始化 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 提供程序。
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 提供程序。

注解

可以使用函数从管道Pipeline create德拉夫特创建。下面是一个示例：


   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 发布 PublishPipeline。
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 PipelineDraft 的名称;仅当从 a Pipeline. 创建时才需要。默认值: None
description	str PipelineDraft 的说明;仅当从 a Pipeline. 创建时才需要。默认值: None
experiment_name	str PipelineDraft 的试验名称;仅当从 a Pipeline. 创建时才需要。默认值: None
pipeline_parameters	Dict[str, str] PipelineDraft 的管道参数分配的可选字典;仅当从 a Pipeline. 创建时才需要。默认值: None
continue_on_step_failure	bool 指示在 PipelineDraft 的步骤运行失败设置时是否继续 PipelineRun;仅当从 a Pipeline. 创建时才需要。默认值: None
tags	Dict[str, str] PipelineDraft 的可选标记字典，仅在从中 Pipeline创建时需要。默认值: None
properties	Dict[str, str] PipelineDraft 的可选属性字典，仅在从 a . Pipeline创建时需要。默认值: None
_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	Graph 对象。

list

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

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

参数

名称	说明
workspace 必需	Workspace 要从中列出草稿的工作区。
tags	dict 如果指定，则返回匹配指定 {“tag”： “value”} 的草稿。默认值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> （仅限内部使用。）工作流提供程序。默认值: None

类型	说明
list	对象列表 PipelineDraft 。

publish

从 PipelineDraft 发布 PublishPipeline。

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 要保存到的 YAML 的路径。如果路径是目录，则 PipelineDraft YAML 文件保存在 path/pipeline_name.yml。如果路径为 None，则使用当前目录。默认值: 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 PipelineDraft 的名称。默认值: None
description	str PipelineDraft 的说明。默认值: None
experiment_name	str PipelineDraft 的试验名称。默认值: None
tags	Dict[str, str] PipelineDraft 的标记字典。默认值: None
pipeline_parameters	Dict[str, str] PipelineDraft 的管道参数分配。默认值: None
continue_on_step_failure	bool 当 PipelineDraft 的步骤运行失败设置时，是否继续 PipelineRun。默认值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> （仅限内部使用。）工作流提供程序。默认值: None

属性

description

获取 PipelineDraft 的说明。

类型	说明
str	说明字符串。

id

获取 PipelineDraft 的 ID。

类型	说明
str	ID。

last_submitted_pipeline_run_id

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

类型	说明
str	PipelineRun ID。

name

设置 PipelineDraft 的名称。

类型	说明
str	名称。

parent_pipeline_draft_id

获取 PipelineDraft 的父 PipelineDraft 的 ID。

类型	说明
str	PipelineDraft ID。

parent_pipeline_id

获取 PipelineDraft 的父 PublishedPipeline 的 ID。

类型	说明
str	PublishedPipeline ID。

parent_pipeline_run_id

获取 PipelineDraft 的父 PipelineRun 的 ID。

类型	说明
str	PipelineRun ID。

parent_step_run_ids

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

类型	说明
list	StepRun ID 的列表。

properties

获取 PipelineDraft 的属性。

类型	说明
dict	属性字典。