blib/lib/Paws/MachineLearning/CreateMLModel.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::MachineLearning::CreateMLModel;
3 use Moose;
4 has MLModelId => (is => 'ro', isa => 'Str', required => 1);
5 has MLModelName => (is => 'ro', isa => 'Str');
6 has MLModelType => (is => 'ro', isa => 'Str', required => 1);
7 has Parameters => (is => 'ro', isa => 'Paws::MachineLearning::TrainingParameters');
8 has Recipe => (is => 'ro', isa => 'Str');
9 has RecipeUri => (is => 'ro', isa => 'Str');
10 has TrainingDataSourceId => (is => 'ro', isa => 'Str', required => 1);
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMLModel');
15 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::CreateMLModelOutput');
16 class_has _result_key => (isa => 'Str', is => 'ro');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::MachineLearning::CreateMLModel - Arguments for method CreateMLModel on L<Paws::MachineLearning>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreateMLModel on the
28 L<Amazon Machine Learning|Paws::MachineLearning> service. Use the attributes of this class
29 as arguments to method CreateMLModel.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMLModel.
32  
33 =head1 SYNOPSIS
34  
35 my $machinelearning = Paws->service('MachineLearning');
36 my $CreateMLModelOutput = $machinelearning->CreateMLModel(
37 MLModelId => 'MyEntityId',
38 MLModelType => 'REGRESSION',
39 TrainingDataSourceId => 'MyEntityId',
40 MLModelName => 'MyEntityName', # OPTIONAL
41 Parameters => { 'MyStringType' => 'MyStringType', }, # OPTIONAL
42 Recipe => 'MyRecipe', # OPTIONAL
43 RecipeUri => 'MyS3Url', # OPTIONAL
44 );
45  
46 # Results:
47 my $MLModelId = $CreateMLModelOutput->MLModelId;
48  
49 # Returns a L<Paws::MachineLearning::CreateMLModelOutput> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning/CreateMLModel>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> MLModelId => Str
58  
59 A user-supplied ID that uniquely identifies the C<MLModel>.
60  
61  
62  
63 =head2 MLModelName => Str
64  
65 A user-supplied name or description of the C<MLModel>.
66  
67  
68  
69 =head2 B<REQUIRED> MLModelType => Str
70  
71 The category of supervised learning that this C<MLModel> will address.
72 Choose from the following types:
73  
74 =over
75  
76 =item *
77  
78 Choose C<REGRESSION> if the C<MLModel> will be used to predict a
79 numeric value.
80  
81 =item *
82  
83 Choose C<BINARY> if the C<MLModel> result has two possible values.
84  
85 =item *
86  
87 Choose C<MULTICLASS> if the C<MLModel> result has a limited number of
88 values.
89  
90 =back
91  
92 For more information, see the Amazon Machine Learning Developer Guide
93 (https://docs.aws.amazon.com/machine-learning/latest/dg).
94  
95 Valid values are: C<"REGRESSION">, C<"BINARY">, C<"MULTICLASS">
96  
97 =head2 Parameters => L<Paws::MachineLearning::TrainingParameters>
98  
99 A list of the training parameters in the C<MLModel>. The list is
100 implemented as a map of key-value pairs.
101  
102 The following is the current set of training parameters:
103  
104 =over
105  
106 =item *
107  
108 C<sgd.maxMLModelSizeInBytes> - The maximum allowed size of the model.
109 Depending on the input data, the size of the model might affect its
110 performance.
111  
112 The value is an integer that ranges from C<100000> to C<2147483648>.
113 The default value is C<33554432>.
114  
115 =item *
116  
117 C<sgd.maxPasses> - The number of times that the training process
118 traverses the observations to build the C<MLModel>. The value is an
119 integer that ranges from C<1> to C<10000>. The default value is C<10>.
120  
121 =item *
122  
123 C<sgd.shuffleType> - Whether Amazon ML shuffles the training data.
124 Shuffling the data improves a model's ability to find the optimal
125 solution for a variety of data types. The valid values are C<auto> and
126 C<none>. The default value is C<none>. We strongly recommend that you
127 shuffle your data.
128  
129 =item *
130  
131 C<sgd.l1RegularizationAmount> - The coefficient regularization L1 norm.
132 It controls overfitting the data by penalizing large coefficients. This
133 tends to drive coefficients to zero, resulting in a sparse feature set.
134 If you use this parameter, start by specifying a small value, such as
135 C<1.0E-08>.
136  
137 The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The
138 default is to not use L1 normalization. This parameter can't be used
139 when C<L2> is specified. Use this parameter sparingly.
140  
141 =item *
142  
143 C<sgd.l2RegularizationAmount> - The coefficient regularization L2 norm.
144 It controls overfitting the data by penalizing large coefficients. This
145 tends to drive coefficients to small, nonzero values. If you use this
146 parameter, start by specifying a small value, such as C<1.0E-08>.
147  
148 The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The
149 default is to not use L2 normalization. This parameter can't be used
150 when C<L1> is specified. Use this parameter sparingly.
151  
152 =back
153  
154  
155  
156  
157 =head2 Recipe => Str
158  
159 The data recipe for creating the C<MLModel>. You must specify either
160 the recipe or its URI. If you don't specify a recipe or its URI, Amazon
161 ML creates a default.
162  
163  
164  
165 =head2 RecipeUri => Str
166  
167 The Amazon Simple Storage Service (Amazon S3) location and file name
168 that contains the C<MLModel> recipe. You must specify either the recipe
169 or its URI. If you don't specify a recipe or its URI, Amazon ML creates
170 a default.
171  
172  
173  
174 =head2 B<REQUIRED> TrainingDataSourceId => Str
175  
176 The C<DataSource> that points to the training data.
177  
178  
179  
180  
181 =head1 SEE ALSO
182  
183 This class forms part of L<Paws>, documenting arguments for method CreateMLModel in L<Paws::MachineLearning>
184  
185 =head1 BUGS and CONTRIBUTIONS
186  
187 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
188  
189 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
190  
191 =cut
192