« blib/lib/Paws/MachineLearning/GetEvaluation.pm
↑ Summary
blib/lib/Paws/MachineLearning/GetMLModel.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::GetEvaluationOutput; | ||
| 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 LogUri => (is => 'ro', isa => 'Str'); | ||
| 13 | has Message => (is => 'ro', isa => 'Str'); | ||
| 14 | has MLModelId => (is => 'ro', isa => 'Str'); | ||
| 15 | has Name => (is => 'ro', isa => 'Str'); | ||
| 16 | has PerformanceMetrics => (is => 'ro', isa => 'Paws::MachineLearning::PerformanceMetrics'); | ||
| 17 | has StartedAt => (is => 'ro', isa => 'Str'); | ||
| 18 | has Status => (is => 'ro', isa => 'Str'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::MachineLearning::GetEvaluationOutput | ||
| 27 | |||
| 28 | =head1 ATTRIBUTES | ||
| 29 | |||
| 30 | |||
| 31 | =head2 ComputeTime => Int | ||
| 32 | |||
| 33 | The approximate CPU time in milliseconds that Amazon Machine Learning | ||
| 34 | spent processing the C<Evaluation>, normalized and scaled on | ||
| 35 | computation resources. C<ComputeTime> is only available if the | ||
| 36 | C<Evaluation> is in the C<COMPLETED> state. | ||
| 37 | |||
| 38 | |||
| 39 | =head2 CreatedAt => Str | ||
| 40 | |||
| 41 | The time that the C<Evaluation> was created. The time is expressed in | ||
| 42 | epoch time. | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CreatedByIamUser => Str | ||
| 46 | |||
| 47 | The AWS user account that invoked the evaluation. The account type can | ||
| 48 | be either an AWS root account or an AWS Identity and Access Management | ||
| 49 | (IAM) user account. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 EvaluationDataSourceId => Str | ||
| 53 | |||
| 54 | The C<DataSource> used for this evaluation. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 EvaluationId => Str | ||
| 58 | |||
| 59 | The evaluation ID which is same as the C<EvaluationId> in the request. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FinishedAt => Str | ||
| 63 | |||
| 64 | The epoch time when Amazon Machine Learning marked the C<Evaluation> as | ||
| 65 | C<COMPLETED> or C<FAILED>. C<FinishedAt> is only available when the | ||
| 66 | C<Evaluation> is in the C<COMPLETED> or C<FAILED> state. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 InputDataLocationS3 => Str | ||
| 70 | |||
| 71 | The location of the data file or directory in Amazon Simple Storage | ||
| 72 | Service (Amazon S3). | ||
| 73 | |||
| 74 | |||
| 75 | =head2 LastUpdatedAt => Str | ||
| 76 | |||
| 77 | The time of the most recent edit to the C<Evaluation>. The time is | ||
| 78 | expressed in epoch time. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 LogUri => Str | ||
| 82 | |||
| 83 | A link to the file that contains logs of the C<CreateEvaluation> | ||
| 84 | operation. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Message => Str | ||
| 88 | |||
| 89 | A description of the most recent details about evaluating the | ||
| 90 | C<MLModel>. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 MLModelId => Str | ||
| 94 | |||
| 95 | The ID of the C<MLModel> that was the focus of the evaluation. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Name => Str | ||
| 99 | |||
| 100 | A user-supplied name or description of the C<Evaluation>. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 PerformanceMetrics => L<Paws::MachineLearning::PerformanceMetrics> | ||
| 104 | |||
| 105 | Measurements of how well the C<MLModel> performed using observations | ||
| 106 | referenced by the C<DataSource>. One of the following metric is | ||
| 107 | returned based on the type of the C<MLModel>: | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | BinaryAUC: A binary C<MLModel> uses the Area Under the Curve (AUC) | ||
| 114 | technique to measure performance. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | RegressionRMSE: A regression C<MLModel> uses the Root Mean Square Error | ||
| 119 | (RMSE) technique to measure performance. RMSE measures the difference | ||
| 120 | between predicted and actual values for a single variable. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | MulticlassAvgFScore: A multiclass C<MLModel> uses the F1 score | ||
| 125 | technique to measure performance. | ||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | For more information about performance metrics, please see the Amazon | ||
| 130 | Machine Learning Developer Guide | ||
| 131 | (https://docs.aws.amazon.com/machine-learning/latest/dg). | ||
| 132 | |||
| 133 | |||
| 134 | =head2 StartedAt => Str | ||
| 135 | |||
| 136 | The epoch time when Amazon Machine Learning marked the C<Evaluation> as | ||
| 137 | C<INPROGRESS>. C<StartedAt> isn't available if the C<Evaluation> is in | ||
| 138 | the C<PENDING> state. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 Status => Str | ||
| 142 | |||
| 143 | The status of the evaluation. This element can have one of the | ||
| 144 | following values: | ||
| 145 | |||
| 146 | =over | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<PENDING> - Amazon Machine Language (Amazon ML) submitted a request to | ||
| 151 | evaluate an C<MLModel>. | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | C<INPROGRESS> - The evaluation is underway. | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | C<FAILED> - The request to evaluate an C<MLModel> did not run to | ||
| 160 | completion. It is not usable. | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | C<COMPLETED> - The evaluation process completed successfully. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | C<DELETED> - The C<Evaluation> is marked as deleted. It is not usable. | ||
| 169 | |||
| 170 | =back | ||
| 171 | |||
| 172 | |||
| 173 | Valid values are: C<"PENDING">, C<"INPROGRESS">, C<"FAILED">, C<"COMPLETED">, C<"DELETED"> | ||
| 174 | =head2 _request_id => Str | ||
| 175 | |||
| 176 | |||
| 177 | =cut | ||
| 178 | |||
| 179 | 1; |