PublishedPipeline 類別

參考

表示要提交且沒有建構它的 Python 程式碼的管線。

此外，PublishedPipeline 可用來重新提交 Pipeline 具有不同 PipelineParameter 值和輸入的。

初始化 PublishedPipeline。

:p aram 端點要提交此管線執行的 REST 端點 URL。：type endpoint： str :p aram total_run_steps：此管線中的步驟數目：type total_run_steps：int :p aram 工作區：已發佈管線的工作區。：type workspace： azureml.core.Workspace :p aram continue_on_step_failure：是否繼續執行 PipelineRun 中的其他步驟

如果步驟失敗，則預設值為 false。

繼承: azureml.core._portal.HasPipelinePortal

PublishedPipeline

建構函式

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

參數

名稱	Description
name 必要	str 已發佈管線的名稱。
graph_id 必要	str 這個已發佈管線的圖形識別碼。
description 必要	str 已發佈管線的描述。
version 必要	str 已發佈的管線版本。
published_pipeline_id 必要	str 已發佈管線的識別碼。
status 必要	str 已發佈管線的狀態 ('Active' 或 'Disabled') 。
endpoint 必要	str 要提交此管線執行的 REST 端點 URL。
total_run_steps 必要	int 此管線中的步驟數目。
workspace 必要	Workspace 已發佈管線的工作區。
continue_on_step_failure 必要	bool 如果步驟失敗，是否要繼續執行 PipelineRun 中的其他步驟。預設值為 false。
_pipeline_provider 必要	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> 已發佈的管線提供者。
kwargs 必要	dict 自訂關鍵字引數，保留供未來開發使用
name 必要	str 已發佈管線的名稱。
graph_id 必要	str 這個已發佈管線的圖形識別碼。
description 必要	str 已發佈管線的描述。
version 必要	str 已發佈的管線版本。
published_pipeline_id 必要	str 已發佈管線的識別碼。
status 必要	str 已發佈管線的狀態 ('Active' 或 'Disabled') 。
_pipeline_provider 必要	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> 已發佈的管線提供者。
kwargs 必要	dict 自訂關鍵字引數，保留供未來開發使用

備註

您可以從或 PipelineRun 建立 Pipeline PublishedPipeline。

從管線發佈的範例如下所示：


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

若要從 PipelineRun 發佈，請使用：


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

注意：continue_on_step_failure參數會指定管線中的步驟執行是否會在單一步驟失敗時繼續執行。預設值為 False，表示當某個步驟失敗時，管線執行將會停止，並取消任何執行中的步驟。

使用 submit 提交 PublishedPipeline。呼叫 submit 時，會建立， PipelineRun 進而為工作流程中的每個步驟建立 StepRun 物件。

提交 PublishedPipeline 的範例如下：


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

提交 PublishedPipeline 時可以指定許多選擇性設定。其中包括：

continue_on_step_failure：如果步驟失敗，是否要繼續執行 PipelineRun 中的其他步驟，選擇性。只有沒有相依于失敗步驟輸出的步驟才會繼續執行。如果提供，此參數設定會覆寫管線上的設定。
pipeline_parameters：管線執行的參數，{name： value} 的字典。如需更多詳細資料，請參閱 PipelineParameter \(英文\)。
parent_run_id：您可以提供執行識別碼來設定此管線執行的父回合，這會反映在 RunHistory 中。父回合必須屬於與提交管線相同的實驗。

使用下列設定提交 PublishedPipeline 的範例如下：


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

所有已發佈的管線都有 REST 端點。透過管線端點，您可以從外部系統觸發管線的執行，例如非 Python 用戶端。如需如何呼叫 REST 端點時進行驗證的資訊，請參閱 https://aka.ms/pl-restep-auth 。

例如，使用端點可在批次評分和重新定型案例中啟用「受控可重複性」。如需詳細資訊，請參閱 https://aka.ms/pl-first-pipeline 。

方法

disable	將已發佈的管線設定為 [已停用]，且無法執行。
enable	將已發佈的管線設定為 [作用中]，並可供執行。
get	取得已發佈的管線。
get_all	取得目前工作區中所有已發佈的管線。已淘汰：這個方法已被取代，而不是 PublishedPipeline list 方法。
get_graph	取得 PublishedPipeline 的圖表。
get_step_names	取得 PublishedPipeline 中步驟的名稱清單。
list	取得目前工作區中所有已發佈的管線。
save	將管線 YAML 儲存至檔案。目前只有包含 ModuleSteps 的管線才支援 YAML 匯出。
submit	提交已發佈的管線。這相當於使用 submit 。傳回提交的 PipelineRun 。使用此物件來監視及檢視執行的詳細資料。

