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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_group_arn ⇒ String

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

Returns:

  • (String) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#event_type ⇒ String

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) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#name ⇒ String

The name for the solution.

Returns:

  • (String) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#perform_auto_ml ⇒ Boolean

We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

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) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#perform_auto_training ⇒ Boolean

Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

Returns:

  • (Boolean) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#perform_hpo ⇒ Boolean

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) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#perform_incremental_update ⇒ Boolean

Whether to perform incremental training updates on your model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.

Returns:

  • (Boolean) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#recipe_arn ⇒ String

The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

Returns:

  • (String) 


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#solution_config ⇒ Types::SolutionConfig

The configuration properties for 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.

Returns:



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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

#tags ⇒ Array<Types::Tag>

A list of tags to apply to the solution.

Returns:



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 1768

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