« blib/lib/Paws/MachineLearning/GetMLModel.pm
↑ Summary
blib/lib/Paws/MachineLearning/PerformanceMetrics.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::GetMLModelOutput; | ||
| 3 | use Moose; | ||
| 4 | has ComputeTime => (is => 'ro', isa => 'Int'); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str'); | ||
| 6 | has CreatedByIamUser => (is => 'ro', isa => 'Str'); | ||
| 7 | has EndpointInfo => (is => 'ro', isa => 'Paws::MachineLearning::RealtimeEndpointInfo'); | ||
| 8 | has FinishedAt => (is => 'ro', isa => 'Str'); | ||
| 9 | has InputDataLocationS3 => (is => 'ro', isa => 'Str'); | ||
| 10 | has LastUpdatedAt => (is => 'ro', isa => 'Str'); | ||
| 11 | has LogUri => (is => 'ro', isa => 'Str'); | ||
| 12 | has Message => (is => 'ro', isa => 'Str'); | ||
| 13 | has MLModelId => (is => 'ro', isa => 'Str'); | ||
| 14 | has MLModelType => (is => 'ro', isa => 'Str'); | ||
| 15 | has Name => (is => 'ro', isa => 'Str'); | ||
| 16 | has Recipe => (is => 'ro', isa => 'Str'); | ||
| 17 | has Schema => (is => 'ro', isa => 'Str'); | ||
| 18 | has ScoreThreshold => (is => 'ro', isa => 'Num'); | ||
| 19 | has ScoreThresholdLastUpdatedAt => (is => 'ro', isa => 'Str'); | ||
| 20 | has SizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 21 | has StartedAt => (is => 'ro', isa => 'Str'); | ||
| 22 | has Status => (is => 'ro', isa => 'Str'); | ||
| 23 | has TrainingDataSourceId => (is => 'ro', isa => 'Str'); | ||
| 24 | has TrainingParameters => (is => 'ro', isa => 'Paws::MachineLearning::TrainingParameters'); | ||
| 25 | |||
| 26 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::MachineLearning::GetMLModelOutput | ||
| 33 | |||
| 34 | =head1 ATTRIBUTES | ||
| 35 | |||
| 36 | |||
| 37 | =head2 ComputeTime => Int | ||
| 38 | |||
| 39 | The approximate CPU time in milliseconds that Amazon Machine Learning | ||
| 40 | spent processing the C<MLModel>, normalized and scaled on computation | ||
| 41 | resources. C<ComputeTime> is only available if the C<MLModel> is in the | ||
| 42 | C<COMPLETED> state. | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CreatedAt => Str | ||
| 46 | |||
| 47 | The time that the C<MLModel> was created. The time is expressed in | ||
| 48 | epoch time. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 CreatedByIamUser => Str | ||
| 52 | |||
| 53 | The AWS user account from which the C<MLModel> was created. The account | ||
| 54 | type can be either an AWS root account or an AWS Identity and Access | ||
| 55 | Management (IAM) user account. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 EndpointInfo => L<Paws::MachineLearning::RealtimeEndpointInfo> | ||
| 59 | |||
| 60 | The current endpoint of the C<MLModel> | ||
| 61 | |||
| 62 | |||
| 63 | =head2 FinishedAt => Str | ||
| 64 | |||
| 65 | The epoch time when Amazon Machine Learning marked the C<MLModel> as | ||
| 66 | C<COMPLETED> or C<FAILED>. C<FinishedAt> is only available when the | ||
| 67 | C<MLModel> is in the C<COMPLETED> or C<FAILED> state. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 InputDataLocationS3 => Str | ||
| 71 | |||
| 72 | The location of the data file or directory in Amazon Simple Storage | ||
| 73 | Service (Amazon S3). | ||
| 74 | |||
| 75 | |||
| 76 | =head2 LastUpdatedAt => Str | ||
| 77 | |||
| 78 | The time of the most recent edit to the C<MLModel>. The time is | ||
| 79 | expressed in epoch time. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 LogUri => Str | ||
| 83 | |||
| 84 | A link to the file that contains logs of the C<CreateMLModel> | ||
| 85 | operation. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 Message => Str | ||
| 89 | |||
| 90 | A description of the most recent details about accessing the | ||
| 91 | C<MLModel>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 MLModelId => Str | ||
| 95 | |||
| 96 | The MLModel ID, which is same as the C<MLModelId> in the request. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 MLModelType => Str | ||
| 100 | |||
| 101 | Identifies the C<MLModel> category. The following are the available | ||
| 102 | types: | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | REGRESSION -- Produces a numeric result. For example, "What price | ||
| 109 | should a house be listed at?" | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | BINARY -- Produces one of two possible results. For example, "Is this | ||
| 114 | an e-commerce website?" | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | MULTICLASS -- Produces one of several possible results. For example, | ||
| 119 | "Is this a HIGH, LOW or MEDIUM risk trade?" | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | Valid values are: C<"REGRESSION">, C<"BINARY">, C<"MULTICLASS"> | ||
| 125 | =head2 Name => Str | ||
| 126 | |||
| 127 | A user-supplied name or description of the C<MLModel>. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Recipe => Str | ||
| 131 | |||
| 132 | The recipe to use when training the C<MLModel>. The C<Recipe> provides | ||
| 133 | detailed information about the observation data to use during training, | ||
| 134 | and manipulations to perform on the observation data during training. | ||
| 135 | |||
| 136 | B<Note:> This parameter is provided as part of the verbose format. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 Schema => Str | ||
| 140 | |||
| 141 | The schema used by all of the data files referenced by the | ||
| 142 | C<DataSource>. | ||
| 143 | |||
| 144 | B<Note:> This parameter is provided as part of the verbose format. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 ScoreThreshold => Num | ||
| 148 | |||
| 149 | The scoring threshold is used in binary classification C<MLModel> | ||
| 150 | models. It marks the boundary between a positive prediction and a | ||
| 151 | negative prediction. | ||
| 152 | |||
| 153 | Output values greater than or equal to the threshold receive a positive | ||
| 154 | result from the MLModel, such as C<true>. Output values less than the | ||
| 155 | threshold receive a negative response from the MLModel, such as | ||
| 156 | C<false>. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 ScoreThresholdLastUpdatedAt => Str | ||
| 160 | |||
| 161 | The time of the most recent edit to the C<ScoreThreshold>. The time is | ||
| 162 | expressed in epoch time. | ||
| 163 | |||
| 164 | |||
| 165 | =head2 SizeInBytes => Int | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 StartedAt => Str | ||
| 171 | |||
| 172 | The epoch time when Amazon Machine Learning marked the C<MLModel> as | ||
| 173 | C<INPROGRESS>. C<StartedAt> isn't available if the C<MLModel> is in the | ||
| 174 | C<PENDING> state. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 Status => Str | ||
| 178 | |||
| 179 | The current status of the C<MLModel>. This element can have one of the | ||
| 180 | following values: | ||
| 181 | |||
| 182 | =over | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<PENDING> - Amazon Machine Learning (Amazon ML) submitted a request to | ||
| 187 | describe a C<MLModel>. | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | C<INPROGRESS> - The request is processing. | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<FAILED> - The request did not run to completion. The ML model isn't | ||
| 196 | usable. | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | C<COMPLETED> - The request completed successfully. | ||
| 201 | |||
| 202 | =item * | ||
| 203 | |||
| 204 | C<DELETED> - The C<MLModel> is marked as deleted. It isn't usable. | ||
| 205 | |||
| 206 | =back | ||
| 207 | |||
| 208 | |||
| 209 | Valid values are: C<"PENDING">, C<"INPROGRESS">, C<"FAILED">, C<"COMPLETED">, C<"DELETED"> | ||
| 210 | =head2 TrainingDataSourceId => Str | ||
| 211 | |||
| 212 | The ID of the training C<DataSource>. | ||
| 213 | |||
| 214 | |||
| 215 | =head2 TrainingParameters => L<Paws::MachineLearning::TrainingParameters> | ||
| 216 | |||
| 217 | A list of the training parameters in the C<MLModel>. The list is | ||
| 218 | implemented as a map of key-value pairs. | ||
| 219 | |||
| 220 | The following is the current set of training parameters: | ||
| 221 | |||
| 222 | =over | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | C<sgd.maxMLModelSizeInBytes> - The maximum allowed size of the model. | ||
| 227 | Depending on the input data, the size of the model might affect its | ||
| 228 | performance. | ||
| 229 | |||
| 230 | The value is an integer that ranges from C<100000> to C<2147483648>. | ||
| 231 | The default value is C<33554432>. | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | C<sgd.maxPasses> - The number of times that the training process | ||
| 236 | traverses the observations to build the C<MLModel>. The value is an | ||
| 237 | integer that ranges from C<1> to C<10000>. The default value is C<10>. | ||
| 238 | |||
| 239 | =item * | ||
| 240 | |||
| 241 | C<sgd.shuffleType> - Whether Amazon ML shuffles the training data. | ||
| 242 | Shuffling data improves a model's ability to find the optimal solution | ||
| 243 | for a variety of data types. The valid values are C<auto> and C<none>. | ||
| 244 | The default value is C<none>. We strongly recommend that you shuffle | ||
| 245 | your data. | ||
| 246 | |||
| 247 | =item * | ||
| 248 | |||
| 249 | C<sgd.l1RegularizationAmount> - The coefficient regularization L1 norm. | ||
| 250 | It controls overfitting the data by penalizing large coefficients. This | ||
| 251 | tends to drive coefficients to zero, resulting in a sparse feature set. | ||
| 252 | If you use this parameter, start by specifying a small value, such as | ||
| 253 | C<1.0E-08>. | ||
| 254 | |||
| 255 | The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The | ||
| 256 | default is to not use L1 normalization. This parameter can't be used | ||
| 257 | when C<L2> is specified. Use this parameter sparingly. | ||
| 258 | |||
| 259 | =item * | ||
| 260 | |||
| 261 | C<sgd.l2RegularizationAmount> - The coefficient regularization L2 norm. | ||
| 262 | It controls overfitting the data by penalizing large coefficients. This | ||
| 263 | tends to drive coefficients to small, nonzero values. If you use this | ||
| 264 | parameter, start by specifying a small value, such as C<1.0E-08>. | ||
| 265 | |||
| 266 | The value is a double that ranges from C<0> to C<MAX_DOUBLE>. The | ||
| 267 | default is to not use L2 normalization. This parameter can't be used | ||
| 268 | when C<L1> is specified. Use this parameter sparingly. | ||
| 269 | |||
| 270 | =back | ||
| 271 | |||
| 272 | |||
| 273 | |||
| 274 | =head2 _request_id => Str | ||
| 275 | |||
| 276 | |||
| 277 | =cut | ||
| 278 | |||
| 279 | 1; |