Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Personalize.CreateSolution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

Synopsis

data CreateSolution = CreateSolution' {
- eventType :: Maybe Text
- performAutoML :: Maybe Bool
- performHPO :: Maybe Bool
- recipeArn :: Maybe Text
- solutionConfig :: Maybe SolutionConfig
- tags :: Maybe [Tag]
- name :: Text
- datasetGroupArn :: Text
}
newCreateSolution :: Text -> Text -> CreateSolution
createSolution_eventType :: Lens' CreateSolution (Maybe Text)
createSolution_performAutoML :: Lens' CreateSolution (Maybe Bool)
createSolution_performHPO :: Lens' CreateSolution (Maybe Bool)
createSolution_recipeArn :: Lens' CreateSolution (Maybe Text)
createSolution_solutionConfig :: Lens' CreateSolution (Maybe SolutionConfig)
createSolution_tags :: Lens' CreateSolution (Maybe [Tag])
createSolution_name :: Lens' CreateSolution Text
createSolution_datasetGroupArn :: Lens' CreateSolution Text
data CreateSolutionResponse = CreateSolutionResponse' {
- solutionArn :: Maybe Text
- httpStatus :: Int
}
newCreateSolutionResponse :: Int -> CreateSolutionResponse
createSolutionResponse_solutionArn :: Lens' CreateSolutionResponse (Maybe Text)
createSolutionResponse_httpStatus :: Lens' CreateSolutionResponse Int

Creating a Request

data CreateSolution Source #

See: newCreateSolution smart constructor.

Constructors

CreateSolution'

Fields

eventType :: Maybe Text
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.
performAutoML :: Maybe Bool
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.
performHPO :: Maybe Bool
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.
recipeArn :: Maybe Text
The ARN of the recipe to use for model training. Only specified when performAutoML is false.
solutionConfig :: Maybe 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.
tags :: Maybe [Tag]
A list of tags to apply to the solution.
name :: Text
The name for the solution.
datasetGroupArn :: Text
The Amazon Resource Name (ARN) of the dataset group that provides the training data.

Instances

Instances details

ToJSON CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods toJSON :: CreateSolution -> Value # toEncoding :: CreateSolution -> Encoding # toJSONList :: [CreateSolution] -> Value # toEncodingList :: [CreateSolution] -> Encoding #
ToHeaders CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods toHeaders :: CreateSolution -> [Header] #
ToPath CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods toPath :: CreateSolution -> ByteString #
ToQuery CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods toQuery :: CreateSolution -> QueryString #
AWSRequest CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Associated Types type AWSResponse CreateSolution # Methods request :: (Service -> Service) -> CreateSolution -> Request CreateSolution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSolution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSolution))) #
Generic CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Associated Types type Rep CreateSolution :: Type -> Type # Methods from :: CreateSolution -> Rep CreateSolution x # to :: Rep CreateSolution x -> CreateSolution #
Read CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods readsPrec :: Int -> ReadS CreateSolution # readList :: ReadS [CreateSolution] # readPrec :: ReadPrec CreateSolution # readListPrec :: ReadPrec [CreateSolution] #
Show CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods showsPrec :: Int -> CreateSolution -> ShowS # show :: CreateSolution -> String # showList :: [CreateSolution] -> ShowS #
NFData CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods rnf :: CreateSolution -> () #
Eq CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods (==) :: CreateSolution -> CreateSolution -> Bool # (/=) :: CreateSolution -> CreateSolution -> Bool #
Hashable CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods hashWithSalt :: Int -> CreateSolution -> Int # hash :: CreateSolution -> Int #
type AWSResponse CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution type AWSResponse CreateSolution = CreateSolutionResponse
type Rep CreateSolution Source #
Instance details Defined in Amazonka.Personalize.CreateSolution type Rep CreateSolution = D1 ('MetaData "CreateSolution" "Amazonka.Personalize.CreateSolution" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateSolution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "performAutoML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "performHPO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "recipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "solutionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SolutionConfig)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSolution Source #

Arguments

:: Text	`CreateSolution`
-> Text	`CreateSolution`
-> CreateSolution

Create a value of CreateSolution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateSolution, createSolution_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.

CreateSolution, createSolution_performAutoML - 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.

CreateSolution, createSolution_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 to false.

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

CreateSolution, createSolution_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.

$sel:tags:CreateSolution', createSolution_tags - A list of tags to apply to the solution.

CreateSolution, createSolution_name - The name for the solution.

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

Request Lenses

createSolution_eventType :: Lens' CreateSolution (Maybe Text) Source #

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.

createSolution_performAutoML :: Lens' CreateSolution (Maybe Bool) Source #

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.

createSolution_performHPO :: Lens' CreateSolution (Maybe Bool) Source #

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.

createSolution_recipeArn :: Lens' CreateSolution (Maybe Text) Source #

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

createSolution_solutionConfig :: Lens' CreateSolution (Maybe SolutionConfig) Source #

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.

createSolution_tags :: Lens' CreateSolution (Maybe [Tag]) Source #

A list of tags to apply to the solution.

createSolution_name :: Lens' CreateSolution Text Source #

The name for the solution.

createSolution_datasetGroupArn :: Lens' CreateSolution Text Source #

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

Destructuring the Response

data CreateSolutionResponse Source #

See: newCreateSolutionResponse smart constructor.

Constructors

CreateSolutionResponse'
Fields solutionArn :: Maybe Text The ARN of the solution. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Associated Types type Rep CreateSolutionResponse :: Type -> Type # Methods from :: CreateSolutionResponse -> Rep CreateSolutionResponse x # to :: Rep CreateSolutionResponse x -> CreateSolutionResponse #
Read CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods readsPrec :: Int -> ReadS CreateSolutionResponse # readList :: ReadS [CreateSolutionResponse] # readPrec :: ReadPrec CreateSolutionResponse # readListPrec :: ReadPrec [CreateSolutionResponse] #
Show CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods showsPrec :: Int -> CreateSolutionResponse -> ShowS # show :: CreateSolutionResponse -> String # showList :: [CreateSolutionResponse] -> ShowS #
NFData CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods rnf :: CreateSolutionResponse -> () #
Eq CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution Methods (==) :: CreateSolutionResponse -> CreateSolutionResponse -> Bool # (/=) :: CreateSolutionResponse -> CreateSolutionResponse -> Bool #
type Rep CreateSolutionResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSolution type Rep CreateSolutionResponse = D1 ('MetaData "CreateSolutionResponse" "Amazonka.Personalize.CreateSolution" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateSolutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "solutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSolutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSolutionResponse'`
-> CreateSolutionResponse

Create a value of CreateSolutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateSolutionResponse, createSolutionResponse_solutionArn - The ARN of the solution.

$sel:httpStatus:CreateSolutionResponse', createSolutionResponse_httpStatus - The response's http status code.

Response Lenses

createSolutionResponse_solutionArn :: Lens' CreateSolutionResponse (Maybe Text) Source #

The ARN of the solution.

createSolutionResponse_httpStatus :: Lens' CreateSolutionResponse Int Source #

The response's http status code.