aws-sdk-forecastservice 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bed7a68d999cd2cbeb16f887c9b5532ae0f308b083335dea775ce703e243f86
-  data.tar.gz: 5ae1a28d44c35774fe4f2bd77a881e462f90946c63bfd92fc82e28db044e6984
+  metadata.gz: e8cc08b8760a59ca46fd2cdf3ef3abee07dac853ef8252f4f66cab70686cdaab
+  data.tar.gz: 395f9d5f1e808cf7db10df226c8b9654e4ce362217b9c3c912384eaf1ed7cbda
 SHA512:
-  metadata.gz: e56eeeaecf4f6911ea12bd58dada8c8a045ef808d07401d5a3b6fbc72925ddc4a8595a0ccc40a6601ae966b3c5cc4c073b771986622de242a8c27fcbc4d21a84
-  data.tar.gz: ca72b5306e4013d930a5f87d3bba017a321f556618ff9345bbde569e6f4a12453763a97a9163f5beaf909a284151f0efb84be645e6aae865ff47a1525ec8c43a
+  metadata.gz: c414c07629c2de2aa2704482e7ede20d0832de36208aa2159e4da731e48d75de891bdc149d8ab1f88613964cfdb885662f67913c1eb404f102ae1db31dc32459
+  data.tar.gz: 7b0d235d3ad4e68a6fc72b66a8892d314b7cf2c0bdb3b66a47c3f8ce778d5f8962c5d61b66e6e20ae67188ba1bc88bce4442b2c38643e0c4dd86d284384102b7

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.25.0 (2021-09-07)
+------------------
+
+* Feature - Predictor creation now supports selecting an accuracy metric to optimize in AutoML and hyperparameter optimization. This release adds additional accuracy metrics for predictors - AverageWeightedQuantileLoss, MAPE and MASE.
+
 1.24.0 (2021-09-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.24.0
+1.25.0

data/lib/aws-sdk-forecastservice/client.rb

@@ -1078,6 +1078,12 @@ module Aws::ForecastService
     #   for your training data. In this case, `PerformHPO` must be false.
     #
     # @option params [String] :auto_ml_override_strategy
+    #   <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
+    #   private beta. Contact AWS Support or your account manager to learn
+    #   more about access privileges.
+    #
+    #    </note>
+    #
     #   Used to overide the default AutoML strategy, which is to optimize
     #   predictor accuracy. To apply an AutoML strategy that minimizes
     #   training time, use `LatencyOptimized`.
@@ -1171,6 +1177,9 @@ module Aws::ForecastService
     #     the limit of 50 tags. Tags with only the key prefix of `aws` do not
     #     count against your tags per resource limit.
     #
+    # @option params [String] :optimization_metric
+    #   The accuracy metric used to optimize the predictor.
+    #
     # @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
@@ -1254,6 +1263,7 @@ module Aws::ForecastService
     #         value: "TagValue", # required
     #       },
     #     ],
+    #     optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
     #   })
     #
     # @example Response structure
@@ -1966,6 +1976,7 @@ module Aws::ForecastService
     #   * {Types::DescribePredictorResponse#message #message} => String
     #   * {Types::DescribePredictorResponse#creation_time #creation_time} => Time
     #   * {Types::DescribePredictorResponse#last_modification_time #last_modification_time} => Time
+    #   * {Types::DescribePredictorResponse#optimization_metric #optimization_metric} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -2033,6 +2044,7 @@ module Aws::ForecastService
     #   resp.message #=> String
     #   resp.creation_time #=> Time
     #   resp.last_modification_time #=> Time
+    #   resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor AWS API Documentation
     #
@@ -2135,6 +2147,7 @@ module Aws::ForecastService
     #
     #   * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array&lt;Types::EvaluationResult&gt;
     #   * {Types::GetAccuracyMetricsResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String
+    #   * {Types::GetAccuracyMetricsResponse#optimization_metric #optimization_metric} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -2159,7 +2172,11 @@ module Aws::ForecastService
     #   resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String
     #   resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float
     #   resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float
+    #   resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mase #=> Float
+    #   resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mape #=> Float
+    #   resp.predictor_evaluation_results[0].test_windows[0].metrics.average_weighted_quantile_loss #=> Float
     #   resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
+    #   resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
     #
@@ -2887,7 +2904,7 @@ module Aws::ForecastService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastservice'
-      context[:gem_version] = '1.24.0'
+      context[:gem_version] = '1.25.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-forecastservice/client_api.rb

@@ -129,6 +129,7 @@ module Aws::ForecastService
     Metrics = Shapes::StructureShape.new(name: 'Metrics')
     Name = Shapes::StringShape.new(name: 'Name')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
+    OptimizationMetric = Shapes::StringShape.new(name: 'OptimizationMetric')
     ParameterKey = Shapes::StringShape.new(name: 'ParameterKey')
     ParameterRanges = Shapes::StructureShape.new(name: 'ParameterRanges')
     ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
@@ -271,6 +272,7 @@ module Aws::ForecastService
     CreatePredictorRequest.add_member(:featurization_config, Shapes::ShapeRef.new(shape: FeaturizationConfig, required: true, location_name: "FeaturizationConfig"))
     CreatePredictorRequest.add_member(:encryption_config, Shapes::ShapeRef.new(shape: EncryptionConfig, location_name: "EncryptionConfig"))
     CreatePredictorRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
+    CreatePredictorRequest.add_member(:optimization_metric, Shapes::ShapeRef.new(shape: OptimizationMetric, location_name: "OptimizationMetric"))
     CreatePredictorRequest.struct_class = Types::CreatePredictorRequest
 
     CreatePredictorResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
@@ -448,6 +450,7 @@ module Aws::ForecastService
     DescribePredictorResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
     DescribePredictorResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
     DescribePredictorResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
+    DescribePredictorResponse.add_member(:optimization_metric, Shapes::ShapeRef.new(shape: OptimizationMetric, location_name: "OptimizationMetric"))
     DescribePredictorResponse.struct_class = Types::DescribePredictorResponse
 
     EncryptionConfig.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "RoleArn"))
