« blib/lib/Paws/Personalize/CreateSchemaResponse.pm
↑ Summary
blib/lib/Paws/Personalize/CreateSolutionResponse.pm »
| 1 | |||
| 2 | package Paws::Personalize::CreateSolution; | ||
| 3 | use Moose; | ||
| 4 | has DatasetGroupArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'datasetGroupArn' , required => 1); | ||
| 5 | has EventType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'eventType' ); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 7 | has PerformAutoML => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'performAutoML' ); | ||
| 8 | has PerformHPO => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'performHPO' ); | ||
| 9 | has RecipeArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'recipeArn' ); | ||
| 10 | has SolutionConfig => (is => 'ro', isa => 'Paws::Personalize::SolutionConfig', traits => ['NameInRequest'], request_name => 'solutionConfig' ); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSolution'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Personalize::CreateSolutionResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Personalize::CreateSolution - Arguments for method CreateSolution on L<Paws::Personalize> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateSolution on the | ||
| 28 | L<Amazon Personalize|Paws::Personalize> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateSolution. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSolution. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $personalize = Paws->service('Personalize'); | ||
| 36 | my $CreateSolutionResponse = $personalize->CreateSolution( | ||
| 37 | DatasetGroupArn => 'MyArn', | ||
| 38 | Name => 'MyName', | ||
| 39 | EventType => 'MyEventType', # OPTIONAL | ||
| 40 | PerformAutoML => 1, # OPTIONAL | ||
| 41 | PerformHPO => 1, # OPTIONAL | ||
| 42 | RecipeArn => 'MyArn', # OPTIONAL | ||
| 43 | SolutionConfig => { | ||
| 44 | AlgorithmHyperParameters => { | ||
| 45 | 'MyParameterName' => | ||
| 46 | 'MyParameterValue', # key: max: 256, value: max: 1000 | ||
| 47 | }, # max: 100; OPTIONAL | ||
| 48 | AutoMLConfig => { | ||
| 49 | MetricName => 'MyMetricName', # max: 256; OPTIONAL | ||
| 50 | RecipeList => [ | ||
| 51 | 'MyArn', ... # max: 256 | ||
| 52 | ], # max: 100; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | EventValueThreshold => 'MyEventValueThreshold', # max: 256; OPTIONAL | ||
| 55 | FeatureTransformationParameters => { | ||
| 56 | 'MyParameterName' => | ||
| 57 | 'MyParameterValue', # key: max: 256, value: max: 1000 | ||
| 58 | }, # max: 100; OPTIONAL | ||
| 59 | HpoConfig => { | ||
| 60 | AlgorithmHyperParameterRanges => { | ||
| 61 | CategoricalHyperParameterRanges => [ | ||
| 62 | { | ||
| 63 | Name => 'MyParameterName', # max: 256 | ||
| 64 | Values => [ | ||
| 65 | 'MyCategoricalValue', ... # max: 1000 | ||
| 66 | ], # max: 100; OPTIONAL | ||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # max: 100; OPTIONAL | ||
| 70 | ContinuousHyperParameterRanges => [ | ||
| 71 | { | ||
| 72 | MaxValue => 1, # min: -1000000; OPTIONAL | ||
| 73 | MinValue => 1, # min: -1000000; OPTIONAL | ||
| 74 | Name => 'MyParameterName', # max: 256 | ||
| 75 | }, | ||
| 76 | ... | ||
| 77 | ], # max: 100; OPTIONAL | ||
| 78 | IntegerHyperParameterRanges => [ | ||
| 79 | { | ||
| 80 | MaxValue => 1, # max: 1000000; OPTIONAL | ||
| 81 | MinValue => 1, # min: -1000000; OPTIONAL | ||
| 82 | Name => 'MyParameterName', # max: 256 | ||
| 83 | }, | ||
| 84 | ... | ||
| 85 | ], # max: 100; OPTIONAL | ||
| 86 | }, # OPTIONAL | ||
| 87 | HpoObjective => { | ||
| 88 | MetricName => 'MyMetricName', # max: 256; OPTIONAL | ||
| 89 | MetricRegex => 'MyMetricRegex', # max: 256; OPTIONAL | ||
| 90 | Type => 'MyHPOObjectiveType', # max: 256; OPTIONAL | ||
| 91 | }, # OPTIONAL | ||
| 92 | HpoResourceConfig => { | ||
| 93 | MaxNumberOfTrainingJobs => 'MyHPOResource', # max: 256; OPTIONAL | ||
| 94 | MaxParallelTrainingJobs => 'MyHPOResource', # max: 256; OPTIONAL | ||
| 95 | }, # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | OptimizationObjective => { | ||
| 98 | ItemAttribute => 'MyItemAttribute', # min: 1, max: 150; OPTIONAL | ||
| 99 | ObjectiveSensitivity => | ||
| 100 | 'LOW', # values: LOW, MEDIUM, HIGH, OFF; OPTIONAL | ||
| 101 | }, # OPTIONAL | ||
| 102 | }, # OPTIONAL | ||
| 103 | ); | ||
| 104 | |||
| 105 | # Results: | ||
| 106 | my $SolutionArn = $CreateSolutionResponse->SolutionArn; | ||
| 107 | |||
| 108 | # Returns a L<Paws::Personalize::CreateSolutionResponse> object. | ||
| 109 | |||
| 110 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 111 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/personalize/CreateSolution> | ||
| 112 | |||
| 113 | =head1 ATTRIBUTES | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> DatasetGroupArn => Str | ||
| 117 | |||
| 118 | The Amazon Resource Name (ARN) of the dataset group that provides the | ||
| 119 | training data. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 EventType => Str | ||
| 124 | |||
| 125 | When your have multiple event types (using an C<EVENT_TYPE> schema | ||
| 126 | field), this parameter specifies which event type (for example, 'click' | ||
| 127 | or 'like') is used for training the model. | ||
| 128 | |||
| 129 | If you do not provide an C<eventType>, Amazon Personalize will use all | ||
| 130 | interactions for training with equal weight regardless of type. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 B<REQUIRED> Name => Str | ||
| 135 | |||
| 136 | The name for the solution. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 PerformAutoML => Bool | ||
| 141 | |||
| 142 | Whether to perform automated machine learning (AutoML). The default is | ||
| 143 | C<false>. For this case, you must specify C<recipeArn>. | ||
| 144 | |||
| 145 | When set to C<true>, Amazon Personalize analyzes your training data and | ||
| 146 | selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In | ||
| 147 | this case, you must omit C<recipeArn>. Amazon Personalize determines | ||
| 148 | the optimal recipe by running tests with different values for the | ||
| 149 | hyperparameters. AutoML lengthens the training process as compared to | ||
| 150 | selecting a specific recipe. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 PerformHPO => Bool | ||
| 155 | |||
| 156 | Whether to perform hyperparameter optimization (HPO) on the specified | ||
| 157 | or selected recipe. The default is C<false>. | ||
| 158 | |||
| 159 | When performing AutoML, this parameter is always C<true> and you should | ||
| 160 | not set it to C<false>. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 RecipeArn => Str | ||
| 165 | |||
| 166 | The ARN of the recipe to use for model training. Only specified when | ||
| 167 | C<performAutoML> is false. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 SolutionConfig => L<Paws::Personalize::SolutionConfig> | ||
| 172 | |||
| 173 | The configuration to use with the solution. When C<performAutoML> is | ||
| 174 | set to true, Amazon Personalize only evaluates the C<autoMLConfig> | ||
| 175 | section of the solution configuration. | ||
| 176 | |||
| 177 | Amazon Personalize doesn't support configuring the C<hpoObjective> at | ||
| 178 | this time. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, documenting arguments for method CreateSolution in L<Paws::Personalize> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |