« blib/lib/Paws/MachineLearning/DescribeMLModelsOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/RealtimeEndpointInfo.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MachineLearning::MLModel; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Algorithm => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has ComputeTime => (is => 'ro', isa => 'Int'); | |
| 6 | 1 | has CreatedAt => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has CreatedByIamUser => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has EndpointInfo => (is => 'ro', isa => 'Paws::MachineLearning::RealtimeEndpointInfo'); | |
| 9 | 1 | has FinishedAt => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has InputDataLocationS3 => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has LastUpdatedAt => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has Message => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has MLModelId => (is => 'ro', isa => 'Str'); | |
| 14 | 1 | has MLModelType => (is => 'ro', isa => 'Str'); | |
| 15 | 1 | has Name => (is => 'ro', isa => 'Str'); | |
| 16 | 1 | has ScoreThreshold => (is => 'ro', isa => 'Num'); | |
| 17 | 1 | has ScoreThresholdLastUpdatedAt => (is => 'ro', isa => 'Str'); | |
| 18 | 1 | has SizeInBytes => (is => 'ro', isa => 'Int'); | |
| 19 | 1 | has StartedAt => (is => 'ro', isa => 'Str'); | |
| 20 | 1 | has Status => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has TrainingDataSourceId => (is => 'ro', isa => 'Str'); | |
| 22 | 1 | has TrainingParameters => (is => 'ro', isa => 'Paws::MachineLearning::TrainingParameters'); | |
| 23 | |||
| 24 | 1 | 1; | |
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::MachineLearning::MLModel | ||
| 31 | |||
| 32 | =head1 USAGE | ||
| 33 | |||
| 34 | This class represents one of two things: | ||
| 35 | |||
| 36 | =head3 Arguments in a call to a service | ||
| 37 | |||
| 38 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 39 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 40 | |||
| 41 | As an example, if Att1 is expected to be a Paws::MachineLearning::MLModel object: | ||
| 42 | |||
| 43 | $service_obj->Method(Att1 => { Algorithm => $value, ..., TrainingParameters => $value }); | ||
| 44 | |||
| 45 | =head3 Results returned from an API call | ||
| 46 | |||
| 47 | Use accessors for each attribute. If Att1 is expected to be an Paws::MachineLearning::MLModel object: | ||
| 48 | |||
| 49 | $result = $service_obj->Method(...); | ||
| 50 | $result->Att1->Algorithm | ||
| 51 | |||
| 52 | =head1 DESCRIPTION | ||
| 53 | |||
| 54 | Represents the output of a C<GetMLModel> operation. | ||
| 55 | |||
| 56 | The content consists of the detailed metadata and the current status of | ||
| 57 | the C<MLModel>. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Algorithm => Str | ||
| 63 | |||
| 64 | The algorithm used to train the C<MLModel>. The following algorithm is | ||
| 65 | supported: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<SGD> -- Stochastic gradient descent. The goal of C<SGD> is to | ||
| 72 | minimize the gradient of the loss function. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 ComputeTime => Int | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 CreatedAt => Str | ||
| 84 | |||
| 85 | The time that the C<MLModel> was created. The time is expressed in | ||
| 86 | epoch time. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 CreatedByIamUser => Str | ||
| 90 | |||
| 91 | The AWS user account from which the C<MLModel> was created. The account | ||
| 92 | type can be either an AWS root account or an AWS Identity and Access | ||
| 93 | Management (IAM) user account. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 EndpointInfo => L<Paws::MachineLearning::RealtimeEndpointInfo> | ||
| 97 | |||
| 98 | The current endpoint of the C<MLModel>. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 FinishedAt => Str | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 InputDataLocationS3 => Str | ||
| 107 | |||
| 108 | The location of the data file or directory in Amazon Simple Storage | ||
| 109 | Service (Amazon S3). | ||
| 110 | |||
| 111 | |||
| 112 | =head2 LastUpdatedAt => Str | ||
| 113 | |||
| 114 | The time of the most recent edit to the C<MLModel>. The time is | ||
| 115 | expressed in epoch time. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 Message => Str | ||
| 119 | |||
| 120 | A description of the most recent details about accessing the | ||
| 121 | C<MLModel>. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 MLModelId => Str | ||
| 125 | |||
| 126 | The ID assigned to the C<MLModel> at creation. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 MLModelType => Str | ||
| 130 | |||
| 131 | Identifies the C<MLModel> category. The following are the available | ||
| 132 | types: | ||
| 133 | |||
| 134 | =over | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<REGRESSION> - Produces a numeric result. For example, "What price | ||
| 139 | should a house be listed at?" | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<BINARY> - Produces one of two possible results. For example, "Is this | ||
| 144 | a child-friendly web site?". | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | C<MULTICLASS> - Produces one of several possible results. For example, | ||
| 149 | "Is this a HIGH-, LOW-, or MEDIUM-risk trade?". | ||
| 150 | |||
| 151 | =back | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 Name => Str | ||
| 156 | |||
| 157 | A user-supplied name or description of the C<MLModel>. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 ScoreThreshold => Num | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 ScoreThresholdLastUpdatedAt => Str | ||
| 166 | |||
| 167 | The time of the most recent edit to the C<ScoreThreshold>. The time is | ||
| 168 | expressed in epoch time. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 SizeInBytes => Int | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head2 StartedAt => Str | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 Status => Str | ||
| 182 | |||
| 183 | The current status of an C<MLModel>. This element can have one of the | ||
| 184 | following values: | ||
| 185 | |||
| 186 | =over | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<PENDING> - Amazon Machine Learning (Amazon ML) submitted a request to | ||
| 191 | create an C<MLModel>. | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<INPROGRESS> - The creation process is underway. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | C<FAILED> - The request to create an C<MLModel> didn't run to | ||
| 200 | completion. The model isn't usable. | ||
| 201 | |||
| 202 | =item * | ||
| 203 | |||
| 204 | C<COMPLETED> - The creation process completed successfully. | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | C<DELETED> - The C<MLModel> is marked as deleted. It isn't usable. | ||
| 209 | |||
| 210 | =back | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head2 TrainingDataSourceId => Str | ||
| 215 | |||
| 216 | The ID of the training C<DataSource>. The C<CreateMLModel> operation | ||
| 217 | uses the C<TrainingDataSourceId>. | ||
| 218 | |||
| 219 | |||
| 220 | =head2 TrainingParameters => L<Paws::MachineLearning::TrainingParameters> | ||
| 221 | |||
| 222 | A list of the training parameters in the C<MLModel>. The list is | ||
| 223 | implemented as a map of key-value pairs. | ||
| 224 | |||
| 225 | The following is the current set of training parameters: | ||
| 226 | |||
| 227 | =over | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | C<sgd.maxMLModelSizeInBytes> - The maximum allowed size of the model. | ||
| 232 | Depending on the input data, the size of the model might affect its | ||
| 233 | performance. | ||
| 234 | |||
| 235 | The value is an integer that ranges from C<100000> to C<2147483648>. | ||
| 236 | The default value is C<33554432>. | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | C<sgd.maxPasses> - The number of times that the training process | ||
| 241 | traverses the observations to build the C<MLModel>. The value is an | ||
| 242 | integer that ranges from C<1> to C<10000>. The default value is C<10>. | ||
| 243 | |||
| 244 | =item * | ||
| 245 | |||
| 246 | C<sgd.shuffleType> - Whether Amazon ML shuffles the training data. | ||
| 247 | Shuffling the data improves a model's ability to find the optimal | ||
| 248 | solution for a variety of data types. The valid values are C<auto> and | ||
| 249 | C<none>. The default value is C<none>. | ||
| 250 | |||
| 251 | =item * | ||
| 252 | |||
| 253 | C<sgd.l1RegularizationAmount> - The coefficient regularization L1 norm, | ||
| 254 | which controls overfitting the data by penalizing large coefficients. | ||
| 255 | This parameter tends to drive coefficients to zero, resulting in sparse | ||
| 256 | feature set. If you use this parameter, start by specifying a small | ||
| 257 | value, such as C<1.0E-08>. | ||
| 258 | |||
| 259 | The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The | ||
| 260 | default is to not use L1 normalization. This parameter can't be used | ||
| 261 | when C<L2> is specified. Use this parameter sparingly. | ||
| 262 | |||
| 263 | =item * | ||
| 264 | |||
| 265 | C<sgd.l2RegularizationAmount> - The coefficient regularization L2 norm, | ||
| 266 | which controls overfitting the data by penalizing large coefficients. | ||
| 267 | This tends to drive coefficients to small, nonzero values. If you use | ||
| 268 | this parameter, start by specifying a small value, such as C<1.0E-08>. | ||
| 269 | |||
| 270 | The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The | ||
| 271 | default is to not use L2 normalization. This parameter can't be used | ||
| 272 | when C<L1> is specified. Use this parameter sparingly. | ||
| 273 | |||
| 274 | =back | ||
| 275 | |||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | =head1 SEE ALSO | ||
| 280 | |||
| 281 | This class forms part of L<Paws>, describing an object used in L<Paws::MachineLearning> | ||
| 282 | |||
| 283 | =head1 BUGS and CONTRIBUTIONS | ||
| 284 | |||
| 285 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 286 | |||
| 287 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 288 | |||
| 289 | =cut | ||
| 290 | |||