共用方式為

PipelineDraft 類別

  • 參考

表示可用來提交執行和建立已發佈管線的可變管線。

使用 PipelineDrafts 逐一查看 Pipelines。 PipelineDrafts 可以從頭開始建立、另一個 PipelineDraft 或現有的管線： Pipeline 、 PublishedPipeline 或 PipelineRun 。

初始化 PipelineDraft。

繼承
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)

參數

名稱 Description
workspace
必要
Workspace

這個 PipelineDraft 的工作區物件。
id
必要
str

PipelineDraft 的識別碼。
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 相關聯的圖形草稿識別碼。
parent_pipeline_id
必要
str

父系 PublishedPipeline 的識別碼。
parent_pipeline_run_id
必要
str

父 PipelineRun 的識別碼。
parent_step_run_ids
必要
list

父 PipelineRun 之 StepRun 識別碼的清單。
parent_pipeline_draft_id
必要
str

父 PipelineDraft 的識別碼。
last_submitted_pipeline_run_id
必要
str

上次提交的 PipelineRun 的識別碼。
_pipeline_draft_provider
必要
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>

(內部僅使用。) PipelineDraft 提供者。
workspace
必要
Workspace

這個 PipelineDraft 的 Workspace 物件。
id
必要
str

PipelineDraft 的識別碼。
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 相關聯的圖形草稿識別碼。
parent_pipeline_id
必要
str

父系 PublishedPipeline 的識別碼。
parent_pipeline_run_id
必要
str

父 PipelineRun 的識別碼。
parent_step_run_ids
必要
list

父 PipelineRun 之 StepRun 識別碼的清單。
parent_pipeline_draft_id
必要
str

父 PipelineDraft 的識別碼。
last_submitted_pipeline_run_id
必要
str

上次提交的 PipelineRun 的識別碼。
_pipeline_draft_provider
必要
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>

PipelineDraft 提供者。

備註

您可以使用 函式從 Pipelinecreate 建立 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

取得具有指定識別碼的 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)

參數

名稱 Description
workspace
必要
Workspace

此 PipelineDraft 所屬的工作區物件。
pipeline
必要
PublishedPipeline 或 Pipeline 或 PipelineRun 或 PipelineDraft

已發佈的管線或管線。
name
str

PipelineDraft 的名稱;只有在從 Pipeline 建立 時才需要。

預設值: None
description
str

PipelineDraft 的描述;只有在從 Pipeline 建立 時才需要。

預設值: None
experiment_name
str

PipelineDraft 的實驗名稱;只有在從 Pipeline 建立 時才需要。

預設值: None
pipeline_parameters
Dict[str, str]

PipelineDraft 管線參數指派的選擇性字典;只有在從 Pipeline 建立 時才需要。

預設值: None
continue_on_step_failure
bool

指出當 PipelineDraft 的步驟執行失敗設定時，是否要繼續 PipelineRun;只有在從 Pipeline 建立 時才需要。

預設值: None
tags
Dict[str, str]

PipelineDraft 的選擇性標記字典，只有在從 Pipeline 建立時才需要。

預設值: None
properties
Dict[str, str]

只有在從 Pipeline 建立 時，才需要 PipelineDraft 的選擇性屬性字典。

預設值: None
_service_endpoint
str

服務端點。

預設值: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
PipelineDraft

已建立的 PipelineDraft。

delete

刪除 PipelineDraft。

delete(_workflow_provider=None)

參數

名稱 Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

get

取得具有指定識別碼的 PipelineDraft。

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

參數

名稱 Description
workspace
必要
Workspace

PipelineDraft 建立所在的工作區。
id
必要
str

PipelineDraft 的識別碼。
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None
_service_endpoint
str

服務端點。

預設值: None

傳回

類型 Description
PipelineDraft

PipelineDraft 物件

get_graph

取得與 PipelineDraft 相關聯的圖表。

get_graph(_workflow_provider=None)

參數

名稱 Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
Graph

Graph 物件。

list

取得工作區中的所有管線草稿。

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

參數

名稱 Description
workspace
必要
Workspace

要從中列出草稿的工作區。
tags
dict

如果指定，則會傳回符合指定 {「tag」： 「value」} 的草稿。

預設值: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
list

PipelineDraft 物件的清單。

publish

從 PipelineDraft 發佈 PublishedPipeline。

publish(_workflow_provider=None)

參數

名稱 Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
PublishedPipeline

已建立的 PublishedPipeline。

save

將 PipelineDraft YAML 儲存至檔案。

save(path=None, _workflow_provider=None)

參數

名稱 Description
path
str

要儲存 YAML 的路徑。 如果路徑是目錄，PipelineDraft YAML 檔案會儲存在 path/pipeline_name.yml。 如果 path 為 None，則會使用目前的目錄。

預設值: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
None

submit_run

從 PipelineDraft 提交 PipelineRun。

submit_run(_workflow_provider=None)

參數

名稱 Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(內部僅使用。) 工作流程提供者。

預設值: None

傳回

類型 Description
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)

參數

名稱 Description
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>

(Internal only.) 工作流程提供者。

預設值: None

屬性

description

取得 PipelineDraft 的描述。

傳回

類型 Description
str

描述字串。

id

取得 PipelineDraft 的識別碼。

傳回

類型 Description
str

識別碼。

last_submitted_pipeline_run_id

取得 PipelineDraft 上次提交的 PipelineRun 識別碼。

傳回

類型 Description
str

PipelineRun 識別碼。

name

設定 PipelineDraft 的名稱。

傳回

類型 Description
str

名稱。

parent_pipeline_draft_id

取得 PipelineDraft 父 PipelineDraft 的識別碼。

傳回

類型 Description
str

PipelineDraft 識別碼。

parent_pipeline_id

取得 PipelineDraft 上層 PublishedPipeline 的識別碼。

傳回

類型 Description
str

PublishedPipeline 識別碼。

parent_pipeline_run_id

取得 PipelineDraft 父 PipelineRun 的識別碼。

傳回

類型 Description
str

PipelineRun 識別碼。

parent_step_run_ids

取得 PipelineDraft 上層 PipelineRun 的 StepRun 識別碼清單。

傳回

類型 Description
list

StepRun 識別碼的清單。

properties

取得 PipelineDraft 的屬性。

傳回

類型 Description
dict

屬性字典。

tags

取得 PipelineDraft 的標記。

傳回

類型 Description
dict

標記字典。