DescribePredictor - Amazon Forecast

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

DescribePredictor

注意

此操作仅对使用创建的传统预测变量有效 CreatePredictor. 如果您没有使用传统预测变量,请使用DescribeAutoPredictor.

描述使用创建的预测变量CreatePredictor操作。

除了列出中提供的属性外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 覆盖策略仅在私人测试版中可用。请联系 AWS Support 或您的客户经理,了解有关访问权限的更多信息。

用于训练预测变量的 AutoML 策略。除非LatencyOptimized指定后,AutoML 策略可优化预测变量的精度。

此参数仅对使用 AutoML 训练的预测变量有效。

类型: 字符串

有效值: LatencyOptimized | AccuracyOptimized

CreationTime

创建模型训练任务时。

类型: 时间戳

DatasetImportJobArns

用于为预测变量导入训练数据的数据集导入任务的 ARN 数组。

类型: 字符串数组

长度约束:长度上限为 256。

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

EncryptionConfig

Amazon Foresource (IM) 角色。AAmazon Forecast Foresource Management (IM) 角色。

类型: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

超参数会覆盖算法的值。

类型:HyperParameterTuningJobConfig 对象

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操作。

类型: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

注意

这些区域有:Status的预测变量必须是ACTIVE然后才能使用预测变量创建预测。

类型: 字符串

长度约束:长度上限为 256。

TrainingParameters

模型训练期间选择的默认训练参数或覆盖。运行 AutoML 或使用 CNN-QR 或 Deepar+ 选择 HPO 时,将返回所选超参数的优化值。有关更多信息,请参阅 Amazon Forecast 算法

类型: 字符串到字符串映射

地图条目:最少 0 项。最多 100 项。

关键长度约束:长度上限为 256。

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

值长度约束:长度上限为 256。

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

错误

InvalidInputException

我们无法处理该请求,因为它包含无效值或超出有效范围的值。

HTTP 状态代码:400

ResourceNotFoundException

我们找不到具有该Amazon 资源名称 (ARN) 的资源。检查 ARN,然后重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: