PublishedPipeline クラス

  • リファレンス

それを構築した Python コードを使用せずに送信されるパイプラインを表します。

さらに、PublishedPipeline を使用して、異なる PipelineParameter 値と入力を持つ Pipeline を再送信できます。

PublishedPipeline を初期化します。

:p aram エンドポイント このパイプラインの実行を送信する REST エンドポイント URL。 :type endpoint: str :p aram total_run_steps:type total_run_steps: int :p aram workspace: 発行されたパイプラインのワークスペース。 :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)

パラメーター

name
str
必須

発行されたパイプラインの名前。

graph_id
str
必須

この発行されたパイプラインのグラフの ID。

description
str
必須

発行されたパイプラインの説明。

version
str
必須

発行されたパイプライン バージョン。

published_pipeline_id
str
必須

発行されたパイプラインの ID。

status
str
必須

発行されたパイプラインの状態 ('Active' または 'Disabled')。

endpoint
str
必須

送信する REST エンドポイント URL は、このパイプラインに対して実行されます。

total_run_steps
int
必須

このパイプライン内のステップの数。

workspace
Workspace
必須

発行されたパイプラインのワークスペース。

continue_on_step_failure
bool
必須

PipelineRun 内の 1 つのステップが失敗した場合に、他のステップの実行を続行するかどうか。 既定値は false です。

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
必須

発行されたパイプライン プロバイダー。

kwargs
dict
必須

将来の開発用に予約されているカスタム キーワード引数

name
str
必須

発行されたパイプラインの名前。

graph_id
str
必須

この発行されたパイプラインのグラフの ID。

description
str
必須

発行されたパイプラインの説明。

version
str
必須

発行されたパイプライン バージョン。

published_pipeline_id
str
必須

発行されたパイプラインの ID。

status
str
必須

発行されたパイプラインの状態 ('Active' または 'Disabled')。

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
必須

発行されたパイプライン プロバイダー。

kwargs
dict
必須

将来の開発用に予約されているカスタム キーワード引数

注釈

PublishedPipeline は、Pipeline または PipelineRun から作成できます。

パイプラインから発行する例を次に示します。


   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 パラメーターは、パイプラインの 1 つのステップが失敗した場合にパイプラインのステップの実行を続行するかどうかを指定します。 既定値は False です。つまり、1 つのステップが失敗すると、パイプラインの実行が停止し、実行中のすべてのステップが取り消されます。

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 内の 1 つのステップが失敗した場合に、他のステップの実行を続行するかどうか (省略可能)。 失敗したステップの出力に依存しないステップだけが実行を続行します。 指定した場合、このパラメーター設定はパイプラインの設定をオーバーライドします。

  • pipeline_parameters: パイプライン実行のパラメーター。{name: value} の辞書。 詳細については、 PipelineParameter をご覧ください。

  • parent_run_id: RunHistory に反映される、このパイプライン実行の親実行を設定する実行 ID を指定できます。 この親実行は、このパイプラインが送信されるのと同じ実験に属している必要があります。

これらの設定を使用して 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

発行されたパイプラインを 'Disabled' に設定し、実行できないようにします。
enable

発行されたパイプラインを 'Active' に設定し、実行できるようにします。
get

発行されたパイプラインを取得します。
get_all

現在のワークスペース内のすべての発行済みパイプラインを取得します。

非推奨: このメソッドは非推奨になり、PublishedPipeline list メソッドに置き換えられます。
get_graph

PublishedPipeline のグラフを取得します。
get_step_names

PublishedPipeline のステップの名前のリストを取得します。
list

現在のワークスペース内のすべての発行済みパイプラインを取得します。
save

パイプライン YAML をファイルに保存します。

現在、YAML のエクスポートでは、ModuleSteps で構成されるパイプラインだけがサポートされています。
submit

発行されたパイプラインを送信します。 これは、submit を使用することと同じです。

送信された PipelineRun を返します。 実行の詳細を監視および表示するには、このオブジェクトを使用します。

disable

発行されたパイプラインを 'Disabled' に設定し、実行できないようにします。

disable()

enable

発行されたパイプラインを 'Active' に設定し、実行できるようにします。

enable()

get

発行されたパイプラインを取得します。

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

パラメーター

workspace
Workspace
必須

発行されたパイプラインが作成されたワークスペース。

id
str
必須

発行されたパイプラインの ID。

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