@@ -457,6 +460,8 @@ module Aws::ForecastService
     ErrorMetric.add_member(:forecast_type, Shapes::ShapeRef.new(shape: ForecastType, location_name: "ForecastType"))
     ErrorMetric.add_member(:wape, Shapes::ShapeRef.new(shape: Double, location_name: "WAPE"))
     ErrorMetric.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
+    ErrorMetric.add_member(:mase, Shapes::ShapeRef.new(shape: Double, location_name: "MASE"))
+    ErrorMetric.add_member(:mape, Shapes::ShapeRef.new(shape: Double, location_name: "MAPE"))
     ErrorMetric.struct_class = Types::ErrorMetric
 
     ErrorMetrics.member = Shapes::ShapeRef.new(shape: ErrorMetric)
@@ -531,6 +536,7 @@ module Aws::ForecastService
 
     GetAccuracyMetricsResponse.add_member(:predictor_evaluation_results, Shapes::ShapeRef.new(shape: PredictorEvaluationResults, location_name: "PredictorEvaluationResults"))
     GetAccuracyMetricsResponse.add_member(:auto_ml_override_strategy, Shapes::ShapeRef.new(shape: AutoMLOverrideStrategy, location_name: "AutoMLOverrideStrategy"))
+    GetAccuracyMetricsResponse.add_member(:optimization_metric, Shapes::ShapeRef.new(shape: OptimizationMetric, location_name: "OptimizationMetric"))
     GetAccuracyMetricsResponse.struct_class = Types::GetAccuracyMetricsResponse
 
     HyperParameterTuningJobConfig.add_member(:parameter_ranges, Shapes::ShapeRef.new(shape: ParameterRanges, location_name: "ParameterRanges"))
@@ -627,6 +633,7 @@ module Aws::ForecastService
     Metrics.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, deprecated: true, location_name: "RMSE", metadata: {"deprecatedMessage"=>"This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE"}))
     Metrics.add_member(:weighted_quantile_losses, Shapes::ShapeRef.new(shape: WeightedQuantileLosses, location_name: "WeightedQuantileLosses"))
     Metrics.add_member(:error_metrics, Shapes::ShapeRef.new(shape: ErrorMetrics, location_name: "ErrorMetrics"))
+    Metrics.add_member(:average_weighted_quantile_loss, Shapes::ShapeRef.new(shape: Double, location_name: "AverageWeightedQuantileLoss"))
     Metrics.struct_class = Types::Metrics
 
     ParameterRanges.add_member(:categorical_parameter_ranges, Shapes::ShapeRef.new(shape: CategoricalParameterRanges, location_name: "CategoricalParameterRanges"))

data/lib/aws-sdk-forecastservice/types.rb

@@ -853,6 +853,7 @@ module Aws::ForecastService
     #             value: "TagValue", # required
     #           },
     #         ],
+    #         optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
     #       }
     #
     # @!attribute [rw] predictor_name
@@ -915,6 +916,12 @@ module Aws::ForecastService
     #   @return [Boolean]
     #
     # @!attribute [rw] auto_ml_override_strategy
