DescribePredictor - Amazon Forecast

Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用該服務。了解更多」

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribePredictor

注意

此作業僅對使用 CreatePredictor建立的舊版預測值有效。如果您未使用舊式預測值,請使用DescribeAutoPredictor.

描述使用CreatePredictor作業建立的預測值。

重要

Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用該服務。了解更多」

除了列出CreatePredictor要求中提供的屬性之外,此作業還會列出下列屬性:

  • DatasetImportJobArns-用於匯入訓練資料的資料集匯入工作。

  • AutoMLAlgorithmArns-如果執行 AutoML,則表示已評估的演算法。

  • CreationTime

  • LastModificationTime

  • Status

  • Message-如果發生錯誤,請提供有關錯誤的資訊。

請求語法

{ "PredictorArn": "string" }

請求參數

請求接受以下JSON格式的數據。

PredictorArn

您想要資訊的預測值的 Amazon 資源名稱 (ARN)。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

必要:是

回應語法

{ "AlgorithmArn": "string", "AutoMLAlgorithmArns": [ "string" ], "AutoMLOverrideStrategy": "string", "CreationTime": number, "DatasetImportJobArns": [ "string" ], "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "EstimatedTimeRemainingInMinutes": number, "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" } ] }, "IsAutoPredictor": boolean, "LastModificationTime": number, "Message": "string", "OptimizationMetric": "string", "PerformAutoML": boolean, "PerformHPO": boolean, "PredictorArn": "string", "PredictorExecutionDetails": { "PredictorExecutions": [ { "AlgorithmArn": "string", "TestWindows": [ { "Message": "string", "Status": "string", "TestWindowEnd": number, "TestWindowStart": number } ] } ] }, "PredictorName": "string", "Status": "string", "TrainingParameters": { "string" : "string" } }

回應元素

如果動作成功,服務會傳回 HTTP 200 回應。

服務會以JSON格式傳回下列資料。

AlgorithmArn

用於模型訓練的演算法的 Amazon 資源名稱 (ARN)。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLAlgorithmArns

PerformAutoML定時,所選演算法ARN的。

類型:字串陣列

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

AutoMLOverrideStrategy
注意

LatencyOptimizedAutoML 覆寫策略僅適用於私有測試版。若要進一步瞭解存取權限,請聯絡 Sup AWS port 或您的客戶經理。

用來訓練預測值的 AutoML 策略。除LatencyOptimized非指定,否則 AutoML 策略會最佳化預測值準確度。

此參數僅適用於使用 AutoML 訓練的預測值。

類型:字串

有效值:LatencyOptimized | AccuracyOptimized

CreationTime

建立模型訓練任務的時間。

類型:Timestamp

DatasetImportJobArns

資料集匯入工作ARNs的陣列,用來匯入預測值的訓練資料。

類型:字串陣列

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

EncryptionConfig

Amazon Forecast 可以承擔訪問密鑰的 AWS Identity and Access Management (IAM)鍵和()角色。 AWS Key Management Service KMS

類型:EncryptionConfig 物件

EstimatedTimeRemainingInMinutes

預測值訓練工作完成的預估剩餘時間 (以分鐘為單位)。

類型:Long

EvaluationParameters

用於覆寫指定演算法的預設評估參數。Amazon Forecast 會將資料集分割為訓練資料並測試資料來評估預測值。評估參數定義如何執行拆分和迭代次數。

類型:EvaluationParameters 物件

FeaturizationConfig

特徵化組態。

類型:FeaturizationConfig 物件

ForecastHorizon

預測的時間步長數。預測期間也稱為預測長度。

類型:整數

ForecastTypes

預測值訓練期間使用的預測類型。預設值為 ["0.1","0.5","0.9"]

類型:字串陣列

陣列成員:項目數下限為 1。項目數上限為 20。

長度約束:最小長度為 2。長度上限為 4。

模式:(^0?\.\d\d?$|^mean$)

HPOConfig

超參數會覆寫演算法的值。

類型:HyperParameterTuningJobConfig 物件

InputDataConfig

描述包含用來訓練預測值之資料的資料集群組。

類型:InputDataConfig 物件

IsAutoPredictor

預測值是否建立使用CreateAutoPredictor.

類型:布林值

LastModificationTime

上次修改資源的時間。時間戳記取決於工作的狀態:

  • CREATE_PENDING-該CreationTime.

  • CREATE_IN_PROGRESS-目前的時間戳記。

  • CREATE_STOPPING-目前的時間戳記。

  • CREATE_STOPPED-工作停止的時候

  • ACTIVECREATE_FAILED-工作完成或失敗時。

類型:Timestamp

Message

如果發生錯誤,則會顯示有關錯誤的資訊訊息。

類型:字串

OptimizationMetric

用於最佳化預測值的準確度量。

類型:字串

有效值:WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PerformAutoML

無論是預測值被設置為執行 AutoML。

類型:布林值

PerformHPO

預測值是否設定為執行超參數最佳化 () HPO。

類型:布林值

PredictorArn

預ARN測值的。

類型:字串

長度限制:長度下限為 1。長度上限為 63。

模式:^[a-zA-Z][a-zA-Z0-9_]*

PredictorExecutionDetails

有關為評估預測值準確性而執行的回溯測試的狀態和結果的詳細信息。您可以指定呼叫CreatePredictor作業時要執行的回溯測試次數。

類型:PredictorExecutionDetails 物件

PredictorName

預測值的名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 63。

模式:^[a-zA-Z][a-zA-Z0-9_]*

Status

預測值的狀態。各州包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

注意

預測值必須ACTIVE在您可以使用預測值建立預測之前。Status

類型:字串

長度限制:長度上限為 256。

TrainingParameters

在模型訓練期間選取的預設訓練參數或取代。當執行 AutoML 或HPO使用 CNN-QR 或 DeepAR + 選擇時,會傳回所選超參數的最佳化值。如需詳細資訊,請參閱Amazon Forecast Forecast

類型:字串到字串映射

地圖項目:0 個項目的最小數目。項目數上限為 100。

鍵長度限制:最大長度為 256。

金鑰模式:^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$

值長度限制:最大長度 256。

值模式:^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$

錯誤

InvalidInputException

我們無法處理要求,因為它包含無效值或超出有效範圍的值。

HTTP狀態碼:

ResourceNotFoundException

我們找不到具有該 Amazon 資源名稱(ARN)的資源。檢查ARN並再試一次。

HTTP狀態碼:

另請參閱

如需有關API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: