翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon SageMaker Model Monitor を使用した独自のコンテナのサポート
Amazon SageMaker Model Monitor には、エンドポイントまたはバッチ変換ジョブからキャプチャした表形式のデータセットのデータを分析する機能を備えた、ビルド済みコンテナが用意されています。独自のコンテナを持ち込む場合は、Model Monitor が提供する拡張ポイントを活用できます。
内部的には、`MonitoringSchedule` を作成すると、Model Monitor が処理ジョブを最終的に開始します。したがってコンテナは、「[独自の処理コンテナを構築する方法 (高度なシナリオ)](build-your-own-processing-container.md)」トピックに記載されている処理ジョブのコントラクトを認識する必要があります。Model Monitor はスケジュールに従って自動的に処理ジョブを開始することに注意してください。呼び出し中に、Model Monitor は追加の環境変数を設定し、スケジュールされた特定のモニタリング実行のデータ処理に十分なコンテキストがコンテナに含まれるようにします。コンテナ入力の詳細については、「[コンテナコントラクトの入力](model-monitor-byoc-contract-inputs.md)」を参照してください。
コンテナで、上記の環境変数/コンテキストを使用して、カスタムコード内の現在の期間のデータセットを分析できるようになりました。この分析が完了したら、出力されたレポートを S3 バケットにアップロードすることを選択できます。ビルド済みコンテナが生成するレポートについては、「[コンテナコントラクトの出力](model-monitor-byoc-contract-outputs.md)」を参照してください。SageMaker Studio でレポートを視覚化するには、同様の形式に従う必要があります。また、完全カスタムレポートの出力を選択することもできます。
「[独自のコンテナを取り込む場合の CloudWatch メトリクス](model-monitor-byoc-cloudwatch.md)」の手順に従って、コンテナから CloudWatch メトリクスを出力することもできます。
**Topics**
+ [コンテナコントラクトの入力](model-monitor-byoc-contract-inputs.md)
+ [コンテナコントラクトの出力](model-monitor-byoc-contract-outputs.md)
+ [独自のコンテナを取り込む場合の CloudWatch メトリクス](model-monitor-byoc-cloudwatch.md)
# コンテナコントラクトの入力
Amazon SageMaker Model Monitor プラットフォームは、指定されたスケジュールに従ってコンテナコードを呼び出します。独自のコンテナコードを記述する場合は、次の環境変数を使用できます。このコンテキストでは、現在のデータセットを分析することができます。また、メトリクスを選択して出力する場合は、制約を評価できます (該当する場合)。
使用可能な環境変数は、`dataset_format` 変数を除いてリアルタイムエンドポイントでもバッチ変換ジョブでも同じです。リアルタイムエンドポイントを使用している場合、`dataset_format` 変数は以下のオプションをサポートします。
```
{\"sagemakerCaptureJson\": {\"captureIndexNames\": [\"endpointInput\",\"endpointOutput\"]}}
```
バッチ変換ジョブを使用している場合、`dataset_format` は次のオプションをサポートします。
```
{\"csv\": {\"header\": [\"true\",\"false\"]}}
```
```
{\"json\": {\"line\": [\"true\",\"false\"]}}
```
```
{\"parquet\": {}}
```
以下のコードサンプルは、コンテナコードで使用できる環境変数一式を示しています (リアルタイムエンドポイントの `dataset_format` 形式も使用しています)。
```
"Environment": {
"dataset_format": "{\"sagemakerCaptureJson\": {\"captureIndexNames\": [\"endpointInput\",\"endpointOutput\"]}}",
"dataset_source": "/opt/ml/processing/endpointdata",
"end_time": "2019-12-01T16: 20: 00Z",
"output_path": "/opt/ml/processing/resultdata",
"publish_cloudwatch_metrics": "Disabled",
"sagemaker_endpoint_name": "endpoint-name",
"sagemaker_monitoring_schedule_name": "schedule-name",
"start_time": "2019-12-01T15: 20: 00Z"
}
```
パラメータ
| Parameter Name | 説明 |
| --- | --- |
| dataset\$1format | `Endpoint` によって支援された `MonitoringSchedule` から開始されたジョブでは、これは `endpointInput`、`endpointOutput`、またはその両方のキャプチャインデックスを持つ `sageMakerCaptureJson` になります。バッチ変換ジョブの場合、CSV、JSON、Parquet のいずれかのデータ形式を指定します。 |
| dataset\$1source | リアルタイム エンドポイントを使用している場合、`start_time` と `end_time` で指定されたモニタリング期間に対応するデータが使用可能なローカルパス。このパスでは、データは ` /{endpoint-name}/{variant-name}/yyyy/mm/dd/hh` で使用できます。 開始時刻と終了時刻で指定されているものよりも多くのデータをダウンロードする場合があります。必要に応じてデータを解析するかどうかはコンテナコード次第です。 |
| output\$1path | 出力レポートおよびその他のファイルを書き込むためのローカルパス。`CreateMonitoringSchedule` リクエストでこのパラメータを `MonitoringOutputConfig.MonitoringOutput[0].LocalPath` として指定します。これは、`MonitoringOutputConfig.MonitoringOutput[0].S3Uri` に指定された `S3Uri` パスにアップロードされます。 |
| publish\$1cloudwatch\$1metrics | `CreateMonitoringSchedule` によって起動されたジョブでは、このパラメータは `Enabled` に設定されます。コンテナは、`[filepath]` に Amazon CloudWatch 出力ファイルを書き込むことを選択できます。 |
| sagemaker\$1endpoint\$1name | リアルタイムエンドポイントを使用している場合は、このスケジュール済みジョブが起動された `Endpoint` の名前です。 |
| sagemaker\$1monitoring\$1schedule\$1name | このジョブを起動した `MonitoringSchedule` の名前。 |
| \$1sagemaker\$1endpoint\$1datacapture\$1prefix\$1 | リアルタイムエンドポイントを使用している場合は、`Endpoint` の `DataCaptureConfig` パラメータで指定されたプレフィックス。コンテナは、SageMaker AI が `dataset_source` パスに既にダウンロードしたデータ以外のデータに直接アクセスする必要がある場合に、これを使用できます。 |
| start\$1time, end\$1time | この分析の実行期間。たとえば、2020 年 2 月 20 日の 05:00 UTC に実行するようにスケジュールされたジョブの場合、`start_time`: は 2020-02-19T06:00:00Z、`end_time`: は 202020-02-20T 05:00:00 Z になります。 |
| baseline\$1constraints: | ` BaselineConfig.ConstraintResource.S3Uri` で指定されているベースライン制約ファイルのローカルパス。これは、このパラメータが `CreateMonitoringSchedule` リクエストで指定された場合にのみ使用できます。 |
| baseline\$1statistics | `BaselineConfig.StatisticsResource.S3Uri` で指定したベースライン統計ファイルへのローカルパス。これは、このパラメータが `CreateMonitoringSchedule` リクエストで指定された場合にのみ使用できます。 |
# コンテナコントラクトの出力
コンテナは、`*dataset_source*` パスで使用可能なデータを分析し、`*output_path*.` 内のパスにレポートを書き込むことができます。コンテナコードは、ニーズに合った任意のレポートを書くことができます。
次の構造と契約を使用すると、特定の出力ファイルは可視化と API で SageMaker AI によって特別に処理されます。これは、表形式のデータセットにのみ適用されます。
表形式データセットの出力ファイル
| ファイル名 | 説明 |
| --- | --- |
| statistics.json | このファイルには、分析対象のデータセット内の各フィーチャに対する列状の統計が含まれます。このファイルのスキーマは次のセクションで確認できます。 |
| constraints.json | このファイルには、確認されたフィーチャの制約が含まれます。このファイルのスキーマは次のセクションで確認できます。 |
| constraints\$1violations.json | このファイルには、`baseline_constaints` および `baseline_statistics` パスで指定されたベースライン統計および制約ファイルと比較して、この現在のデータセットで検出された違反のリストが含まれています。 |
さらに、`publish_cloudwatch_metrics` 値が `"Enabled"` である場合、コンテナコードは `/opt/ml/output/metrics/cloudwatch` に Amazon CloudWatch メトリクスを出力できます。これらのファイルのスキーマについては、続くセクションで説明します。
**Topics**
+ [統計のスキーマ (statistics.json ファイル)](model-monitor-byoc-statistics.md)
+ [制約のスキーマ (constraints.json ファイル)](model-monitor-byoc-constraints.md)
# 統計のスキーマ (statistics.json ファイル)
`statistics.json` ファイルに定義されているスキーマは、ベースラインに対して計算される統計パラメータと、取得されるデータを指定します。また、[KLL](https://datasketches.apache.org/docs/KLL/KLLSketch.html) が使用するバケットを設定します。KLL は、遅延圧縮スキームを持つ非常にコンパクトな分位数スケッチです。
```
{
"version": 0,
# dataset level stats
"dataset": {
"item_count": number
},
# feature level stats
"features": [
{
"name": "feature-name",
"inferred_type": "Fractional" | "Integral",
"numerical_statistics": {
"common": {
"num_present": number,
"num_missing": number
},
"mean": number,
"sum": number,
"std_dev": number,
"min": number,
"max": number,
"distribution": {
"kll": {
"buckets": [
{
"lower_bound": number,
"upper_bound": number,
"count": number
}
],
"sketch": {
"parameters": {
"c": number,
"k": number
},
"data": [
[
num,
num,
num,
num
],
[
num,
num
][
num,
num
]
]
}#sketch
}#KLL
}#distribution
}#num_stats
},
{
"name": "feature-name",
"inferred_type": "String",
"string_statistics": {
"common": {
"num_present": number,
"num_missing": number
},
"distinct_count": number,
"distribution": {
"categorical": {
"buckets": [
{
"value": "string",
"count": number
}
]
}
}
},
#provision for custom stats
}
]
}
```
**注意事項**
後の可視化の変更において、SageMaker AI はこの指定されたメトリクスを認識します。必要に応じて、コンテナはより多くのメトリクスを出力できます。
[KLL スケッチ](https://datasketches.apache.org/docs/KLL/KLLSketch.html)は、認識されるスケッチです。カスタムコンテナは独自の表現を記述できますが、可視化では、SageMaker AI はそのコンテナを認識できません。
デフォルトでは、ディストリビューションは 10 個のバケットでマテリアライズされます。これを変更することはできません。
# 制約のスキーマ (constraints.json ファイル)
constraints.json ファイルは、データセットが満たす必要がある制約を示すために使用されます。また、Amazon SageMaker Model Monitor コンテナは constraints.json ファイルを使用して、データセットを評価できます。ビルド済みコンテナは、ベースラインデータセットの constraints.json ファイルを自動的に生成する機能を提供します。独自のコンテナを持ち込む場合は、同様の機能を提供することも、他の方法で constraints.json ファイルを作成することもできます。以下は、ビルド済みコンテナが使用する制約ファイルのスキーマです。独自のコンテナを取り込む場合、同じ形式を採用するか、必要に応じてその機能を拡張できます。
```
{
"version": 0,
"features":
[
{
"name": "string",
"inferred_type": "Integral" | "Fractional" |
| "String" | "Unknown",
"completeness": number,
"num_constraints":
{
"is_non_negative": boolean
},
"string_constraints":
{
"domains":
[
"list of",
"observed values",
"for small cardinality"
]
},
"monitoringConfigOverrides":
{}
}
],
"monitoring_config":
{
"evaluate_constraints": "Enabled",
"emit_metrics": "Enabled",
"datatype_check_threshold": 0.1,
"domain_content_threshold": 0.1,
"distribution_constraints":
{
"perform_comparison": "Enabled",
"comparison_threshold": 0.1,
"comparison_method": "Simple"||"Robust",
"categorical_comparison_threshold": 0.1,
"categorical_drift_method": "LInfinity"||"ChiSquared"
}
}
}
```
`monitoring_config` オブジェクトには、機能のモニタリングジョブのオプションが含まれています。次の表で各オプションについて説明します。
制約のモニタリング
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/sagemaker/latest/dg/model-monitor-byoc-constraints.html)
# 独自のコンテナを取り込む場合の CloudWatch メトリクス
`/opt/ml/processing/processingjobconfig.json` ファイル内の `Environment` マップで `publish_cloudwatch_metrics` 値が `Enabled` である場合、コンテナコードは `/opt/ml/output/metrics/cloudwatch` に Amazon CloudWatch メトリクスを出力します。
このファイルのスキーマは、CloudWatch `PutMetrics` API に厳密に基づいています。名前空間はここでは指定されていません。デフォルトでは以下のようになります。
+ `For real-time endpoints: /aws/sagemaker/Endpoint/data-metrics`
+ `For batch transform jobs: /aws/sagemaker/ModelMonitoring/data-metrics`
ただし、ディメンションを指定することはできます。少なくとも次のディメンションを追加することをお勧めします。
+ リアルタイムエンドポイントの `Endpoint` と `MonitoringSchedule`
+ バッチ変換ジョブの `MonitoringSchedule`
次の JSON スニペットは、ディメンションの設定方法を示しています。
リアルタイムエンドポイントについては、`Endpoint` と `MonitoringSchedule` のディメンションを含む次の JSON スニペットを参照してください。
```
{
"MetricName": "", # Required
"Timestamp": "2019-11-26T03:00:00Z", # Required
"Dimensions" : [{"Name":"Endpoint","Value":"endpoint_0"},{"Name":"MonitoringSchedule","Value":"schedule_0"}]
"Value": Float,
# Either the Value or the StatisticValues field can be populated and not both.
"StatisticValues": {
"SampleCount": Float,
"Sum": Float,
"Minimum": Float,
"Maximum": Float
},
"Unit": "Count", # Optional
}
```
バッチ変換ジョブについては、`MonitoringSchedule` のディメンションを含む次の JSON スニペットを参照してください。
```
{
"MetricName": "", # Required
"Timestamp": "2019-11-26T03:00:00Z", # Required
"Dimensions" : [{"Name":"MonitoringSchedule","Value":"schedule_0"}]
"Value": Float,
# Either the Value or the StatisticValues field can be populated and not both.
"StatisticValues": {
"SampleCount": Float,
"Sum": Float,
"Minimum": Float,
"Maximum": Float
},
"Unit": "Count", # Optional
}
```