Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # DescribePredictor **注意** 此操作仅对使用 CreatePredictor创建的传统预测变量有效。如果您没有使用传统预测器，请使用 [DescribeAutoPredictor](API_DescribeAutoPredictor.md)。描述使用 [CreatePredictor](API_CreatePredictor.md) 操作创建的预测器。 **重要** Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。[了解更多](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 除了列出 `CreatePredictor` 请求中提供的属性外，该操作还列出了以下属性： + `DatasetImportJobArns` - 用于导入训练数据的数据集导入作业。 + `AutoMLAlgorithmArns` - 如果执行了 AutoML，则为已评估的算法。 + `CreationTime` + `LastModificationTime` + `Status` + `Message` - 如果出现错误，则为错误相关的信息。 ## 请求语法 ``` { "PredictorArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [PredictorArn](#API_DescribePredictor_RequestSyntax) ** 您要获取相关信息的预测器的 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](#API_DescribePredictor_ResponseSyntax) ** 用于模型训练的算法的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLAlgorithmArns](#API_DescribePredictor_ResponseSyntax) ** 如果指定 `PerformAutoML`，则为所选算法的 ARN。类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [AutoMLOverrideStrategy](#API_DescribePredictor_ResponseSyntax) ** `LatencyOptimized` AutoML 覆盖策略仅在私有测试版中可用。请联系 Su AWS pport 或您的客户经理，详细了解访问权限。用于训练预测器的 AutoML 策略。除非指定 `LatencyOptimized`，否则 AutoML 策略会优化预测器的准确性。此参数仅对使用 AutoML 训练的预测器有效。类型：字符串有效值：`LatencyOptimized | AccuracyOptimized` ** [CreationTime](#API_DescribePredictor_ResponseSyntax) ** 创建模型训练任务的时间。类型：时间戳 ** [DatasetImportJobArns](#API_DescribePredictor_ResponseSyntax) ** 用于为预测器导入训练数据的数据集导入任务的数组。 ARNs 类型：字符串数组长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):forecast:.*:.*:.+` ** [EncryptionConfig](#API_DescribePredictor_ResponseSyntax) ** AWS Key Management Service (KMS) 密钥和 Amazon Forecast 可以代入的访问密钥的 AWS Identity and Access Management (IAM) 角色。类型：[EncryptionConfig](API_EncryptionConfig.md) 对象 ** [EstimatedTimeRemainingInMinutes](#API_DescribePredictor_ResponseSyntax) ** 完成预测器训练作业的估计剩余时间（分钟）。类型：长整型 ** [EvaluationParameters](#API_DescribePredictor_ResponseSyntax) ** 用于覆盖指定算法的默认评估参数。Amazon Forecast 通过将数据集拆分为训练数据和测试数据来评估预测器。评估参数定义了如何执行拆分和迭代次数。类型：[EvaluationParameters](API_EvaluationParameters.md) 对象 ** [FeaturizationConfig](#API_DescribePredictor_ResponseSyntax) ** 特征化配置。类型：[FeaturizationConfig](API_FeaturizationConfig.md) 对象 ** [ForecastHorizon](#API_DescribePredictor_ResponseSyntax) ** 预测的时间步数。预测范围也称为预测长度。类型：整数 ** [ForecastTypes](#API_DescribePredictor_ResponseSyntax) ** 预测器训练期间使用的预测类型。默认值为 `["0.1","0.5","0.9"]` 类型：字符串数组数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 2。最大长度为 4。模式：`(^0?\.\d\d?$|^mean$)` ** [HPOConfig](#API_DescribePredictor_ResponseSyntax) ** 超参数覆盖算法的值。类型：[HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 对象 ** [InputDataConfig](#API_DescribePredictor_ResponseSyntax) ** 描述包含要用于训练预测器的数据的数据集组。类型：[InputDataConfig](API_InputDataConfig.md) 对象 ** [IsAutoPredictor](#API_DescribePredictor_ResponseSyntax) ** 预测器是否通过 [CreateAutoPredictor](API_CreateAutoPredictor.md) 创建。类型：布尔值 ** [LastModificationTime](#API_DescribePredictor_ResponseSyntax) ** 上次修改资源的时间。时间戳取决于作业的状态： + `CREATE_PENDING` - `CreationTime`。 + `CREATE_IN_PROGRESS` - 当前时间戳。 + `CREATE_STOPPING` - 当前时间戳。 + `CREATE_STOPPED` - 当作业停止时。 + `ACTIVE` 或者 `CREATE_FAILED` - 当作业完成或失败时。类型：时间戳 ** [Message](#API_DescribePredictor_ResponseSyntax) ** 如果出现错误，则为错误的信息消息。类型：字符串 ** [OptimizationMetric](#API_DescribePredictor_ResponseSyntax) ** 用于优化预测器的准确性指标。类型：字符串有效值：`WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE` ** [PerformAutoML](#API_DescribePredictor_ResponseSyntax) ** 预测器是否设置为执行 AutoML。类型：布尔值 ** [PerformHPO](#API_DescribePredictor_ResponseSyntax) ** 预测器是否设置为执行超参数优化（HPO）。类型：布尔值 ** [PredictorArn](#API_DescribePredictor_ResponseSyntax) ** 预测器的 ARN。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [PredictorExecutionDetails](#API_DescribePredictor_ResponseSyntax) ** 为评估预测器准确性而进行的回测的状态和结果详情。在调用 [CreatePredictor](API_CreatePredictor.md) 操作时，可以指定要执行的回测次数。类型：[PredictorExecutionDetails](API_PredictorExecutionDetails.md) 对象 ** [PredictorName](#API_DescribePredictor_ResponseSyntax) ** 预测器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z][a-zA-Z0-9_]*` ** [Status](#API_DescribePredictor_ResponseSyntax) ** 预测器的状态。状态包括： + `ACTIVE` + `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` + `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` + `CREATE_STOPPING`, `CREATE_STOPPED` 在使用预测器创建预测之前，预测器的 `Status` 必须为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。 ** [TrainingParameters](#API_DescribePredictor_ResponseSyntax) ** 模型训练期间选择的默认训练参数或覆盖。运行 AutoML 或选择带 CNN-QR 或 DeepAR\$1 的 HPO 时，将返回所选超参数的优化值。有关更多信息，请参阅 [Amazon Forecast 算法](aws-forecast-choosing-recipes.md)。类型：字符串到字符串映射映射条目：最低 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，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribePredictor) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribePredictor) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribePredictor) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribePredictor) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribePredictor)