« blib/lib/Paws/MachineLearning/DetailsMap.pm
↑ Summary
blib/lib/Paws/MachineLearning/GetBatchPrediction.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MachineLearning::Evaluation; | ||
| 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 EvaluationDataSourceId => (is => 'ro', isa => 'Str'); | ||
| 8 | has EvaluationId => (is => 'ro', isa => 'Str'); | ||
| 9 | has FinishedAt => (is => 'ro', isa => 'Str'); | ||
| 10 | has InputDataLocationS3 => (is => 'ro', isa => 'Str'); | ||
| 11 | has LastUpdatedAt => (is => 'ro', isa => 'Str'); | ||
| 12 | has Message => (is => 'ro', isa => 'Str'); | ||
| 13 | has MLModelId => (is => 'ro', isa => 'Str'); | ||
| 14 | has Name => (is => 'ro', isa => 'Str'); | ||
| 15 | has PerformanceMetrics => (is => 'ro', isa => 'Paws::MachineLearning::PerformanceMetrics'); | ||
| 16 | has StartedAt => (is => 'ro', isa => 'Str'); | ||
| 17 | has Status => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::MachineLearning::Evaluation | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::MachineLearning::Evaluation object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { ComputeTime => $value, ..., Status => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::MachineLearning::Evaluation object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->ComputeTime | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Represents the output of C<GetEvaluation> operation. | ||
| 50 | |||
| 51 | The content consists of the detailed metadata and data file information | ||
| 52 | and the current status of the C<Evaluation>. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ComputeTime => Int | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 CreatedAt => Str | ||
| 63 | |||
| 64 | The time that the C<Evaluation> was created. The time is expressed in | ||
| 65 | epoch time. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CreatedByIamUser => Str | ||
| 69 | |||
| 70 | The AWS user account that invoked the evaluation. The account type can | ||
| 71 | be either an AWS root account or an AWS Identity and Access Management | ||
| 72 | (IAM) user account. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 EvaluationDataSourceId => Str | ||
| 76 | |||
| 77 | The ID of the C<DataSource> that is used to evaluate the C<MLModel>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 EvaluationId => Str | ||
| 81 | |||
| 82 | The ID that is assigned to the C<Evaluation> at creation. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 FinishedAt => Str | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 InputDataLocationS3 => Str | ||
| 91 | |||
| 92 | The location and name of the data in Amazon Simple Storage Server | ||
| 93 | (Amazon S3) that is used in the evaluation. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 LastUpdatedAt => Str | ||
| 97 | |||
| 98 | The time of the most recent edit to the C<Evaluation>. The time is | ||
| 99 | expressed in epoch time. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Message => Str | ||
| 103 | |||
| 104 | A description of the most recent details about evaluating the | ||
| 105 | C<MLModel>. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 MLModelId => Str | ||
| 109 | |||
| 110 | The ID of the C<MLModel> that is the focus of the evaluation. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 Name => Str | ||
| 114 | |||
| 115 | A user-supplied name or description of the C<Evaluation>. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 PerformanceMetrics => L<Paws::MachineLearning::PerformanceMetrics> | ||
| 119 | |||
| 120 | Measurements of how well the C<MLModel> performed, using observations | ||
| 121 | referenced by the C<DataSource>. One of the following metrics is | ||
| 122 | returned, based on the type of the C<MLModel>: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | BinaryAUC: A binary C<MLModel> uses the Area Under the Curve (AUC) | ||
| 129 | technique to measure performance. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | RegressionRMSE: A regression C<MLModel> uses the Root Mean Square Error | ||
| 134 | (RMSE) technique to measure performance. RMSE measures the difference | ||
| 135 | between predicted and actual values for a single variable. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | MulticlassAvgFScore: A multiclass C<MLModel> uses the F1 score | ||
| 140 | technique to measure performance. | ||
| 141 | |||
| 142 | =back | ||
| 143 | |||
| 144 | For more information about performance metrics, please see the Amazon | ||
| 145 | Machine Learning Developer Guide | ||
| 146 | (https://docs.aws.amazon.com/machine-learning/latest/dg). | ||
| 147 | |||
| 148 | |||
| 149 | =head2 StartedAt => Str | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 Status => Str | ||
| 155 | |||
| 156 | The status of the evaluation. This element can have one of the | ||
| 157 | following values: | ||
| 158 | |||
| 159 | =over | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<PENDING> - Amazon Machine Learning (Amazon ML) submitted a request to | ||
| 164 | evaluate an C<MLModel>. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | C<INPROGRESS> - The evaluation is underway. | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | C<FAILED> - The request to evaluate an C<MLModel> did not run to | ||
| 173 | completion. It is not usable. | ||
| 174 | |||
| 175 | =item * | ||
| 176 | |||
| 177 | C<COMPLETED> - The evaluation process completed successfully. | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | C<DELETED> - The C<Evaluation> is marked as deleted. It is not usable. | ||
| 182 | |||
| 183 | =back | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head1 SEE ALSO | ||
| 189 | |||
| 190 | This class forms part of L<Paws>, describing an object used in L<Paws::MachineLearning> | ||
| 191 | |||
| 192 | =head1 BUGS and CONTRIBUTIONS | ||
| 193 | |||
| 194 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 195 | |||
| 196 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 197 | |||
| 198 | =cut | ||
| 199 |