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)

パラメーター

戻り値

スケジュールを 'Disabled' および実行不可能に設定します。

disable(wait_for_provisioning=False, wait_timeout=3600)

パラメーター

スケジュールを 'Active' および実行可能に設定します。

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 がサポートされています。 1 つは、スケジュール作成の繰り返し情報の読み取りと読み込みによって、パイプラインをトリガーするものです。 もう 1 つは、スケジュール作成のデータストア情報の読み取りと読み込みによって、パイプラインをトリガーするものです。

繰り返しでパイプラインを送信するスケジュールを作成する例は、次のようになります。

   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 のポーリング間隔 (分) を取得します。

戻り値

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

戻り値

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

戻り値