Class: Aws::Personalize::Types::CreateSolutionRequest

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

Overview

Note:

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

{
  name: "Name", # required
  perform_hpo: false,
  perform_auto_ml: false,
  recipe_arn: "Arn",
  dataset_group_arn: "Arn", # required
  event_type: "EventType",
  solution_config: {
    event_value_threshold: "EventValueThreshold",
    hpo_config: {
      hpo_objective: {
        type: "HPOObjectiveType",
        metric_name: "MetricName",
        metric_regex: "MetricRegex",
      },
      hpo_resource_config: {
        max_number_of_training_jobs: "HPOResource",
        max_parallel_training_jobs: "HPOResource",
      },
      algorithm_hyper_parameter_ranges: {
        integer_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            min_value: 1,
            max_value: 1,
          },
        ],
        continuous_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            min_value: 1.0,
            max_value: 1.0,
          },
        ],
        categorical_hyper_parameter_ranges: [
          {
            name: "ParameterName",
            values: ["CategoricalValue"],
          },
        ],
      },
    },
    algorithm_hyper_parameters: {
      "ParameterName" => "ParameterValue",
    },
    feature_transformation_parameters: {
      "ParameterName" => "ParameterValue",
    },
    auto_ml_config: {
      metric_name: "MetricName",
      recipe_list: ["Arn"],
    },
    optimization_objective: {
      item_attribute: "ItemAttribute",
      objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_group_arnString

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

Returns:

  • (String)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#event_typeString

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

Returns:

  • (String)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name for the solution.

Returns:

  • (String)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#perform_auto_mlBoolean

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

Returns:

  • (Boolean)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#perform_hpoBoolean

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

Returns:

  • (Boolean)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_arnString

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

Returns:

  • (String)


1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end

#solution_configTypes::SolutionConfig

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1258

class CreateSolutionRequest < Struct.new(
  :name,
  :perform_hpo,
  :perform_auto_ml,
  :recipe_arn,
  :dataset_group_arn,
  :event_type,
  :solution_config)
  SENSITIVE = []
  include Aws::Structure
end