Skip to content

アプリケーション内で をクリックすると、お使いのDataRobotバージョンに関する全プラットフォームドキュメントにアクセスできます。

カスタム指標

デプロイのモニタリング > カスタム指標タブでは、 データのエクスポートタブから収集するデータ(または他のカスタム指標を介して計算されたデータ)を使用して、最大25のカスタムビジネスまたはパフォーマンス指標を計算および監視できます。 これらの指標は、設定可能なカスタム指標サマリーダッシュボードに記録され、そこで各指標の経時変化を監視、視覚化、およびエクスポートします。 この機能により、組織固有の指標を実装して、DataRobotに組み込まれているサービスの正常性データドリフト精度の各指標によって提供されるインサイトを拡張できます。

カスタム指標数の上限

You can have up to 25 custom metrics per deployment.

To view and add custom metrics, in the Console, open the deployment for which you want to create custom metrics and click the Monitoring > Custom metrics tab:

Add custom metrics

The Custom metrics tab can track up to 25 metrics per deployment, including metrics hosted externally, and metrics hosted on custom jobs infrastructure. To add a metric, in a predictive or generative modeling deployment, click the Monitoring > Custom metrics tab. Then, on the Custom metrics tab, click + Add custom metric, select one of the following custom metric types, and proceed to the configuration steps linked in the table:

カスタム指標の種類 説明
新しい外部指標 Add a custom metric where the calculations of the metric are not directly hosted by DataRobot. An external metric is a simple API used to submit a metric value for DataRobot to save and visualize. The metric calculation is handled externally, by the user. External metrics can be combined with other tools in DataRobot like notebooks, jobs, or custom models, or external tools like Airflow or cloud providers to provide the hosting and calculation needed for a particular metric.

External custom metrics provide a simple option to save a value from your AI solution for tracking and visualization in DataRobot. For example, you could track the change in LLM cost, calculated by your LLM provider, over time.
新しいホストされた指標 Add a custom metric where the metric calculations are hosted in a custom job within DataRobot. For hosted metrics, DataRobot orchestrates pulling the data, computing the metric values, saving the values to storage, and visualizing the data. No outside tools or infrastructure are required.

Hosted custom metrics provide a complete end-to-end workflow for building business-specific metrics and dashboards in DataRobot.
テンプレートから新規作成 Add a custom metric from a template, or ready-to-use example of a hosted custom metric, where DataRobot provides the code and automates the creation process. With metric templates, the result is a hosted metric, without starting from scratch. Templates are provided by DataRobot and can be used as-is or modified to calculate new metrics.

Hosted custom metric templates provide the simplest way to get started with custom metrics, where DataRobot provides an example implementation and a complete end-to-end workflow. They are ready to use in just a few clicks.

外部カスタム指標を追加

External custom metrics allow you to create metrics with calculations occurring outside of DataRobot. With an external metric, you can submit a metric value for DataRobot to save and visualize. External metrics can be combined with other tools in DataRobot like notebooks, jobs, or custom models, or external tools like Airflow or cloud providers to provide the hosting and calculation needed for a particular metric.

To add an external custom metric, in the Add Custom Metric dialog box, configure the metric settings, and then click Add custom metric:

フィールド 説明
名前 (必須)指標の説明的な名前。 この名前は、カスタム指標サマリーダッシュボードに表示されます。
説明 カスタム指標の説明。たとえば、目的、計算方法などを説明することができます。
Y軸の名前(ラベル) (必須)従属変数の説明的な名前。 この名前は、カスタム指標サマリーダッシュボードのカスタム指標のチャートに表示されます。
デフォルトの間隔 The default interval used by the selected Aggregation type. HOURのみサポートされています。
ベースライン The value used as a basis for comparison when calculating the x% better or x% worse values.
集計タイプ The type of metric calculation. Select from Sum, Average, or Gauge—a metric with a distinct value measured at single point in time.
指標の方向 The directionality of the metric, which controls how changes to the metric are visualized. 大きいほど良いまたは低いほど良いを選択できます。 たとえば、低いほど良いを選択すると、カスタム指標の計算値が10%減少することが、10%改善とみなされ、緑色で表示されます。
Is model-specific この設定を有効にすると、データセットで提供されたモデルパッケージID(登録されているモデルバージョンID)を使用して、指標をモデルにリンクします。 この設定は、値が集計(またはアップロード)される場合に影響します。 例:
  • モデル固有(有効):モデルの精度指標はモデル固有であるため、値は完全に個別に集計されます。 モデルを置換すると、カスタム精度指標のチャートには、置換後の日についてのデータだけが表示されます。
  • モデル固有ではありません(無効):収益指標はモデル固有ではないため、値は一緒に集計されます。 モデルを置換しても、カスタム収益指標のチャートは変更されません。
