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
-
注意
LatencyOptimized
AutoML 覆盖策略仅在私有测试版中可用。请联系 Su AWS pport 或您的客户经理,详细了解访问权限。用于训练预测器的 AutoML 策略。除非指定
LatencyOptimized
,否则 AutoML 策略会优化预测器的准确性。此参数仅对使用 AutoML 训练的预测器有效。
类型:字符串
有效值:
LatencyOptimized | AccuracyOptimized
- CreationTime
-
创建模型训练任务的时间。
类型:时间戳
- DatasetImportJobArns
-
用于为预测器导入训练数据的数据集导入任务的数组。ARNs
类型:字符串数组
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- EncryptionConfig
-
一个 AWS Key Management Service (KMS) 密钥和 AWS Identity and Access Management (IAM) 角色,Amazon Forecast 可以代入该密钥访问该密钥。
类型:EncryptionConfig 对象
- EstimatedTimeRemainingInMinutes
-
完成预测器训练作业的估计剩余时间(分钟)。
类型:长整型
- 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
- 当作业完成或失败时。
类型:时间戳
-
- 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 资源名称的资源 (ARN)。请检查ARN并重试。
HTTP状态码:400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: