次の方法で共有

PipelineRun クラス

Pipelineの実行を表します。

このクラスを使用して、パイプラインの実行が送信されると、状態の管理、確認、実行の詳細の取得を行うことができます。 get_stepsを使用して、パイプライン実行によって作成されたStepRun オブジェクトを取得します。 その他の用途としては、パイプライン実行に関連付けられている Graph オブジェクトの取得、パイプライン実行の状態のフェッチ、実行の完了の待機などがあります。

パイプラインの実行を初期化します。

コンストラクター

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

パラメーター

名前 説明
experiment
必須
Experiment

パイプラインの実行に関連付けられている実験オブジェクト。
run_id
必須
str

パイプライン実行の実行 ID。
_service_endpoint
str

接続先のエンドポイント。

規定値: None
experiment
必須
Experiment

パイプラインの実行に関連付けられている実験オブジェクト。
run_id
必須
str

パイプライン実行の実行 ID。
_service_endpoint
必須
str

接続先のエンドポイント。

注釈

PipelineRun オブジェクトは、Pipelineを介してsubmitを送信するときに返されます。 Experimentのメソッド。 パイプラインを作成して送信する方法の詳細については、「 https://aka.ms/pl-first-pipeline」を参照してください。

PipelineRun は、実行が送信された Experiment と PipelineRun ID を使用して、次のようにインスタンス化することもできます。


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

PipelineRun を使用する場合は、次のコマンドを使用します。

  • wait_for_completion 実行状態を監視し、必要に応じて実行ログをストリーミングします。

  • get_status を選択して、実行状態をフェッチします。

  • cancel 進行中の PipelineRun を取り消します。

  • get_steps を選択して、生成された StepRuns を一覧表示します。 PipelineRun は、パイプラインの各ステップに対して StepRun を生成します。

メソッド

cancel

進行中の実行を取り消します。
child_run

パイプライン実行の子実行を作成します。 このメソッドは PipelineRun には実装されていません。
complete

パイプラインの実行を完了としてマークします。 このメソッドは PipelineRun には実装されていません。

このメソッドはパイプラインではサポートされていません。完了/失敗状態は、Azure ML バックエンドによって管理されます。
fail

パイプラインの実行を失敗としてマークします。 このメソッドは PipelineRun には実装されていません。

このメソッドはパイプラインではサポートされていません。完了/失敗状態は、Azure ML バックエンドによって管理されます。
find_step_run

名前でパイプラインでステップ実行を見つけます。
get

実行 ID に基づいてパイプラインの実行をフェッチします。
get_graph

パイプラインの実行のグラフを取得します。
get_pipeline_output

指定されたパイプライン出力の PortDataReference を取得します。
get_pipeline_runs

発行されたパイプラインから生成されたパイプライン実行をフェッチします。
get_status

パイプライン実行の最新の状態をサービスからフェッチします。

返される一般的な値は、"Running"、"Finished"、"Failed" です。
get_steps

実行が完了または開始されたすべてのパイプライン ステップのステップ実行を取得します。
get_tags

実行のタグのセットを取得します。
publish_pipeline

パイプラインを発行し、再実行できるようにします。

この関数によって返される PublishedPipeline オブジェクトからパイプライン エンドポイントを取得できます。 パイプライン エンドポイントを使用すると、REST 呼び出しを使用して外部アプリケーションからパイプラインを呼び出すことができます。 REST エンドポイントを呼び出すときに認証する方法については、 https://aka.ms/pl-restep-authを参照してください。

パイプラインの実行に関連付けられている元のパイプラインは、発行されたパイプラインのベースとして使用されます。
save

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

このパイプラインの実行が完了するまで待ちます。

待機後の状態を返します。

cancel

進行中の実行を取り消します。

cancel()

child_run

パイプライン実行の子実行を作成します。 このメソッドは PipelineRun には実装されていません。

child_run(name=None, run_id=None, outputs=None)

パラメーター

名前 説明
name
str

子の省略可能な名前。

規定値: None
run_id
str

子の実行 ID (省略可能)、それ以外の場合は既定値を使用します。

規定値: None
outputs
str

子を追跡するディレクトリを出力するオプション。

規定値: None

戻り値

型 説明
Run

子実行。

例外

型 説明
NotImplementedError

complete

パイプラインの実行を完了としてマークします。 このメソッドは PipelineRun には実装されていません。

このメソッドはパイプラインではサポートされていません。完了/失敗状態は、Azure ML バックエンドによって管理されます。

complete()

例外

