« blib/lib/Paws/MachineLearning/GetMLModelOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/PerformanceMetricsProperties.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MachineLearning::PerformanceMetrics; | ||
| 3 | use Moose; | ||
| 4 | has Properties => (is => 'ro', isa => 'Paws::MachineLearning::PerformanceMetricsProperties'); | ||
| 5 | |||
| 6 | 1; | ||
| 7 | |||
| 8 | ### main pod documentation begin ### | ||
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Paws::MachineLearning::PerformanceMetrics | ||
| 13 | |||
| 14 | =head1 USAGE | ||
| 15 | |||
| 16 | This class represents one of two things: | ||
| 17 | |||
| 18 | =head3 Arguments in a call to a service | ||
| 19 | |||
| 20 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 21 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 22 | |||
| 23 | As an example, if Att1 is expected to be a Paws::MachineLearning::PerformanceMetrics object: | ||
| 24 | |||
| 25 | $service_obj->Method(Att1 => { Properties => $value, ..., Properties => $value }); | ||
| 26 | |||
| 27 | =head3 Results returned from an API call | ||
| 28 | |||
| 29 | Use accessors for each attribute. If Att1 is expected to be an Paws::MachineLearning::PerformanceMetrics object: | ||
| 30 | |||
| 31 | $result = $service_obj->Method(...); | ||
| 32 | $result->Att1->Properties | ||
| 33 | |||
| 34 | =head1 DESCRIPTION | ||
| 35 | |||
| 36 | Measurements of how well the C<MLModel> performed on known | ||
| 37 | observations. One of the following metrics is returned, based on the | ||
| 38 | type of the C<MLModel>: | ||
| 39 | |||
| 40 | =over | ||
| 41 | |||
| 42 | =item * | ||
| 43 | |||
| 44 | BinaryAUC: The binary C<MLModel> uses the Area Under the Curve (AUC) | ||
| 45 | technique to measure performance. | ||
| 46 | |||
| 47 | =item * | ||
| 48 | |||
| 49 | RegressionRMSE: The regression C<MLModel> uses the Root Mean Square | ||
| 50 | Error (RMSE) technique to measure performance. RMSE measures the | ||
| 51 | difference between predicted and actual values for a single variable. | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | MulticlassAvgFScore: The multiclass C<MLModel> uses the F1 score | ||
| 56 | technique to measure performance. | ||
| 57 | |||
| 58 | =back | ||
| 59 | |||
| 60 | For more information about performance metrics, please see the Amazon | ||
| 61 | Machine Learning Developer Guide | ||
| 62 | (https://docs.aws.amazon.com/machine-learning/latest/dg). | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Properties => L<Paws::MachineLearning::PerformanceMetricsProperties> | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head1 SEE ALSO | ||
| 74 | |||
| 75 | This class forms part of L<Paws>, describing an object used in L<Paws::MachineLearning> | ||
| 76 | |||
| 77 | =head1 BUGS and CONTRIBUTIONS | ||
| 78 | |||
| 79 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 80 | |||
| 81 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 82 | |||
| 83 | =cut | ||
| 84 |