CreateAutoPredictor - Amazon Forecast

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateAutoPredictor

创建 Amazon Forecast 预测变量

Amazon Forecast 使用AutoPredictor来创建预测变量,这涉及将最佳算法组合应用于数据集中的每个时间序列。您可以使用CreateAutoPredictor创建新的预测变量或升级/重新训练现有的预测变量。

创建新的预测变量

创建新预测变量时需要以下参数:

  • PredictorName-预测的唯一名称。

  • DatasetGroupArn-用于训练预测变量的数据集组的 ARN。

  • ForecastFrequency-预测的精度(每小时、每天、每周等)。

  • ForecastHorizon-模型预测的时间步长。预测范围也称为预测长度。

创建新的预测变量时,不要为指定值。ReferencePredictorArn

升级和重新训练预测变量

重新训练或升级预测变量时需要以下参数:

  • PredictorName-预测的唯一名称。

  • ReferencePredictorArn-要重新训练或升级的预测变量的 ARN。

升级或重新训练预测变量时,仅为和指定ReferencePredictorArn值。PredictorName

请求语法

{ "DataConfig": { "AdditionalDatasets": [ { "Configuration": { "string" : [ "string" ] }, "Name": "string" } ], "AttributeConfigs": [ { "AttributeName": "string", "Transformations": { "string" : "string" } } ], "DatasetGroupArn": "string" }, "EncryptionConfig": { "KMSKeyArn": "string", "RoleArn": "string" }, "ExplainPredictor": boolean, "ForecastDimensions": [ "string" ], "ForecastFrequency": "string", "ForecastHorizon": number, "ForecastTypes": [ "string" ], "MonitorConfig": { "MonitorName": "string" }, "OptimizationMetric": "string", "PredictorName": "string", "ReferencePredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeAlignmentBoundary": { "DayOfMonth": number, "DayOfWeek": "string", "Hour": number, "Month": "string" } }

请求参数

请求接受采用 JSON 格式的以下数据。

DataConfig

您的数据集组和任何其他数据集的数据配置。

类型:DataConfig 对象

必需:否

EncryptionConfig

AWS Key Management Service(KMS)密钥和 Amazon Forecast 可以代入以访问密钥的 AWS Identity and Access Management IAM 角色。您可以在CreateDatasetCreatePredictor请求中指定此可选对象。

类型:EncryptionConfig 对象

必需:否

ExplainPredictor

为预测变量创建可解释性资源。

类型:布尔值

必需:否

ForecastDimensions

维度(字段)名称数组,用于指定如何对生成的预测进行分组。

例如,如果您要生成所有商店的商品销售预测,并且您的数据集包含一个store_id字段,则应将每家商店的销售预测指定store_id为分组的维度。

类型:字符串数组

数组成员:最少 1 项。最多 10 项。

长度限制:最小长度为 1。最大长度为 63。

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

必需:否

ForecastFrequency

预测中预测的频率。

有效间隔为一个整数,后跟 Y(年)、M(月)、W(周)、D(日)、H(小时)和 min(分钟)。例如,“1D”表示每天,“15min”表示每 15 分钟。不能指定与下一个较大频率重叠的值。例如,这意味着您不能将频率指定为 60 分钟,因为这相当于 1 小时。每个频率的有效值如下所示:

  • 分钟 - 1-59

  • 小时 - 1-23

  • 天 - 1-6

  • 周 - 1-4

  • 月 - 1-11

  • 年 - 1

因此,如果您想要每隔一周进行一次预测,请指定“2W”。或者,如果您想要每季度预测一次,请指定“3M”。

该频率必须大于或等于 TARGET_TIME_SERIES 数据集频率。

提供 RELATED_TIME_SERIES 数据集时,频率必须等于 RELATED_TIME_SERIES 数据集频率。

类型:字符串

长度限制:最小长度为 1。最大长度为 5。

模式:^Y|M|W|D|H|30min|15min|10min|5min|1min$

必需:否

ForecastHorizon

模型预测的时间步长。预测范围也称为预测长度。

最大预测范围为 500 个时间步长或 TARGET_TIME_SERIES 数据集长度的 1/4 中的较小值。如果您正在重新训练现有AutoPredictor的,则最大预测范围为 500 个时间步长或 TARGET_TIME_SERIES 数据集长度的 1/3 中的较小值。

如果您要升级到现有预测展望期AutoPredictor或重新训练现有预测展望期参数AutoPredictor,则无法更新预测展望期参数。您可以通过在数据集中提供更长的时间序列来满足此要求。

类型:整数

必需:否

ForecastTypes

用于训练预测变量的预测类型。您最多可指定五个预测类型。Forecast 类型可以是从 0.01 到 0.99 的分位数,增量为 0.01 或更高。您也可以使用来指定平均预测mean

类型:字符串数组

数组成员:最少 1 项。最多 20 项。

长度限制:最小长度为 2。长度上限为 4。

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

必需:否

MonitorConfig

预测器监控的配置详细信息。提供监视器资源的名称以启用预测器监控。

预测器监视允许您了解您的预测器性能如何随着的时间的推移而变化。有关更多信息,请参阅预测监控

类型:MonitorConfig 对象

必需:否

OptimizationMetric

用于优化预测变量的精度指标。

类型:字符串

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

必需:否

PredictorName

预测的唯一名称

类型:字符串

长度限制:最小长度为 1。最大长度为 63。

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

必需:是

ReferencePredictorArn

要重新训练或升级的预测变量的 ARN。此参数仅在重新训练或升级预测变量时使用。创建新的预测变量时,不要为此参数指定值。

升级或重新训练预测变量时,仅为和指定ReferencePredictorArn值。PredictorName的值PredictorName必须是唯一的预测变量名称。

类型:字符串

长度限制:最大长度为 256。

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

必需:否

Tags

可选元数据可帮助您对预测变量进行分类和组织。每个标签都包含您定义的一个键和一个可选值。标签键和值区分大小写。

以下限制适用于标签:

  • 对于每个资源,每个标签键都必须是唯一的,每个标签键都必须有一个值。

  • 每个资源的最大标签数:50。

  • 最大键长度:128 个 Unicode 字符(采用 UTF-8 格式)

  • 最大值长度:256 个 Unicode 字符(采用 UTF-8 格式)

  • 可接受的字符:所有字母和数字、可用 UTF-8 表示的空格以及 +-=。_:/@。 如果您的标记方案针对其它服务和资源使用,则这些服务的字符限制也适用。

  • 密钥前缀不能包含或的任何大写或小写组合。aws: AWS:值可以有这个前缀。如果标签值以其前缀aws为前缀但密钥没有,则 Foracest 会将其视为用户标签,并将计入 50 个标签的限制中。仅具有key prefix 的标签aws不计入每个资源的标签数限制。您无法编辑或删除带此前缀的标签键。

类型:Tag 对象数组

数组成员:最少 0 项。最多 200。

必需:否

TimeAlignmentBoundary

Forecast 的时间边界用于对齐和聚合任何与您的预测频率不一致的数据。以键值对的形式提供时间单位和时间边界。有关指定时间边界的更多信息,请参阅指定时间边界。如果您不提供时间边界,Forecast 将使用一组默认时间边界

类型:TimeAlignmentBoundary 对象

必需:否

响应语法

{ "PredictorArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

PredictorArn

预测变量的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 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: