Interface CreateSolutionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateSolutionRequest.Builder,
,CreateSolutionRequest> PersonalizeRequest.Builder
,SdkBuilder<CreateSolutionRequest.Builder,
,CreateSolutionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateSolutionRequest
-
Method Summary
Modifier and TypeMethodDescriptiondatasetGroupArn
(String datasetGroupArn) The Amazon Resource Name (ARN) of the dataset group that provides the training data.When your have multiple event types (using anEVENT_TYPE
schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.The name for the solution.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.performAutoML
(Boolean performAutoML) performAutoTraining
(Boolean performAutoTraining) Whether the solution uses automatic training to create new solution versions (trained models).performHPO
(Boolean performHPO) Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe.The Amazon Resource Name (ARN) of the recipe to use for model training.default CreateSolutionRequest.Builder
solutionConfig
(Consumer<SolutionConfig.Builder> solutionConfig) The configuration to use with the solution.solutionConfig
(SolutionConfig solutionConfig) The configuration to use with the solution.tags
(Collection<Tag> tags) A list of tags to apply to the solution.tags
(Consumer<Tag.Builder>... tags) A list of tags to apply to the solution.A list of tags to apply to the solution.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.personalize.model.PersonalizeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name for the solution.
- Parameters:
name
- The name for the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performHPO
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 tofalse
.- Parameters:
performHPO
- Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default isfalse
.When performing AutoML, this parameter is always
true
and you should not set it tofalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performAutoML
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 specifyrecipeArn
.When set to
true
, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omitrecipeArn
. 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.- Parameters:
performAutoML
-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 specifyrecipeArn
.When set to
true
, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omitrecipeArn
. 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:
- Returns a reference to this object so that method calls can be chained together.
-
performAutoTraining
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 aschedulingExpression
in theAutoTrainingConfig
as part of solution configuration. For more information about automatic training, see Configuring automatic training.Automatic solution version creation starts 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.
- Parameters:
performAutoTraining
- Whether the solution uses automatic training to create new solution versions (trained models). The default isTrue
and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying aschedulingExpression
in theAutoTrainingConfig
as part of solution configuration. For more information about automatic training, see Configuring automatic training.Automatic solution version creation starts 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:
- Returns a reference to this object so that method calls can be chained together.
-
recipeArn
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.- Parameters:
recipeArn
- The Amazon Resource Name (ARN) of the recipe to use for model training. This is required whenperformAutoML
is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
datasetGroupArn
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
- Parameters:
datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that provides the training data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventType
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.- Parameters:
eventType
- When your have multiple event types (using anEVENT_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:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
The configuration to use with the solution. When
performAutoML
is set to true, Amazon Personalize only evaluates theautoMLConfig
section of the solution configuration.Amazon Personalize doesn't support configuring the
hpoObjective
at this time.- Parameters:
solutionConfig
- The configuration to use with the solution. WhenperformAutoML
is set to true, Amazon Personalize only evaluates theautoMLConfig
section of the solution configuration.Amazon Personalize doesn't support configuring the
hpoObjective
at this time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
solutionConfig
default CreateSolutionRequest.Builder solutionConfig(Consumer<SolutionConfig.Builder> solutionConfig) The configuration to use with the solution. When
performAutoML
is set to true, Amazon Personalize only evaluates theautoMLConfig
section of the solution configuration.Amazon Personalize doesn't support configuring the
hpoObjective
at this time.SolutionConfig.Builder
avoiding the need to create one manually viaSolutionConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosolutionConfig(SolutionConfig)
.- Parameters:
solutionConfig
- a consumer that will call methods onSolutionConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
A list of tags to apply to the solution.
- Parameters:
tags
- A list of tags to apply to the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to apply to the solution.
- Parameters:
tags
- A list of tags to apply to the solution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tags to apply to the solution.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateSolutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateSolutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-