Personalize / Client / create_solution

create_solution#

Personalize.Client.create_solution(**kwargs)#

Warning

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. 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. For more information, see Configuring automatic training.

To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

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.

After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

Note

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. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

Related APIs

See also: AWS API Documentation

Request Syntax

response = client.create_solution(
    name='string',
    performHPO=True|False,
    performAutoML=True|False,
    performAutoTraining=True|False,
    recipeArn='string',
    datasetGroupArn='string',
    eventType='string',
    solutionConfig={
        'eventValueThreshold': 'string',
        'hpoConfig': {
            'hpoObjective': {
                'type': 'string',
                'metricName': 'string',
                'metricRegex': 'string'
            },
            'hpoResourceConfig': {
                'maxNumberOfTrainingJobs': 'string',
                'maxParallelTrainingJobs': 'string'
            },
            'algorithmHyperParameterRanges': {
                'integerHyperParameterRanges': [
                    {
                        'name': 'string',
                        'minValue': 123,
                        'maxValue': 123
                    },
                ],
                'continuousHyperParameterRanges': [
                    {
                        'name': 'string',
                        'minValue': 123.0,
                        'maxValue': 123.0
                    },
                ],
                'categoricalHyperParameterRanges': [
                    {
                        'name': 'string',
                        'values': [
                            'string',
                        ]
                    },
                ]
            }
        },
        'algorithmHyperParameters': {
            'string': 'string'
        },
        'featureTransformationParameters': {
            'string': 'string'
        },
        'autoMLConfig': {
            'metricName': 'string',
            'recipeList': [
                'string',
            ]
        },
        'optimizationObjective': {
            'itemAttribute': 'string',
            'objectiveSensitivity': 'LOW'|'MEDIUM'|'HIGH'|'OFF'
        },
        'trainingDataConfig': {
            'excludedDatasetColumns': {
                'string': [
                    'string',
                ]
            }
        },
        'autoTrainingConfig': {
            'schedulingExpression': 'string'
        }
    },
    tags=[
        {
            'tagKey': 'string',
            'tagValue': 'string'
        },
    ]
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name for the solution.

  • performHPO (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.

  • performAutoML (boolean) –

    Warning

    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.

  • performAutoTraining (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.

  • recipeArn (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.

  • datasetGroupArn (string) –

    [REQUIRED]

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

  • eventType (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.

  • solutionConfig (dict) –

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

    Note

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

    • eventValueThreshold (string) –

      Only events with a value greater than or equal to this threshold are used for training a model.

    • hpoConfig (dict) –

      Describes the properties for hyperparameter optimization (HPO).

      • hpoObjective (dict) –

        The metric to optimize during HPO.

        Note

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

        • type (string) –

          The type of the metric. Valid values are Maximize and Minimize.

        • metricName (string) –

          The name of the metric.

        • metricRegex (string) –

          A regular expression for finding the metric in the training job logs.

      • hpoResourceConfig (dict) –

        Describes the resource configuration for HPO.

        • maxNumberOfTrainingJobs (string) –

          The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

        • maxParallelTrainingJobs (string) –

          The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

      • algorithmHyperParameterRanges (dict) –

        The hyperparameters and their allowable ranges.

        • integerHyperParameterRanges (list) –

          The integer-valued hyperparameters and their ranges.

          • (dict) –

            Provides the name and range of an integer-valued hyperparameter.

            • name (string) –

              The name of the hyperparameter.

            • minValue (integer) –

              The minimum allowable value for the hyperparameter.

            • maxValue (integer) –

              The maximum allowable value for the hyperparameter.

        • continuousHyperParameterRanges (list) –

          The continuous hyperparameters and their ranges.

          • (dict) –

            Provides the name and range of a continuous hyperparameter.

            • name (string) –

              The name of the hyperparameter.

            • minValue (float) –

              The minimum allowable value for the hyperparameter.

            • maxValue (float) –

              The maximum allowable value for the hyperparameter.

        • categoricalHyperParameterRanges (list) –

          The categorical hyperparameters and their ranges.

          • (dict) –

            Provides the name and range of a categorical hyperparameter.

            • name (string) –

              The name of the hyperparameter.

            • values (list) –

              A list of the categories for the hyperparameter.

              • (string) –

    • algorithmHyperParameters (dict) –

      Lists the algorithm hyperparameters and their values.

      • (string) –

        • (string) –

    • featureTransformationParameters (dict) –

      Lists the feature transformation parameters.

      • (string) –

        • (string) –

    • autoMLConfig (dict) –

      The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

      • metricName (string) –

        The metric to optimize.

      • recipeList (list) –

        The list of candidate recipes.

        • (string) –

    • optimizationObjective (dict) –

      Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

      • itemAttribute (string) –

        The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

      • objectiveSensitivity (string) –

        Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

    • trainingDataConfig (dict) –

      Specifies the training data configuration to use when creating a custom solution version (trained model).

      • excludedDatasetColumns (dict) –

        Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.

        For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.

        • (string) –

          • (list) –

            • (string) –

    • autoTrainingConfig (dict) –

      Specifies the automatic training configuration to use.

      • schedulingExpression (string) –

        Specifies how often to automatically train new solution versions. Specify a rate expression in rate(value unit) format. For value, specify a number between 1 and 30. For unit, specify day or days. For example, to automatically create a new solution version every 5 days, specify rate(5 days). The default is every 7 days.

        For more information about auto training, see Creating and configuring a solution.

  • tags (list) –

    A list of tags to apply to the solution.

    • (dict) –

      The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources.

      • tagKey (string) – [REQUIRED]

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • tagValue (string) – [REQUIRED]

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'solutionArn': 'string'
}

Response Structure

  • (dict) –

    • solutionArn (string) –

      The ARN of the solution.

Exceptions