File Coverage

blib/lib/Paws/MachineLearning/Prediction.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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