PipelineDraft 類別
表示可用來提交執行和建立已發佈管線的可變管線。
使用 PipelineDrafts 逐一查看 Pipelines。 PipelineDrafts 可以從頭開始建立、另一個 PipelineDraft 或現有的管線: Pipeline 、 PublishedPipeline 或 PipelineRun 。
初始化 PipelineDraft。
- 繼承
-
builtins.objectPipelineDraft
建構函式
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)
參數
- _pipeline_draft_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>
(內部僅使用。) PipelineDraft 提供者。
- _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)
參數
- continue_on_step_failure
- bool
指出當 PipelineDraft 的步驟執行失敗設定時,是否要繼續 PipelineRun;只有在從 Pipeline 建立 時才需要。
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
已建立的 PipelineDraft。
傳回類型
delete
刪除 PipelineDraft。
delete(_workflow_provider=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
get
取得具有指定識別碼的 PipelineDraft。
static get(workspace, id, _workflow_provider=None, _service_endpoint=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
PipelineDraft 物件
傳回類型
get_graph
取得與 PipelineDraft 相關聯的圖表。
get_graph(_workflow_provider=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
Graph 物件。
傳回類型
list
取得工作區中的所有管線草稿。
static list(workspace, tags=None, _workflow_provider=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
PipelineDraft 物件的清單。
傳回類型
publish
從 PipelineDraft 發佈 PublishedPipeline。
publish(_workflow_provider=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
已建立的 PublishedPipeline。
傳回類型
save
將 PipelineDraft YAML 儲存至檔案。
save(path=None, _workflow_provider=None)
參數
- path
- str
要儲存 YAML 的路徑。 如果路徑是目錄,PipelineDraft YAML 檔案會儲存在 path/pipeline_name.yml。 如果 path 為 None,則會使用目前的目錄。
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回類型
submit_run
從 PipelineDraft 提交 PipelineRun。
submit_run(_workflow_provider=None)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(內部僅使用。) 工作流程提供者。
傳回
提交的 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)
參數
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
(Internal only.) 工作流程提供者。
屬性
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
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應