Schedule クラス

パイプラインのスケジュールを作成します。

時間ベースのスケジュールの繰り返しを指定するか、データストアを指定するか、(省略可能) polling_interval、および (省略可能) data_path_parameter_nameを指定して、データストアの場所の変更/追加を監視するスケジュールを作成します。

static create(workspace, name, pipeline_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

パイプライン エンドポイントのスケジュールを作成します。

時間ベースのスケジュールの繰り返しを指定するか、データストアを指定するか、(省略可能) polling_interval、および (省略可能) data_path_parameter_nameを指定して、データストアの場所の変更/追加を監視するスケジュールを作成します。

static create_for_pipeline_endpoint(workspace, name, pipeline_endpoint_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

スケジュールを [無効] に設定し、実行できません。

disable(wait_for_provisioning=False, wait_timeout=3600)

パラメーター

スケジュールを "アクティブ" に設定し、実行できるようにします。

enable(wait_for_provisioning=False, wait_timeout=3600)

パラメーター

指定された ID を使用してスケジュールを取得します。

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

パラメーター

戻り値

現在のワークスペースのすべてのスケジュールを取得します。

非推奨: このメソッドは、 list メソッドを優先して非推奨とされています。

static get_all(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

スケジュールによって送信された最後のパイプライン実行をフェッチします。 実行が送信されていない場合は None を返します。

get_last_pipeline_run()

戻り値

スケジュールから生成されたパイプライン実行をフェッチします。

get_pipeline_runs()

戻り値

指定されたパイプライン エンドポイント ID のすべてのスケジュールを取得します。

static get_schedules_for_pipeline_endpoint_id(workspace, pipeline_endpoint_id, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

指定されたパイプライン ID のすべてのスケジュールを取得します。

static get_schedules_for_pipeline_id(workspace, pipeline_id, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

現在のワークスペースのすべてのスケジュールを取得します。

static list(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

スケジュール パラメーターを取得するには、YAML ファイルを読み込んで読み取ります。

YAML ファイルは、スケジュールを作成するために Schedule パラメーターを渡すもう 1 つの方法です。

static load_yaml(workspace, filename, _workflow_provider=None, _service_endpoint=None)

パラメーター

戻り値

注釈

スケジュールでは、2 種類の YAML がサポートされています。 最初の読み取りと、パイプラインをトリガーするスケジュール作成の繰り返し情報を読み込みます。 2 つ目は、パイプラインをトリガーするスケジュール作成のデータストア情報を読み取って読み込みます。

繰り返しにパイプラインを送信するスケジュールを作成する例を次に示します。

   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_recurrence.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld", recurrence=schedule_info.get("recurrence"),
                              description=schedule_info.get("description"))

サンプル YAML ファイル test_schedule_with_recurrence.yaml:

   Schedule:
       description: "Test create with recurrence"
       recurrence:
           frequency: Week # Can be "Minute", "Hour", "Day", "Week", or "Month".
           interval: 1 # how often fires
           start_time: 2019-06-07T10:50:00
           time_zone: UTC
           hours:
           - 1
           minutes:
           - 0
           time_of_day: null
           week_days:
           - Friday
       pipeline_parameters: {'a':1}
       wait_for_provisioning: True
       wait_timeout: 3600
       datastore_name: ~
       polling_interval: ~
       data_path_parameter_name: ~
       continue_on_step_failure: None
       path_on_datastore: ~

次のように、データストアにパイプラインを送信するスケジュールを作成する例:

   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_datastore.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld",datastore=schedule_info.get("datastore_name"),
                              polling_interval=schedule_info.get("polling_interval"),
                              data_path_parameter_name=schedule_info.get("data_path_parameter_name"),
                              continue_on_step_failure=schedule_info.get("continue_on_step_failure"),
                              path_on_datastore=schedule_info.get("path_on_datastore"))

スケジュールを更新します。

update(name=None, description=None, recurrence=None, pipeline_parameters=None, status=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=None, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None)

パラメーター

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

戻り値

変更された BLOB パスで設定するデータ パス パイプライン パラメーターの名前を取得します。

戻り値

スケジュールに使用されるデータストアの名前を取得します。

戻り値

スケジュールの説明を取得します。

戻り値

スケジュールの ID を取得します。

戻り値

スケジュールの名前を取得します。

戻り値

スケジュールが監視するデータストアのパスを取得します。

戻り値

スケジュールが送信するパイプライン エンドポイントの ID を取得します。

戻り値

スケジュールが送信するパイプラインの ID を取得します。

戻り値

変更された BLOB または追加された BLOB のポーリングの間隔を分単位で取得します。

戻り値

スケジュールの繰り返しを取得します。

戻り値

スケジュールの状態を取得します。

戻り値