このフィールドは、指標を作成した後は編集できません。
列名の定義
タイムスタンプ列 (必須)タイムスタンプを含むデータセット内の列。
値列 (必須)カスタム指標の計算に使用される値を含むデータセット内の列。
日付形式 タイムスタンプ列で使用される日付形式。

備考

カスタム指標にデータをアップロードするときに、列名の定義設定をオーバーライドできます。

Add hosted custom metrics

本機能の提供について

Hosted custom metrics are off by default and require custom jobs and environments, which are also off by default. この機能を有効にする方法については、DataRobotの担当者または管理者にお問い合わせください。

機能フラグ:ホストされたカスタム指標を有効にする、カスタムジョブを有効にする、Notebooksでカスタム環境を有効にする

Hosted custom metrics allow you to implement up to 25 of your organization's specialized metrics in a deployment, uploading the custom metric code using DataRobot Notebooks and hosting the metric calculation on custom jobs infrastructure. After creation, these custom metrics can be reused for other deployments.

To add a hosted custom metric, in the Add Custom Metric dialog box configure the metric settings, and then click Add custom metric from notebook:

フィールド 説明
名前 (必須)指標の説明的な名前。 この名前は、カスタム指標サマリーダッシュボードに表示されます。
説明 カスタム指標の説明。たとえば、目的、計算方法などを説明することができます。
Y軸の名前(ラベル) (必須)従属変数の説明的な名前。 この名前は、カスタム指標サマリーダッシュボードのカスタム指標のチャートに表示されます。
デフォルトの間隔 選択した集計タイプで使用されるデフォルトの間隔を決定します。 HOURのみサポートされています。
ベースライン x%良い値またはx%悪い値を計算するときに比較の基準として使用する値を決定します。
集計タイプ 指標が合計平均、またはゲージとして計算されるかどうかを決定します。
指標の方向 指標の方向性を決定し、指標の変更を視覚化する方法を変更します。 大きいほど良いまたは低いほど良いを選択できます。 たとえば、低いほど良いを選択すると、カスタム指標の計算値が10%減少することが、10%改善とみなされ、緑色で表示されます。
モデル固有 この設定を有効にすると、データセットで提供されたモデルパッケージID(登録されているモデルバージョンID)を使用して、指標をモデルにリンクします。 この設定は、値が集計(またはアップロード)される場合に影響します。 例:
  • モデル固有(有効):モデルの精度指標はモデル固有であるため、値は完全に個別に集計されます。 モデルを置換すると、カスタム精度指標のチャートには、置換後の日についてのデータだけが表示されます。
  • モデル固有ではありません(無効):収益指標はモデル固有ではないため、値は一緒に集計されます。 モデルを置換しても、カスタム収益指標のチャートは変更されません。
このフィールドは、指標を作成した後は編集できません。
スケジュール カスタム指標に値が入力されるタイミングを定義します。 頻度(1時間ごと、1日ごと、1か月ごとなど)と時間を選択します。 詳細なスケジューリングオプションを使用するには、高度なスケジューラーを使用するを選択します。

カスタム指標を設定すると、そのコードを含むノートブックがロードされます。 The notebook contains one custom metric cell. A custom metric cell is a unique notebook cell, containing Python code defining how the metric is exported and calculated, code for scoring, and code to populate the metric. 必要に応じて、カスタム指標セルのコードを変更します。 次に、セルの下部にあるカスタム指標コードをテストをクリックして、コードをテストします。 テストではカスタムジョブが作成されます。 テストが正常に実行された場合、カスタム指標コードをデプロイをクリックして、カスタム指標をデプロイに追加します。

コードが正しく実行されない場合、テスト完了後に、カスタム指標コードのテストに失敗しましたという警告が表示されます。 Click Open custom metric job to access the job and check the logs to troubleshoot the issue:

To troubleshoot a custom metric's code, navigate to the job's Runs tab, containing a log of the failed test. In the failed run, click View log.

本機能の提供について

The custom metric gallery requires hosted custom metrics and custom jobs and environments, which are off by default. この機能を有効にする方法については、DataRobotの担当者または管理者にお問い合わせください。

機能フラグ:ホストされたカスタム指標を有効にする、カスタムジョブを有効にする、Notebooksでカスタム環境を有効にする