型 説明
NotImplementedError

fail

パイプラインの実行を失敗としてマークします。 このメソッドは PipelineRun には実装されていません。

このメソッドはパイプラインではサポートされていません。完了/失敗状態は、Azure ML バックエンドによって管理されます。

fail()

例外

型 説明
NotImplementedError

find_step_run

名前でパイプラインでステップ実行を見つけます。

find_step_run(name)

パラメーター

名前 説明
name
必須
str

検索するステップの名前。

戻り値

型 説明
list

指定された名前を持つ StepRun オブジェクトの一覧。

get

実行 ID に基づいてパイプラインの実行をフェッチします。

static get(workspace, run_id, _service_endpoint=None)

パラメーター

名前 説明
workspace
必須
Workspace

パイプラインに関連付けられているワークスペース。
run_id
必須
str

パイプラインの実行の ID。
_service_endpoint
str

接続先のエンドポイント。

規定値: None

戻り値

型 説明
PipelineRun

PipelineRun オブジェクトです。

get_graph

パイプラインの実行のグラフを取得します。

get_graph()

戻り値

型 説明
Graph

グラフ。

get_pipeline_output

指定されたパイプライン出力の PortDataReference を取得します。

get_pipeline_output(pipeline_output_name)

パラメーター

名前 説明
pipeline_output_name
必須
str

取得するパイプライン出力の名前。

戻り値

型 説明
PortDataReference

パイプライン出力データを表す PortDataReference。

get_pipeline_runs

発行されたパイプラインから生成されたパイプライン実行をフェッチします。

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

パラメーター

名前 説明
workspace
必須
Workspace

パイプラインに関連付けられているワークスペース。
pipeline_id
必須
str

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

接続先のエンドポイント。

規定値: None

戻り値

型 説明
list

PipelineRun オブジェクトの一覧。

get_status

パイプライン実行の最新の状態をサービスからフェッチします。

返される一般的な値は、"Running"、"Finished"、"Failed" です。

get_status()

戻り値

型 説明
str

文字列としての最新の状態。

注釈

  • NotStarted - これは、クラウドの送信前にクライアント側の Run オブジェクトが存在する一時的な状態です

  • 実行中 - コンピューティング 先でジョブの実行が開始されました。

  • 失敗 - 実行に失敗しました。 通常、実行の Error プロパティは、理由に関する詳細を提供します。

  • 完了 - 実行が正常に完了しました。

  • キャンセル済み - 取り消し要求の後、実行は正常に取り消されました。


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

実行が完了または開始されたすべてのパイプライン ステップのステップ実行を取得します。

get_steps()

戻り値

型 説明
list

StepRun オブジェクトの一覧。

get_tags

実行のタグのセットを取得します。

get_tags()

戻り値

型 説明
dict

実行のタグのディクショナリ。

publish_pipeline

パイプラインを発行し、再実行できるようにします。

この関数によって返される PublishedPipeline オブジェクトからパイプライン エンドポイントを取得できます。 パイプライン エンドポイントを使用すると、REST 呼び出しを使用して外部アプリケーションからパイプラインを呼び出すことができます。 REST エンドポイントを呼び出すときに認証する方法については、 https://aka.ms/pl-restep-authを参照してください。

パイプラインの実行に関連付けられている元のパイプラインは、発行されたパイプラインのベースとして使用されます。

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

パラメーター

名前 説明
name
必須
str

発行されたパイプラインの名前。
description
必須
str

発行されたパイプラインの説明。
version
必須
str

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

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

規定値: None
kwargs
必須
dict

カスタム キーワード引数(将来の開発用に予約済み)

戻り値

型 説明
PublishedPipeline

発行されたパイプラインを作成しました。

save

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

save(path=None)

パラメーター

名前 説明
path
str

YAML を保存するパス。 パスがディレクトリの場合、パイプライン YAML ファイルは <path>/pipeline.yml に保存されます。 path が none の場合は、現在のディレクトリが使用されます。

規定値: None

戻り値

型 説明
None

wait_for_completion

このパイプラインの実行が完了するまで待ちます。

待機後の状態を返します。

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

パラメーター

名前 説明
show_output
bool

sys.stdout でパイプラインの実行状態を表示するかどうかを示します。

規定値: True
timeout_seconds
int

タイムアウトになるまで待機する秒数。

規定値: 9223372036854775807
raise_on_error
bool

実行が失敗した状態のときにエラーを発生させるかどうかを示します。

規定値: True

戻り値

型 説明
str

最終的な状態。