次の方法で共有

PipelineDraft クラス

  • リファレンス

実行の送信と発行済みレポートの作成に使用できる変更可能なパイプラインを表します。

PipelineDrafts を使用して、パイプラインを反復処理します。 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)

パラメーター

workspace
Workspace
必須

この PipelineDraft のワークスペース オブジェクト。

id
str
必須

PipelineDraft の ID。

name
str
必須

PipelineDraft の名前。

description
str
必須

PipelineDraft の説明。

experiment_name
str
必須

PipelineDraft の実験名。

tags
Dict[str, str]
必須

PipelineDraft の tags ディクショナリ (省略可能)。

properties
Dict[str, str]
必須

PipelineDraft の properties ディクショナリ (省略可能)。

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 の Workspace オブジェクト。

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 に関連付けられている Pipeline を続行することができます。


   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
既定値: None

PipelineDraft の名前。Pipeline から作成する場合にのみ必要です。

description
str
既定値: None

PipelineDraft の説明。Pipeline から作成する場合にのみ必要です。

experiment_name
str
既定値: None

PipelineDraft の実験名。Pipeline から作成する場合にのみ必要です。

pipeline_parameters
Dict[str, str]
既定値: None

PipelineDraft に対するパイプライン パラメーターの割り当てのディクショナリ (省略可能)。Pipeline から作成する場合にのみ必要です。

continue_on_step_failure
bool
既定値: None

ステップ実行で PipelineDraft の設定が失敗したときに PipelineRun を続行するかどうかを示します。Pipeline から作成する場合にのみ必要です。

tags
Dict[str, str]
既定値: None

PipelineDraft の tags ディクショナリ (省略可能)。Pipeline から作成する場合にのみ必要です。

properties
Dict[str, str]
既定値: None

PipelineDraft の properties ディクショナリ (省略可能)。Pipeline から作成する場合にのみ必要です。

_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
既定値: None

指定した場合、指定した{"tag": "value"} に一致するドラフトが返されます。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
既定値: None

(内部使用のみ)。ワークフロー プロバイダー。

戻り値

PipelineDraft オブジェクトのリスト。

の戻り値の型 :

list

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
既定値: None

YAML を保存するパス。 パスがディレクトリの場合、PipelineDraft YAML ファイルは path/pipeline_name.yml に保存されます。 パスが 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
既定値: None

PipelineDraft の名前。

description
str
既定値: None

PipelineDraft の説明。

experiment_name
str
既定値: None

PipelineDraft の実験名。

tags
Dict[str, str]
既定値: None

PipelineDraft の tags ディクショナリ。

pipeline_parameters
Dict[str, str]
既定値: None

PipelineDraft に対するパイプライン パラメーターの割り当て。

continue_on_step_failure
bool
既定値: None

ステップ実行で PipelineDraft の設定が失敗したときに PipelineRun を続行するかどうか。

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
既定値: None

(内部使用のみ)。ワークフロー プロバイダー。

属性

description

PipelineDraft の説明を取得します。

戻り値

説明文字列。

の戻り値の型 :

str

id

PipelineDraft の ID を取得します。

戻り値

ID。

の戻り値の型 :

str

last_submitted_pipeline_run_id

PipelineDraft の前回送信された PipelineRun の ID を取得します。

戻り値

PipelineRun ID。

の戻り値の型 :

str

name

PipelineDraft の名前を取得します。

戻り値

名前。

の戻り値の型 :

str

parent_pipeline_draft_id

PipelineDraft の親 PipelineDraft の ID を取得します。

戻り値

PipelineDraft ID。

の戻り値の型 :

str

parent_pipeline_id

PipelineDraft の親 PublishedPipeline の ID を取得します。

戻り値

PublishedPipeline ID。

の戻り値の型 :

str

parent_pipeline_run_id

PipelineDraft の親 PipelineRun の ID を取得します。

戻り値

PipelineRun ID。

の戻り値の型 :

str

parent_step_run_ids

PipelineDraft の親 PipelineRun の StepRun ID のリストを取得します。

戻り値

StepRun ID のリスト。

の戻り値の型 :

list

properties

PipelineDraft のプロパティを取得します。

戻り値

ディクショナリのプロパティ。

の戻り値の型 :

dict

tags

PipelineDraft の tags を取得します。

戻り値

tags ディクショナリ。

の戻り値の型 :

dict