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 プロバイダー。

注釈

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 から 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 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] PipelineDraft の省略可能なプロパティディクショナリ。 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 から 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 YAML を保存するパス。パスがディレクトリの場合、PipelineDraft YAML ファイルはパス/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	プロパティディクショナリ。

次の方法で共有

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

戻り値

フィードバック