ワークフロー プロバイダー。

_service_endpoint
str
既定値: None

サービス エンドポイント。

戻り値

PublishedPipeline オブジェクト。

の戻り値の型 :

PublishedPipeline

get_all

現在のワークスペース内のすべての発行済みパイプラインを取得します。

非推奨: このメソッドは非推奨になり、PublishedPipeline list メソッドに置き換えられます。

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

パラメーター

workspace
Workspace
必須

発行されたパイプラインが作成されたワークスペース。

active_only
bool
既定値: True

現在アクティブな発行済みパイプラインのみを返すかどうか。

_service_endpoint
str
既定値: None

サービス エンドポイント。

戻り値

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

の戻り値の型 :

list[PublishedPipeline]

get_graph

PublishedPipeline のグラフを取得します。

get_graph(_workflow_provider=None)

パラメーター

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

ワークフロー プロバイダー。

戻り値

グラフ。

の戻り値の型 :

Graph

get_step_names

PublishedPipeline のステップの名前のリストを取得します。

get_step_names(_workflow_provider=None)

パラメーター

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

ワークフロー プロバイダー。

戻り値

PublishedPipeline のステップの名前のリスト。

の戻り値の型 :

List[str]

list

現在のワークスペース内のすべての発行済みパイプラインを取得します。

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

パラメーター

workspace
Workspace
必須

発行されたパイプラインが作成されたワークスペース。

active_only
bool
既定値: True

現在アクティブな発行済みパイプラインのみを返すかどうか。

_service_endpoint
str
既定値: None

サービス エンドポイント。

戻り値

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

の戻り値の型 :

list[PublishedPipeline]

save

パイプライン YAML をファイルに保存します。

現在、YAML のエクスポートでは、ModuleSteps で構成されるパイプラインだけがサポートされています。

save(path=None, _workflow_provider=None)

パラメーター

path
str
既定値: None

YAML を保存するパス。 このパスがディレクトリの場合、Pipeline YAML ファイルは path/pipeline_name.yml に保存されます。 パスが None の場合、現在のディレクトリが使われます。

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

ワークフロー プロバイダー。

の戻り値の型 :

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)

パラメーター

workspace
Workspace
必須

発行されたパイプラインを送信するワークスペース。

experiment_name
str
必須

送信する実験の名前。

pipeline_parameters
dict
既定値: None

新しい値 {param name, param value} を割り当てるパラメーターの辞書。 詳細については、 PipelineParameter をご覧ください。

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

ワークフロー プロバイダー。

_service_endpoint
str
既定値: None

サービス エンドポイント。

parent_run_id
str
既定値: None

このパイプライン実行の親実行のために設定される省略可能な実行 ID。これは、RunHistory に反映されます。 親実行は、このパイプラインの送信先と同じ実験に属している必要があります。

continue_on_step_failure
bool
既定値: None

PipelineRun 内の 1 つのステップが失敗した場合に、他のステップの実行を続行するかどうか (省略可能)。 指定されている場合、パイプラインの設定がオーバーライドされます。

戻り値

送信済みのパイプライン実行。

の戻り値の型 :

PipelineRun

属性

continue_on_step_failure

continue_on_step_failure 設定の値を取得します。

戻り値

continue_on_step_failure 設定の値。

の戻り値の型 :

bool

description

発行されたパイプラインの説明を取得します。

戻り値

発行されたパイプラインの説明。

の戻り値の型 :

str

endpoint

発行されたパイプラインを実行するための REST エンドポイント URL を取得します。

戻り値

発行されたパイプラインを実行するための REST エンドポイント URL。

の戻り値の型 :

str

graph_id

この発行されたパイプラインのグラフの ID を取得します。

戻り値

グラフの ID。

の戻り値の型 :

str

id

発行されたパイプライン ID を取得します。

戻り値

発行されたパイプラインの ID。

の戻り値の型 :

str

name

発行されたパイプラインの名前を取得します。

戻り値

発行されたパイプライン名。

の戻り値の型 :

str

status

発行されたパイプラインの状態を取得します。

戻り値

発行されたパイプラインの状態。

の戻り値の型 :

str

total_run_steps

パイプライン内のステップの数を取得します。

戻り値

パイプライン内のステップの数。

の戻り値の型 :

int

version

発行されたパイプラインのバージョンを取得します。

戻り値

発行されたパイプラインのバージョン。

の戻り値の型 :

str