« blib/lib/Paws/MachineLearning/PredictOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/RDSDataSpec.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MachineLearning::Prediction; | ||
| 3 | use Moose; | ||
| 4 | has Details => (is => 'ro', isa => 'Paws::MachineLearning::DetailsMap', request_name => 'details', traits => ['NameInRequest']); | ||
| 5 | has PredictedLabel => (is => 'ro', isa => 'Str', request_name => 'predictedLabel', traits => ['NameInRequest']); | ||
| 6 | has PredictedScores => (is => 'ro', isa => 'Paws::MachineLearning::ScoreValuePerLabelMap', request_name => 'predictedScores', traits => ['NameInRequest']); | ||
| 7 | has PredictedValue => (is => 'ro', isa => 'Num', request_name => 'predictedValue', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::MachineLearning::Prediction | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::MachineLearning::Prediction object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Details => $value, ..., PredictedValue => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::MachineLearning::Prediction object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Details | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | The output from a C<Predict> operation: | ||
| 40 | |||
| 41 | =over | ||
| 42 | |||
| 43 | =item * | ||
| 44 | |||
| 45 | C<Details> - Contains the following attributes: | ||
| 46 | C<DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | | ||
| 47 | MULTICLASS> C<DetailsAttributes.ALGORITHM - SGD> | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | C<PredictedLabel> - Present for either a C<BINARY> or C<MULTICLASS> | ||
| 52 | C<MLModel> request. | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | C<PredictedScores> - Contains the raw classification score | ||
| 57 | corresponding to each label. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | C<PredictedValue> - Present for a C<REGRESSION> C<MLModel> request. | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Details => L<Paws::MachineLearning::DetailsMap> | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 PredictedLabel => Str | ||
| 75 | |||
| 76 | The prediction label for either a C<BINARY> or C<MULTICLASS> | ||
| 77 | C<MLModel>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 PredictedScores => L<Paws::MachineLearning::ScoreValuePerLabelMap> | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 PredictedValue => Num | ||
| 86 | |||
| 87 | The prediction value for C<REGRESSION> C<MLModel>. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, describing an object used in L<Paws::MachineLearning> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |