« blib/lib/Paws/SageMaker/EndpointConfigSummary.pm
↑ Summary
blib/lib/Paws/SageMaker/EndpointSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::EndpointInput; | ||
| 3 | use Moose; | ||
| 4 | has EndpointName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EndTimeOffset => (is => 'ro', isa => 'Str'); | ||
| 6 | has FeaturesAttribute => (is => 'ro', isa => 'Str'); | ||
| 7 | has InferenceAttribute => (is => 'ro', isa => 'Str'); | ||
| 8 | has LocalPath => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ProbabilityAttribute => (is => 'ro', isa => 'Str'); | ||
| 10 | has ProbabilityThresholdAttribute => (is => 'ro', isa => 'Num'); | ||
| 11 | has S3DataDistributionType => (is => 'ro', isa => 'Str'); | ||
| 12 | has S3InputMode => (is => 'ro', isa => 'Str'); | ||
| 13 | has StartTimeOffset => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SageMaker::EndpointInput | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::SageMaker::EndpointInput object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { EndpointName => $value, ..., StartTimeOffset => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::EndpointInput object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->EndpointName | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Input object for the endpoint | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> EndpointName => Str | ||
| 51 | |||
| 52 | An endpoint in customer's account which has enabled | ||
| 53 | C<DataCaptureConfig> enabled. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 EndTimeOffset => Str | ||
| 57 | |||
| 58 | If specified, monitoring jobs substract this time from the end time. | ||
| 59 | For information about using offsets for scheduling monitoring jobs, see | ||
| 60 | Schedule Model Quality Monitoring Jobs | ||
| 61 | (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 FeaturesAttribute => Str | ||
| 65 | |||
| 66 | The attributes of the input data that are the input features. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 InferenceAttribute => Str | ||
| 70 | |||
| 71 | The attribute of the input data that represents the ground truth label. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> LocalPath => Str | ||
| 75 | |||
| 76 | Path to the filesystem where the endpoint data is available to the | ||
| 77 | container. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 ProbabilityAttribute => Str | ||
| 81 | |||
| 82 | In a classification problem, the attribute that represents the class | ||
| 83 | probability. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 ProbabilityThresholdAttribute => Num | ||
| 87 | |||
| 88 | The threshold for the class probability to be evaluated as a positive | ||
| 89 | result. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 S3DataDistributionType => Str | ||
| 93 | |||
| 94 | Whether input data distributed in Amazon S3 is fully replicated or | ||
| 95 | sharded by an S3 key. Defaults to C<FullyReplicated> | ||
| 96 | |||
| 97 | |||
| 98 | =head2 S3InputMode => Str | ||
| 99 | |||
| 100 | Whether the C<Pipe> or C<File> is used as the input mode for | ||
| 101 | transfering data for the monitoring job. C<Pipe> mode is recommended | ||
| 102 | for large datasets. C<File> mode is useful for small files that fit in | ||
| 103 | memory. Defaults to C<File>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 StartTimeOffset => Str | ||
| 107 | |||
| 108 | If specified, monitoring jobs substract this time from the start time. | ||
| 109 | For information about using offsets for scheduling monitoring jobs, see | ||
| 110 | Schedule Model Quality Monitoring Jobs | ||
| 111 | (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html). | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |