PipelineRun クラス
- 継承
-
PipelineRun
コンストラクター
PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)
パラメーター
注釈
submitメソッド を介してPipelineを送信するとき (Experimentの submit メソッドを使用)、PipelineRun オブジェクトが返されます。 パイプラインを作成して送信する方法の詳細については、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 に対して実装されていません。 このメソッドは、パイプラインではサポートされていません。completion/failed 状態は、Azure ML バックエンドによって管理されます。 |
fail |
パイプライン実行を失敗としてマークします。 このメソッドは PipelineRun に対して実装されていません。 このメソッドは、パイプラインではサポートされていません。completion/failed 状態は、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)
パラメーター
戻り値
子の実行。
の戻り値の型 :
例外
complete
パイプライン実行を完了としてマークします。 このメソッドは PipelineRun に対して実装されていません。
このメソッドは、パイプラインではサポートされていません。completion/failed 状態は、Azure ML バックエンドによって管理されます。
complete()
例外
fail
パイプライン実行を失敗としてマークします。 このメソッドは PipelineRun に対して実装されていません。
このメソッドは、パイプラインではサポートされていません。completion/failed 状態は、Azure ML バックエンドによって管理されます。
fail()
例外
find_step_run
get
実行 ID に基づいてパイプライン実行をフェッチします。
static get(workspace, run_id, _service_endpoint=None)
パラメーター
戻り値
PipelineRun オブジェクト。
の戻り値の型 :
get_graph
get_pipeline_output
指定されたパイプライン出力の PortDataReference を取得します。
get_pipeline_output(pipeline_output_name)
パラメーター
戻り値
パイプライン出力データを表す PortDataReference。
の戻り値の型 :
get_pipeline_runs
発行済みパイプラインから生成されたパイプラインの実行をフェッチします。
static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)
パラメーター
戻り値
PipelineRun オブジェクトのリスト。
の戻り値の型 :
get_status
サービスからパイプライン実行の最新の状態をフェッチします。
一般的には "Running"、"Finished"、"Failed" などの値が返されます。
get_status()
戻り値
文字列としての最新の状態。
の戻り値の型 :
注釈
NotStarted - これは、クラウド送信前のクライアント側 Run オブジェクトの一時的な状態です
Running - コンピューティング先でジョブの実行が開始されました。
Failed - 実行が失敗しました。 通常は実行の Error プロパティで、理由に関する詳細が提供されます。
Completed - 実行は正常に完了しました。
Canceled - 取り消し要求の後、実行は正常に取り消されました。
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_tags
publish_pipeline
パイプラインを発行し、再実行できるようにします。
この関数によって返される PublishedPipeline オブジェクトからパイプライン エンドポイントを取得できます。 パイプライン エンドポイントを使用すると、REST 呼び出しを使用して外部アプリケーションからパイプラインを起動できます。 REST エンドポイントを呼び出すときの認証方法については、https://aka.ms/pl-restep-authを参照してください。
パイプライン実行に関連付けられている元のパイプラインは、発行済みパイプラインのベースとして使用されます。
publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)
パラメーター
- continue_on_step_failure
- bool
あるステップが失敗した場合に、PipelineRun 内の別のステップの実行を続行するかどうか。 既定値は False です。
戻り値
作成された発行済みパイプライン。
の戻り値の型 :
save
パイプライン YAML をファイルに保存します。
save(path=None)
パラメーター
- path
- str
YAML の保存先パス。 パスがディレクトリの場合、パイプライン YAML ファイルは<path>/pipeline.yml に保存されます。 パスが None の場合は、現在のディレクトリが使用されます。
の戻り値の型 :
wait_for_completion
このパイプライン実行が完了するまで待機します。
待機後の状態を返します。
wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)
パラメーター
戻り値
最終的な状態。
の戻り値の型 :
フィードバック
https://aka.ms/ContentUserFeedback。
近日公開予定: 2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub イシューを段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、以下を参照してください:フィードバックの送信と表示