CreateAutoPredictor - Amazon Forecast

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

CreateAutoPredictor

创建 Amazon Forecast 预测器。

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

创建新预测器

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

  • PredictorName - 预测器的唯一名称。

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

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

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

创建新预测器时,不要为 ReferencePredictorArn 指定值。

升级和重新训练预测器

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

  • PredictorName - 预测器的唯一名称。

  • ReferencePredictorArn - 重新训练或升级预测器的 ARN。

升级或重新训练预测器时,只能为 ReferencePredictorArnPredictorName 指定值。

请求语法

{ "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

用于训练预测器的预测类型。您最多可指定五种预测类型。预测类型可以是从 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。此参数仅在重新训练或升级预测器时使用。创建新预测器时,不要为此参数指定值。

升级或重新训练预测器时,只能为 ReferencePredictorArnPredictorName 指定值。PredictorName 值必须是唯一的预测器名称。

类型:字符串

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

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

必需:否

Tags

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

以下限制适用于标签:

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

  • 每个资源的标签数上限:50。

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

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

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

  • 键前缀不能包含 aws:AWS: 的任何大写或小写组合。值可以带有该前缀。如果标签值将 aws 作为其前缀,但键没有前缀,则 Forecast 会将其视为用户标签,并将计入 50 个标签的限制。仅具有 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 SDK 中使用此 API 的更多信息,请参阅以下内容: