Codespaceスケジューリング¶
Codespaceのスケジューリング機能を使用すると、ノートブックを非対話モードでスケジュールどおりに実行することで、コードベースのワークフローを自動化できます。
その他の重要情報については、関連する注意事項を参照してください。
ノートブックのジョブを作成¶
ノートブックのスケジューリングは、ノートブックのジョブによって管理されます。 新しいノートブックジョブを作成できるのは、codespaceがオフラインのときだけです。 現在、アクティブなセッションでCodespaceが開いている場合、Codespace内にノートブックの新しいジョブを作成する前に、このインタラクティブセッションをシャットダウンする必要があります。
ノートブックジョブを作成するには、Codespaceセッションを開始し、スケジュールを設定するノートブックを選択します。 次に、サイドバーのカレンダーアイコンを選択して、ノートブックのジョブタブにアクセスします。
ノートブックのジョブタブで、ノートブックのジョブを作成を選択します。 次に、ノートブックジョブモーダルからスケジュールを設定します。
フィールド名 | 説明 |
---|---|
ジョブ名 | 作成するノートブックジョブの名前を入力します。 |
ノートブック | 鉛筆アイコンを使用して、スケジュールを作成するノートブックを選択します。 Codespaceのファイルシステムの任意のノートブックから選択できます。 |
実行モード | ノートブックの実行スケジュールを設定します。
|
スケジュールタイプ | シンプルなスケジュールまたはcronスケジュールのいずれかを選択します。 シンプルなスケジュールでは、ノートブックを実行する頻度と時間だけが必要です。 cronスケジュールでは、ノートブックを実行する正確な日時を設定し、分、時間、日付、月、曜日を指定できます。 |
頻度 | ノートブックの実行頻度を設定します(1時間ごと、毎日、毎月など)。 |
時間 | スケジュールに従ってノートブックを実行する時刻を指定します。 より詳細なスケジューリングオプションを使用するには、Cronスケジュールを選択します。 |
パラメーター | (オプション)パラメーター化については後述します。 ノートブックにパラメーターを定義すると、ノートブックに移動して各値を手動で変更する必要がなく、スケジュールされた実行時にパラメーターの値が自動的に指定されます。 パラメーターを単一のエントリーとして追加するか、一括でインポートするかを選択します。 |
ノートブックジョブの設定が完了したら、作成をクリックします。 スケジュール設定済みのノートブックジョブを作成すると、DataRobotはCodespaceセッションをシャットダウンします(無効化された状態のジョブを作成した場合を除く)。 予期しない動作とファイルシステムの競合を防ぐために、Codespaceでスケジュールが有効化されている場合は、インタラクティブセッションでCodespaceを開始することはできません。 新しく作成されたノートブックジョブは、ノートブックのジョブタブから見ることができます。 ノートブックジョブが実行されると、その結果(セル出力)はノートブックに表示されます。
ノートブックのパラメーター化¶
ノートブックをパラメーター化することで、ノートブックのスケジューリングによって可能になる自動化を強化できます。 Codespace内の特定の値をパラメーターとして定義することで、実行ごとに値を変更するためにノートブック自体を継続的に修正する必要がなく、ノートブックジョブの実行時にこれらのパラメーターに値を入力できます。 DataRobotは、スケジュール設定済みのノートブックジョブとCodespaceの手動での「今すぐ実行」ノートブックジョブの両方のパラメーター化をサポートしています。
ノートブックの特定の値をパラメーター化するには、パラメーターを codespaceの環境変数として定義する必要があります。 環境変数の値が、パラメーターのデフォルト値となります。
一度定義したら、以下のように対応する環境変数を取得することで、このパラメーターをコードで使用できます。
ノートブックジョブを実行すると、最初にセッションの環境変数がCodespaceの環境変数に従って設定されます。ジョブに定義されたパラメーターは、ノートブックのカーネルレベルで設定され、対応するCodespace環境変数のデフォルト値を上書きします。 ただし、これらのランタイムパラメーター値は、対応する codespace環境変数の保存値を置き換えるものではありません。
パラメーターを追加する場合、キーと値のペアを追加して1つずつ追加することも、一括で定義することもできます。 下のテキストフィールドに改行で区切られたキーと値のペアを指定することで、 複数の環境変数をまとめて追加できます。次の形式を使用: フィールドの各行で次の形式を使用します。
KEY=VALUE # DESCRIPTION
ノートブックジョブ定義の管理¶
ノートブックでスケジュールされたジョブの定義は、ノートブックのジョブタブに表示されます。 アクションメニュー をクリックして、実行履歴の表示やジョブの編集など、ジョブ定義で実行できるアクションのリストにアクセスします。
備考
ジョブ定義を無効にすると、スケジュールが一時停止します。 スケジュールが再び有効になるまで、スケジュールされたジョブの新しい自動実行は送信されません。
ユースケースホームページのノートブックタブのジョブ定義セクションに移動することで、ユースケース内のすべてのノートブックを対象として、スケジュールされた全ジョブの定義を表示することもできます。
さらに、ワークベンチで設定されたすべてのユースケースにわたって設定済みのノートブックジョブを表示できます。 そのためには、ユースケースにアクセスし、ノートブックタブに移動します。 次に、すべてのワークベンチノートブックをクリックします。
アクセスできる個々のユースケースに作成されたすべてのノートブックを示すページが表示されます。 ここから、ジョブ定義タブを選択して、これらのユースケースで設定されたすべてのノートブックジョブを表示できます。
実行履歴の監視¶
DataRobotは、スケジュールされたノートブックの各自動実行と、「今すぐ実行」アクションによってトリガーされたノートブックの各手動実行の履歴とメタデータを追跡します。 実行履歴を表示するには、ユースケースのホームページでノートブックタブの実行履歴セクションに移動します。 実行履歴セクションには、実行の開始時刻(UTC)、終了時刻(UTC)、期間、ステータスなど、各実行のメタデータが表示されます。
アクションメニュー をクリックして、実行結果をダウンロードするか、実行をキャンセルします。 表示したい列でフィルターし、列を並び替えるには、設定を選択します。
ノートブックの各実行には対応するノートブックリビジョンがあります。これはノートブック(およびセル出力)のスナップショットで、DataRobotは各ノートブックジョブの実行終了時に自動的に収集します。 これにより、ノートブックの現在のバージョンが変更されていても、以前のノートブックの実行結果に戻って確認できます。 ノートブックのリビジョンは、実行履歴テーブルの実行結果列に表示されます。 テーブル内の実行をクリックすると、対応する実行のノートブックリビジョンが表示されます。
ノートブックのスケジューリングに関する注意事項¶
ノートブックのスケジューリングを行う前に、以下の注意事項を確認してください。
-
Codespaceでは、アクティブなスケジュールは5つに制限されています。 さらに、各ノートブックでアクティブにできるスケジュールは一度に1つだけです。 したがって、1つのcodespaceで、5つのノートブックに対して最大5つのアクティブなスケジュールを同時に設定できます。 スケジュールされた別のノートブックジョブを作成したい場合は、別のノートブックの既存のスケジュールを無効にする必要があります。
-
Codespaceにアクティブで有効なスケジュールジョブ定義がある場合、対話型セッションでそのcodespaceを開始することはできません。 インタラクティブセッションでCodespaceを編集または実行するには、有効なスケジュール済みノートブックジョブを無効にする必要があります。
-
スケジュールに指定できる最小の頻度は、1時間ごとです。
-
組織レベルで同時に実行できるノートブックジョブの最大数は2つです。 これは、同時に実行できる対話型ノートブックセッションの最大数とは別の制限です。
-
現在、ノートブックジョブを実行するための最大実行時間は24時間です。 このノートブックの実行制限に達すると、ジョブは終了します。