disable

將已發佈的管線設定為 [已停用]，且無法執行。

disable()

enable

將已發佈的管線設定為 [作用中]，並可供執行。

enable()

get

取得已發佈的管線。

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

參數

名稱	Description
workspace 必要	Workspace 已發佈管線建立所在的工作區。
id 必要	str 已發佈管線的識別碼。
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
PublishedPipeline	PublishedPipeline 物件。

get_all

取得目前工作區中所有已發佈的管線。

已淘汰：這個方法已被取代，而不是 PublishedPipeline list 方法。

static get_all(workspace, active_only=True, _service_endpoint=None)

參數

名稱	Description
workspace 必要	Workspace 已發佈管線建立所在的工作區。
active_only	bool 是否只傳回目前作用中的已發佈管線。預設值: True
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list[PublishedPipeline]	PublishedPipeline 物件的清單。

get_graph

取得 PublishedPipeline 的圖表。

get_graph(_workflow_provider=None)

參數

名稱	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None

傳回

類型	Description
Graph	圖形。

get_step_names

取得 PublishedPipeline 中步驟的名稱清單。

get_step_names(_workflow_provider=None)

參數

名稱	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None

傳回

類型	Description
List[str]	PublishedPipeline 中的步驟名稱清單。

list

取得目前工作區中所有已發佈的管線。

static list(workspace, active_only=True, _service_endpoint=None)

參數

名稱	Description
workspace 必要	Workspace 已發佈管線建立所在的工作區。
active_only	bool 是否只傳回目前作用中的已發佈管線。預設值: True
_service_endpoint	str 服務端點。預設值: None

傳回

類型	Description
list[PublishedPipeline]	PublishedPipeline 物件的清單。

save

將管線 YAML 儲存至檔案。

目前只有包含 ModuleSteps 的管線才支援 YAML 匯出。

save(path=None, _workflow_provider=None)

參數

名稱	Description
path	str 要儲存 YAML 的路徑。如果路徑是目錄，管線 YAML 檔案會儲存在 path/pipeline_name.yml。如果 path 為 None，則會使用目前的目錄。預設值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None

傳回

類型	Description
None

submit

提交已發佈的管線。這相當於使用 submit 。

傳回提交的 PipelineRun 。使用此物件來監視及檢視執行的詳細資料。

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

參數

名稱	Description
workspace 必要	Workspace 要提交已發佈管線的工作區。
experiment_name 必要	str 要提交至的實驗名稱。
pipeline_parameters	dict 要指派新值 {param name， param value} 的參數字典。如需更多詳細資料，請參閱 PipelineParameter \(英文\)。預設值: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> 工作流程提供者。預設值: None
_service_endpoint	str 服務端點。預設值: None
parent_run_id	str 要為此管線執行的父回合設定的選擇性執行識別碼，這會反映在 RunHistory 中。父執行必須屬於與提交此管線相同的實驗。預設值: None
continue_on_step_failure	bool 如果步驟失敗，是否要繼續執行 PipelineRun 中的其他步驟，選擇性。如果提供，將會覆寫管線上的設定。預設值: None

傳回

類型	Description
PipelineRun	提交的管線執行。

屬性

continue_on_step_failure

取得設定的值 continue_on_step_failure 。

傳回

類型	Description
bool	設定的值 `continue_on_step_failure` 。

description

取得已發佈管線的描述。

傳回

類型	Description
str	已發佈管線的描述。

endpoint

取得用於執行已發佈管線的 REST 端點 URL。

傳回

類型	Description
str	用於執行已發佈管線的 REST 端點 URL。

graph_id

取得此已發佈管線的圖形識別碼。

傳回

類型	Description
str	圖形的識別碼。

id

取得已發佈的管線識別碼。

傳回

類型	Description
str	已發佈管線的識別碼。

name

取得已發佈管線的名稱。

傳回

類型	Description
str	已發佈的管線名稱。

status

取得已發佈管線的狀態。

傳回

類型	Description
str	已發佈管線的狀態。

total_run_steps

取得管線中的步驟數目。

傳回

類型	Description
int	管線中的步驟數目。

version

取得已發佈管線的版本。

傳回

類型	Description
str	已發佈管線的版本。

共用方式為