The custom metrics gallery provides a centralized library containing pre-made, reusable, and shareable code implementing a variety of hosted custom metrics for predictive and generative models. これらの指標は、変更可能なカスタム指標サマリーダッシュボードで、外部のカスタム指標とともに記録されます。 このダッシュボードから、各指標の時間経過に伴う変化を監視、視覚化、およびエクスポートできます。 この機能により、組織固有の指標を実装して、DataRobotに組み込まれているサービスの正常性、データドリフト、精度の各指標によって提供されるインサイトを拡張できます。

事前に作成されたカスタム指標をデプロイに追加するには:

  1. カスタム指標を追加パネルで、ユースケースに適したカスタム指標テンプレートを選択します。

    デプロイで使用可能な指標は、指標アイコンが強調表示された状態でリストの先頭に表示されます。 たとえば、生成モデルデプロイでは、次のように表示されます。

  2. リストから指標を選択したら、カスタム指標設定サイドバーで、指標計算スケジュールを設定するか、指標計算を直ちに実行し、必要に応じて指標ベースライン値を設定します。

  3. 指標を作成をクリックします。 The new metric appears on the Custom metrics dashboard.

  4. カスタム指標を作成すると、その指標に関連付けられたカスタムジョブを表示できます。 このジョブは定義されたスケジュールで実行され、ギャラリーからではない ホストされたカスタム指標と同様にカスタム指標を計算します。 関連付けられたカスタムジョブにアクセスして管理するには、オプションアイコン()をクリックし、 カスタムジョブを開くをクリックします。

    Sidecar metrics

    If you selected a [sidecar metric], when you open the Assemble tab, navigate to the Runtime Parameters section to set the SIDECAR_DEPLOYMENT_ID, associating the sidecar metric with the connected deployment required to calculate that metric. If you haven't deployed a model to calculate the metric, you can find pre-defined models for these metrics as global models.

カスタム指標にデータをアップロード

カスタム指標を作成した後、データを提供して指標を計算できます。

  1. カスタム指標タブで、データをアップロードするカスタム指標を見つけ、 データをアップロードするアイコンをクリックします。

  2. データをアップロードダイアログボックスで、アップロード方法を選択してから、次へをクリックします:

    アップロード方法 説明
    データレジストリを使用 In the Select a dataset panel, upload a dataset or click a dataset from the list, and then click Confirm. データレジストリには、 データのエクスポートタブからのデータセットが含まれています。
    APIを使用 APIクライアントを使用ダイアログボックスで、クリップボードにコピーをクリックしてから、APIスニペットを変更し、それを使用してデータセットをアップロードします。 1回のAPI呼び出しで最大10,000個の値をアップロードできます。
  3. データセット列を選択ダイアログボックスで、以下を設定します。

    フィールド 説明
    タイムスタンプ列 (必須)タイムスタンプを含むデータセット内の列。
    値列 (必須)カスタム指標の計算に使用される値を含むデータセット内の列。
    関連付けID The row containing the association ID required by the custom metric to link predicted values to actuals.
    日付形式 タイムスタンプ列で使用される日付形式。
  4. データをアップロードするをクリックします。

カスタム指標を管理

カスタム指標ダッシュボードでは、カスタム指標を追加した後、それらを編集、配置、または削除できます。

指標を編集または削除するには、カスタム指標タブで、管理するカスタム指標を見つけてから、その他のオプションアイコンをクリックします。

  • 指標を編集するには、 編集をクリックし、変更可能な設定を更新して、カスタム指標を更新をクリックします。

  • 指標を削除するには、 削除をクリックします。

カスタム指標サマリーダッシュボードで指標を並べ替えたり非表示にしたりするには、移動または非表示にするカスタム指標を見つけます。

  • 指標を移動するには、指標タイルの左側にあるグリッドアイコン をクリックしてから、指標を新しい場所にドラッグします。

  • 指標のチャートを非表示にするには、指標名の横にあるチェックボックスをオフにします。

カスタム指標ダッシュボードの表示設定を設定

以下の設定を行い、ダッシュボードに表示するカスタム指標の計算を指定します。

設定 説明
1 モデル カスタム指標を表示するデプロイのモデル(現在または以前)を選択します。
2 範囲(UTC)/ 日付スライダー カスタム指標を表示する期間の開始日と終了日を選択します。
3 単位 日付スライダーの時間単位を選択します。 選択した時間範囲に基づき、単位を毎時、毎日、毎週、毎月から選択します。 時間範囲が7日を超える場合、単位を毎時にすることはできません。
4 表示を更新 カスタム指標ダッシュボードを更新します。
5 リセット カスタム指標ダッシュボードの表示設定をデフォルトに戻します。

更新しました April 8, 2024