+    #   <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
+    #   private beta. Contact AWS Support or your account manager to learn
+    #   more about access privileges.
+    #
+    #    </note>
+    #
     #   Used to overide the default AutoML strategy, which is to optimize
     #   predictor accuracy. To apply an AutoML strategy that minimizes
     #   training time, use `LatencyOptimized`.
@@ -1018,6 +1025,10 @@ module Aws::ForecastService
     #     of `aws` do not count against your tags per resource limit.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] optimization_metric
+    #   The accuracy metric used to optimize the predictor.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorRequest AWS API Documentation
     #
     class CreatePredictorRequest < Struct.new(
@@ -1034,7 +1045,8 @@ module Aws::ForecastService
       :input_data_config,
       :featurization_config,
       :encryption_config,
-      :tags)
+      :tags,
+      :optimization_metric)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2075,6 +2087,12 @@ module Aws::ForecastService
     #   @return [Boolean]
     #
     # @!attribute [rw] auto_ml_override_strategy
+    #   <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
+    #   private beta. Contact AWS Support or your account manager to learn
+    #   more about access privileges.
+    #
+    #    </note>
+    #
     #   The AutoML strategy used to train the predictor. Unless
     #   `LatencyOptimized` is specified, the AutoML strategy optimizes
     #   predictor accuracy.
@@ -2181,6 +2199,10 @@ module Aws::ForecastService
     #   * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
     #   @return [Time]
     #
+    # @!attribute [rw] optimization_metric
+    #   The accuracy metric used to optimize the predictor.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorResponse AWS API Documentation
     #
     class DescribePredictorResponse < Struct.new(
@@ -2205,7 +2227,8 @@ module Aws::ForecastService
       :status,
       :message,
       :creation_time,
-      :last_modification_time)
+      :last_modification_time,
+      :optimization_metric)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2249,7 +2272,7 @@ module Aws::ForecastService
     # predictor. This object is part of the Metrics object.
     #
     # @!attribute [rw] forecast_type
-    #   The Forecast type used to compute WAPE and RMSE.
+    #   The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
     #   @return [String]
     #
     # @!attribute [rw] wape
@@ -2260,12 +2283,22 @@ module Aws::ForecastService
     #   The root-mean-square error (RMSE).
     #   @return [Float]
     #
+    # @!attribute [rw] mase
+    #   The Mean Absolute Scaled Error (MASE)
+    #   @return [Float]
+    #
+    # @!attribute [rw] mape
+    #   The Mean Absolute Percentage Error (MAPE)
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
     #
     class ErrorMetric < Struct.new(
       :forecast_type,
       :wape,
-      :rmse)
+      :rmse,
+      :mase,
+      :mape)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2760,6 +2793,12 @@ module Aws::ForecastService
     #   @return [Array<Types::EvaluationResult>]
     #
     # @!attribute [rw] auto_ml_override_strategy
+    #   <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
+    #   private beta. Contact AWS Support or your account manager to learn
+    #   more about access privileges.
+    #
+    #    </note>
+    #
     #   The AutoML strategy used to train the predictor. Unless
     #   `LatencyOptimized` is specified, the AutoML strategy optimizes
     #   predictor accuracy.
@@ -2767,11 +2806,16 @@ module Aws::ForecastService
     #   This parameter is only valid for predictors trained using AutoML.
     #   @return [String]
     #
+    # @!attribute [rw] optimization_metric
+    #   The accuracy metric used to optimize the predictor.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetricsResponse AWS API Documentation
     #
     class GetAccuracyMetricsResponse < Struct.new(
       :predictor_evaluation_results,
-      :auto_ml_override_strategy)
+      :auto_ml_override_strategy,
+      :optimization_metric)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3508,16 +3552,23 @@ module Aws::ForecastService
     #   @return [Array<Types::WeightedQuantileLoss>]
     #
     # @!attribute [rw] error_metrics
-    #   Provides detailed error metrics on forecast type, root-mean
-    #   square-error (RMSE), and weighted average percentage error (WAPE).
+    #   Provides detailed error metrics for each forecast type. Metrics
+    #   include root-mean square-error (RMSE), mean absolute percentage
+    #   error (MAPE), mean absolute scaled error (MASE), and weighted
+    #   average percentage error (WAPE).
     #   @return [Array<Types::ErrorMetric>]
     #
+    # @!attribute [rw] average_weighted_quantile_loss
+    #   The average value of all weighted quantile losses.
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Metrics AWS API Documentation
     #
     class Metrics < Struct.new(
       :rmse,
       :weighted_quantile_losses,
-      :error_metrics)
+      :error_metrics,
+      :average_weighted_quantile_loss)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-forecastservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
 # @!group service
 module Aws::ForecastService
 
-  GEM_VERSION = '1.24.0'
+  GEM_VERSION = '1.25.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-forecastservice
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core