Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # CreatePredictor **注記** このオペレーションにより、Amazon Forecast が提供するすべての予測子機能が含まれていないレガシー予測子が作成されます。Forecast のすべての側面と互換性のある予測子を作成するには、[CreateAutoPredictor](API_CreateAutoPredictor.md) を使用します。 Amazon Forecast 予測子を作成します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) リクエストで、データセットグループを指定し、アルゴリズムを指定するか、AutoML を使用して Amazon Forecast にアルゴリズムを選択させます。アルゴリズムを指定すると、アルゴリズム固有のハイパーパラメータを上書きすることもできます。 Amazon Forecast は、アルゴリズムを使用して、指定されたデータセットグループ内のデータセットの最新バージョンを使用して予測子をトレーニングします。その後、[CreateForecast](API_CreateForecast.md) オペレーションを使用して予測を生成できます。 評価メトリクスを表示するには、[GetAccuracyMetrics](API_GetAccuracyMetrics.md) オペレーションを使用します。 モデルトレーニングを改善するために、`TARGET_TIME_SERIES` データセットのデータフィールドに入力して集計する特徴量化の設定を指定できます。詳細については、「[FeaturizationConfig](API_FeaturizationConfig.md)」を参照してください。 RELATED\$1TIME\$1SERIES データセットについては、`CreatePredictor` は、データセットの作成時に `DataFrequency` が指定したものが `ForecastFrequency` に一致することを検証します。TARGET\$1TIME\$1SERIES データセットには、この制限はありません。Amazon Forecast は、区切り文字とタイムスタンプの形式も検証します。詳細については、「[データセットのインポート](howitworks-datasets-groups.md)」を参照してください。 デフォルトでは、予測子は 0.1 (P10)、0.5 (P50)、および 0.9 (P90) 分位数でトレーニングおよび評価されます。`ForecastTypes` を設定することにより、予測子をトレーニングおよび評価するためのカスタム予測タイプを選択できます。 **AutoML** Amazon Forecast で各アルゴリズムを評価し、`objective function` を最小化するアルゴリズムを選択する場合は、`PerformAutoML` を `true` に設定します。`objective function` は、予測タイプに対する重み付けされた損失の平均として定義されます。デフォルトでは、これらは p10、p50、および p90 分位数のロスです。詳細については、「[EvaluationResult](API_EvaluationResult.md)」を参照してください。 AutoML が有効になっている場合、次のプロパティは許可されません。 + `AlgorithmArn` + `HPOConfig` + `PerformHPO` + `TrainingParameters` すべての予測子のリストを取得するには、[ListPredictors](API_ListPredictors.md) オペレーションを使用します。 **注記** 予測子を使用して予測を作成する前に、予測子の `Status` が `ACTIVE` になっている必要があります。これは、トレーニングが完了したことを意味します。[DescribePredictor](API_DescribePredictor.md) オペレーションを使用して、ステータスを取得します。 ## リクエストの構文 ``` { "AlgorithmArn": "string", "AutoMLOverrideStrategy": "string", "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EvaluationParameters": { "BackTestWindowOffset": number, "NumberOfBacktestWindows": number }, "FeaturizationConfig": { "Featurizations": [ { "AttributeName": "string", "FeaturizationPipeline": [ { "FeaturizationMethodName": "string", "FeaturizationMethodParameters": { "string" : "string" } } ] } ], "ForecastDimensions": [ "string" ], "ForecastFrequency": "string" }, "ForecastHorizon": number, "ForecastTypes": [ "string" ], "HPOConfig": { "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ], "IntegerParameterRanges": [ { "MaxValue": number, "MinValue": number, "Name": "string", "ScalingType": "string" } ] } }, "InputDataConfig": { "DatasetGroupArn": "string", "SupplementaryFeatures": [ { "Name": "string", "Value": "string" } ] }, "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TrainingParameters": { "string" : "string" } } ``` ## リクエストパラメーター リクエストは以下のデータを JSON 形式で受け入れます。 ** [AlgorithmArn](#API_CreatePredictor_RequestSyntax) ** モデルトレーニングに使用するアルゴリズムの Amazon リソースネーム (ARN)。`PerformAutoML` が `true` に設定されていない場合は必須です。 **サポートされているアルゴリズム:** + `arn:aws:forecast:::algorithm/ARIMA` + `arn:aws:forecast:::algorithm/CNN-QR` + `arn:aws:forecast:::algorithm/Deep_AR_Plus` + `arn:aws:forecast:::algorithm/ETS` + `arn:aws:forecast:::algorithm/NPTS` + `arn:aws:forecast:::algorithm/Prophet` タイプ: 文字列 長さの制約: 最大長は 256 です。 パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: いいえ ** [AutoMLOverrideStrategy](#API_CreatePredictor_RequestSyntax) ** `LatencyOptimized` AutoML 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。 デフォルトの AutoML 戦略を上書きするために使用されます。これは、予測子の精度を最適化するために行われます。トレーニング時間を最小限に抑える AutoML 戦略を適用するには、`LatencyOptimized` を使用します。 このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。 型: 文字列 有効な値：`LatencyOptimized | AccuracyOptimized` 必須：いいえ ** [EncryptionConfig](#API_CreatePredictor_RequestSyntax) ** Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service (KMS) キーと AWS Identity and Access Management (IAM) ロール。 型: [EncryptionConfig](API_EncryptionConfig.md) オブジェクト 必須: いいえ ** [EvaluationParameters](#API_CreatePredictor_RequestSyntax) ** 指定されたアルゴリズムのデフォルトの評価パラメータを上書きするために使用されます。Amazon Forecast は、データセットをトレーニングデータとテストデータに分割することで予測子を評価します。評価パラメータは、分割の実行方法と反復回数を定義します。 型: [EvaluationParameters](API_EvaluationParameters.md) オブジェクト 必須: いいえ ** [FeaturizationConfig](#API_CreatePredictor_RequestSyntax) ** 特徴量化の設定。 型: [FeaturizationConfig](API_FeaturizationConfig.md) オブジェクト 必須: はい ** [ForecastHorizon](#API_CreatePredictor_RequestSyntax) ** モデルが予測するようにトレーニングされている時間ステップの数を指定します。予測期間は予測長とも呼ばれます。 例えば、([CreateDataset](API_CreateDataset.md) オペレーションの `DataFrequency` パラメータを使用して) 毎日のデータ収集用にデータセットを設定し、予測期間を 10 に設定すると、モデルは 10 日間の予測を返します。 最大予測期間は、500 タイムステップまたは TARGET\$1TIME\$1SERIES のデータセットの長さの 1/3 のいずれか小さい方です。 タイプ: 整数 必須: はい ** [ForecastTypes](#API_CreatePredictor_RequestSyntax) ** 予測子のトレーニングに使用される予測タイプを指定します。最大 5 つの予測タイプを指定できます。予測タイプは、0.01 以上の増分で 0.01 から 0.99 までの分位数にすることができます。`mean` で平均予測を指定することもできます。 デフォルト値は `["0.10", "0.50", "0.9"]` です。 型: 文字列の配列 配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。 長さの制限: 最小長は 2 です。最大長は 4 です。 パターン: `(^0?\.\d\d?$|^mean$)` 必須: いいえ ** [HPOConfig](#API_CreatePredictor_RequestSyntax) ** アルゴリズム用にハイパーパラメータの上書き値を提供します。このパラメータを指定しない場合、Amazon Forecast はデフォルト値を使用します。個々のアルゴリズムは、ハイパーパラメータ最適化 (HPO) をサポートするハイパーパラメータを指定します。詳細については、「[Amazon Forecast アルゴリズム](aws-forecast-choosing-recipes.md)」を参照してください。 `HPOConfig` オブジェクトを含めた場合は、`PerformHPO` を true に設定する必要があります。 型: [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクト 必須: いいえ ** [InputDataConfig](#API_CreatePredictor_RequestSyntax) ** 予測子のトレーニングに使用するデータを含むデータセットグループを記述します。 型: [InputDataConfig](API_InputDataConfig.md) オブジェクト 必須: はい ** [OptimizationMetric](#API_CreatePredictor_RequestSyntax) ** 予測子を最適化するために使用される精度メトリクス。デフォルト値は `AverageWeightedQuantileLoss` です。 型: 文字列 有効な値：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` 必須：いいえ ** [PerformAutoML](#API_CreatePredictor_RequestSyntax) ** AutoML を実行するかどうか。Amazon Forecast が AutoML を実行すると、提供するアルゴリズムが評価され、トレーニングデータセットに最適なアルゴリズムと設定が選択されます。 デフォルト値は `false` です。この場合、アルゴリズムを指定する必要があります。 Amazon Forecast が AutoML を実行するように `PerformAutoML` を `true` に設定します。これは、トレーニングデータに適したアルゴリズムがわからない場合に適したオプションです。この場合、`PerformHPO` は false である必要があります。 タイプ: ブール値 必須: いいえ ** [PerformHPO](#API_CreatePredictor_RequestSyntax) ** ハイパーパラメータの最適化 (HPO) を実行するかどうか。HPO は、トレーニングデータに最適なハイパーパラメータ値を見つけます。HPO を実行するプロセスは、ハイパーパラメータのチューニングジョブの実行として知られています。 デフォルト値は `false` です。この場合、Amazon Forecast は、選択したアルゴリズムのデフォルトのハイパーパラメータ値を使用します。 デフォルト値を上書きするには、`PerformHPO` を `true` に設定し、オプションで [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) オブジェクトを指定します。チューニングジョブは、最適化するメトリクス、チューニングに関係するハイパーパラメータ、およびチューニング可能な各ハイパーパラメータの有効範囲を指定します。この場合、アルゴリズムを指定する必要があり、`PerformAutoML` は false である必要があります。 次のアルゴリズムは HPO をサポートします。 + DeepAR\$1 + CNN-QR タイプ: ブール値 必須: いいえ ** [PredictorName](#API_CreatePredictor_RequestSyntax) ** 予測子の名前。 タイプ: 文字列 長さの制約: 最小長は 1 です。最大長は 63 です。 パターン: `^[a-zA-Z][a-zA-Z0-9_]*` 必須: はい ** [Tags](#API_CreatePredictor_RequestSyntax) ** サービスに適用し、予測子の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。 タグには以下のベーシックな制限があります。 + リソースあたりのタグの最大数は 50 です。 + タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。 + キーの最大長 - 128 文字 (Unicode) (UTF-8)。 + 値の最大長 - 256 文字 (Unicode) (UTF-8)。 + 複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: \$1、-、=、.、\$1、:、/、@。 + タグのキーと値では、大文字と小文字が区別されます。 + `aws:`、`AWS:`、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値には `aws` がプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。`aws` のキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。 型: [Tag](API_Tag.md) オブジェクトの配列 配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。 必須: いいえ ** [TrainingParameters](#API_CreatePredictor_RequestSyntax) ** モデルトレーニングのために上書きするハイパーパラメータ。上書きできるハイパーパラメータは、個々のアルゴリズムにリストされています。サポートされているアルゴリズムのリストについては、「[Amazon Forecast アルゴリズム](aws-forecast-choosing-recipes.md)」を参照してください。 タイプ: 文字列間のマッピング マップエントリ: 最小数は 0 項目です。最大数は 100 項目です。 キーの長さの制限: 最大長は 256 です。 キーパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$` 値の長さの制限: 最大長は 256 です。 値のパターン: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$` 必須: いいえ ## レスポンスの構文 ``` { "PredictorArn": "string" } ``` ## レスポンス要素 アクションが成功すると、サービスは HTTP 200 レスポンスを返します。 サービスから以下のデータが JSON 形式で返されます。 ** [PredictorArn](#API_CreatePredictor_ResponseSyntax) ** 予測子の Amazon リソースネーム (ARN)。 タイプ: 文字列 長さの制約: 最大長は 256 です。 パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** LimitExceededException ** アカウントあたりのリソース数の制限を超えました。 HTTP ステータスコード: 400 ** ResourceAlreadyExistsException ** この名前のリソースは既に存在します。別の名前で再試行してください。 HTTP ステータスコード: 400 ** ResourceInUseException ** 指定されたリソースは使用中です。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/CreatePredictor) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CreatePredictor) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/CreatePredictor) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/CreatePredictor) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CreatePredictor)