You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ForecastService::Types::FeaturizationConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Note:

When making an API call, you may pass FeaturizationConfig data as a hash:

{
  forecast_frequency: "Frequency", # required
  forecast_dimensions: ["Name"],
  featurizations: [
    {
      attribute_name: "Name", # required
      featurization_pipeline: [
        {
          featurization_method_name: "filling", # required, accepts filling
          featurization_method_parameters: {
            "ParameterKey" => "ParameterValue",
          },
        },
      ],
    },
  ],
}

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES dataset before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.

Instance Attribute Summary collapse

Instance Attribute Details

#featurizationsArray<Types::Featurization>

An array of featurization (transformation) information for the fields of a dataset. In this release, only a single featurization is supported.

Returns:



1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1717

class FeaturizationConfig < Struct.new(
  :forecast_frequency,
  :forecast_dimensions,
  :featurizations)
  include Aws::Structure
end

#forecast_dimensionsArray<String>

An array of dimension (field) names that specify how to group the generated forecast.

For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

Returns:

  • (Array<String>)


1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1717

class FeaturizationConfig < Struct.new(
  :forecast_frequency,
  :forecast_dimensions,
  :featurizations)
  include Aws::Structure
end

#forecast_frequencyString

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

Returns:

  • (String)


1717
1718
1719
1720
1721
1722
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1717

class FeaturizationConfig < Struct.new(
  :forecast_frequency,
  :forecast_dimensions,
  :featurizations)
  include Aws::Structure
end