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 Resource Name (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 Resource Name (ARN)。
類型:字串
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- AutoMLAlgorithmArns
-
指定
PerformAutoML
時,所選演算法的 ARN。類型:字串陣列
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- AutoMLOverrideStrategy
-
注意
LatencyOptimized
AutoML 覆寫策略僅適用於私有 Beta 版。請聯絡 AWS Support 或您的 帳戶管理員,以進一步了解 存取權限。用於訓練預測器的 AutoML 策略。除非
LatencyOptimized
指定,否則 AutoML 策略會最佳化預測器準確度。此參數僅適用於使用 AutoML 訓練的預測器。
類型:字串
有效值:
LatencyOptimized | AccuracyOptimized
- CreationTime
-
建立模型訓練任務時。
類型:Timestamp
- DatasetImportJobArns
-
資料集匯入任務的 ARNs 陣列,用於匯入預測器的訓練資料。
類型:字串陣列
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- EncryptionConfig
-
Amazon Forecast 可以擔任的 AWS Key Management Service (KMS) 金鑰和 AWS Identity and Access Management (IAM) 角色來存取金鑰。
類型: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
-
演算法的超參數覆寫值。
- InputDataConfig
-
描述資料集群組,其中包含用於訓練預測器的資料。
類型:InputDataConfig 物件
- IsAutoPredictor
-
預測器是否使用 建立CreateAutoPredictor。
類型:布林值
- LastModificationTime
-
上次修改資源的時間。時間戳記取決於任務的狀態:
-
CREATE_PENDING
-CreationTime
。 -
CREATE_IN_PROGRESS
- 目前的時間戳記。 -
CREATE_STOPPING
- 目前的時間戳記。 -
CREATE_STOPPED
- 任務停止時。 -
ACTIVE
或CREATE_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操作時要執行的回溯測試數目。
- 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
注意
預測器
Status
的 必須在您可以使用預測器建立預測ACTIVE
之前。類型:字串
長度限制:長度上限為 256。
-
- TrainingParameters
-
在模型訓練期間選取的預設訓練參數或覆寫。執行 AutoML 或選擇 HPO 搭配 CNN-QR 或 DeepAR+ 時,會傳回所選超參數的最佳化值。如需詳細資訊,請參閱Amazon Forecast 演算法。
類型:字串到字串映射
映射項目:0 個項目的最小數量。項目數上限為 100。
金鑰長度限制:長度上限為 256。
金鑰模式:
^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$
值長度限制:長度上限為 256。
值模式:
^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$
錯誤
- InvalidInputException
-
我們無法處理請求,因為它包含無效值或超過有效範圍的值。
HTTP 狀態碼:400
- ResourceNotFoundException
-
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN,然後再試一次。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: