Codespace scheduling¶

Codespaceのスケジューリング機能を使用すると、ノートブックを非対話モードでスケジュールどおりに実行することで、コードベースのワークフローを自動化できます。

その他の重要情報については、関連する注意事項を参照してください。

ノートブックのジョブを作成¶

ノートブックのスケジューリングは、ノートブックのジョブによって管理されます。 新しいノートブックジョブを作成できるのは、codespaceがオフラインのときだけです。 If your codespace is currently open in an active session, you will need to first shut down this interactive session before you can create a new job for a notebook within the codespace.

To create a notebook job, start the codespace session and select the notebook for which you want scheduling. 次に、サイドバーのカレンダーアイコンを選択して、ノートブックのジョブタブにアクセスします。

ノートブックのジョブタブで、ノートブックのジョブを作成を選択します。 次に、ノートブックジョブモーダルからスケジュールを設定します。

ノートブックジョブの設定が完了したら、作成をクリックします。 Once you’ve created the scheduled notebook job, DataRobot shuts down the codespace session (unless you’ve created the job in a disabled state). A codespace cannot be started in an interactive session while it has an enabled schedule on it in order to prevent unexpected behavior and filesystem conflicts. 新しく作成されたノートブックジョブは、ノートブックのジョブタブから見ることができます。 ノートブックジョブが実行されると、その結果（セル出力）はノートブックに表示されます。

ノートブックのパラメーター化¶

ノートブックをパラメーター化することで、ノートブックのスケジューリングによって可能になる自動化を強化できます。 Codespace内の特定の値をパラメーターとして定義することで、実行ごとに値を変更するためにノートブック自体を継続的に修正する必要がなく、ノートブックジョブの実行時にこれらのパラメーターに値を入力できます。 DataRobot supports parameterization for both scheduled notebook jobs as well as manual “Run now” notebook jobs in a codespace.

ノートブックの特定の値をパラメーター化するには、パラメーターを codespaceの環境変数として定義する必要があります。 環境変数の値が、パラメーターのデフォルト値となります。

一度定義したら、以下のように対応する環境変数を取得することで、このパラメーターをコードで使用できます。

When a notebook job is executed, the session's environment variables will first be set according to codespace's environment variables; any parameters defined for the job will be set at the notebook kernel level and override the corresponding codespace environment variable's default value. ただし、これらのランタイムパラメーター値は、対応する codespace環境変数の保存値を置き換えるものではありません。

パラメーターを追加する場合、キーと値のペアを追加して1つずつ追加することも、一括で定義することもできます。 下のテキストフィールドに改行で区切られたキーと値のペアを指定することで、 複数の環境変数をまとめて追加できます。次の形式を使用： フィールドの各行で次の形式を使用します。

KEY=VALUE # DESCRIPTION

ノートブックジョブ定義の管理¶

ノートブックでスケジュールされたジョブの定義は、ノートブックのジョブタブに表示されます。 Click the Actions menu to access the list of actions you can perform on the job definition, such as viewing the run history or editing the job.

ユースケースホームページのノートブックタブのジョブ定義セクションに移動することで、ユースケース内のすべてのノートブックを対象として、スケジュールされた全ジョブの定義を表示することもできます。

Additionally, you can view notebook jobs configured across all Use Cases configured in Workbench. これを行うには、ユースケースにアクセスし、そのノートブックタブに移動します。 次に、すべてのワークベンチノートブックをクリックします。

This brings you to a page that displays all notebooks created across every Use Case that you have access to. From here, you can select the Job definitions tab to view all notebook jobs configured across these Use Cases.

実行履歴の監視¶

DataRobotは、スケジュールされたノートブックの各自動実行と、「今すぐ実行」アクションによってトリガーされたノートブックの各手動実行の履歴とメタデータを追跡します。 実行履歴を表示するには、ユースケースのホームページでノートブックタブの実行履歴セクションに移動します。 実行履歴セクションには、実行の開始時刻（UTC）、終了時刻（UTC）、期間、ステータスなど、各実行のメタデータが表示されます。

Click the Actions menu to download run results or cancel a run. 表示したい列でフィルターし、列を並び替えるには、設定を選択します。

ノートブックの各実行には対応するノートブックリビジョンがあります。これはノートブック（およびセル出力）のスナップショットで、DataRobotは各ノートブックジョブの実行終了時に自動的に収集します。 これにより、ノートブックの現在のバージョンが変更されていても、以前のノートブックの実行結果に戻って確認できます。 ノートブックのリビジョンは、実行履歴テーブルの実行結果列に表示されます。 テーブル内の実行をクリックすると、対応する実行のノートブックリビジョンが表示されます。

ノートブックのスケジューリングに関する注意事項¶

ノートブックのスケジューリングを行う前に、以下の注意事項を確認してください。

• Codespace scheduling is limited to one active scheduled notebook job per codespace. If you do want to create another scheduled notebook job, you will need to disable the existing schedule.

• Codespaceにアクティブで有効なスケジュールジョブ定義がある場合、対話型セッションでそのcodespaceを開始することはできません。 In order to edit or execute your codespace in an interactive session, you will need to disable any enabled scheduled notebook job.

• スケジュールに指定できる最小の頻度は、1時間ごとです。

• 組織レベルで同時に実行できるノートブックジョブの最大数は2つです。 これは、同時に実行できる対話型ノートブックセッションの最大数とは別の制限です。

• The max run time for a notebook job to execute is currently 24 hours. After that notebook execution limit is reached, the job will be terminated.