blib/lib/Paws/Comprehend/DocumentClassifierInputDataConfig.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Comprehend::DocumentClassifierInputDataConfig;
3 use Moose;
4 has AugmentedManifests => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::AugmentedManifestsListItem]');
5 has DataFormat => (is => 'ro', isa => 'Str');
6 has LabelDelimiter => (is => 'ro', isa => 'Str');
7 has S3Uri => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::Comprehend::DocumentClassifierInputDataConfig
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::Comprehend::DocumentClassifierInputDataConfig object:
27  
28 $service_obj->Method(Att1 => { AugmentedManifests => $value, ..., S3Uri => $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::Comprehend::DocumentClassifierInputDataConfig object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->AugmentedManifests
36  
37 =head1 DESCRIPTION
38  
39 The input properties for training a document classifier.
40  
41 For more information on how the input file is formatted, see
42 how-document-classification-training-data.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 AugmentedManifests => ArrayRef[L<Paws::Comprehend::AugmentedManifestsListItem>]
48  
49 A list of augmented manifest files that provide training data for your
50 custom model. An augmented manifest file is a labeled dataset that is
51 produced by Amazon SageMaker Ground Truth.
52  
53 This parameter is required if you set C<DataFormat> to
54 C<AUGMENTED_MANIFEST>.
55  
56  
57 =head2 DataFormat => Str
58  
59 The format of your training data:
60  
61 =over
62  
63 =item *
64  
65 C<COMPREHEND_CSV>: A two-column CSV file, where labels are provided in
66 the first column, and documents are provided in the second. If you use
67 this value, you must provide the C<S3Uri> parameter in your request.
68  
69 =item *
70  
71 C<AUGMENTED_MANIFEST>: A labeled dataset that is produced by Amazon
72 SageMaker Ground Truth. This file is in JSON lines format. Each line is
73 a complete JSON object that contains a training document and its
74 associated labels.
75  
76 If you use this value, you must provide the C<AugmentedManifests>
77 parameter in your request.
78  
79 =back
80  
81 If you don't specify a value, Amazon Comprehend uses C<COMPREHEND_CSV>
82 as the default.
83  
84  
85 =head2 LabelDelimiter => Str
86  
87 Indicates the delimiter used to separate each label for training a
88 multi-label classifier. The default delimiter between labels is a pipe
89 (|). You can use a different character as a delimiter (if it's an
90 allowed character) by specifying it under Delimiter for labels. If the
91 training documents use a delimiter other than the default or the
92 delimiter you specify, the labels on that line will be combined to make
93 a single unique label, such as LABELLABELLABEL.
94  
95  
96 =head2 S3Uri => Str
97  
98 The Amazon S3 URI for the input data. The S3 bucket must be in the same
99 region as the API endpoint that you are calling. The URI can point to a
100 single input file or it can provide the prefix for a collection of
101 input files.
102  
103 For example, if you use the URI C<S3://bucketName/prefix>, if the
104 prefix is a single file, Amazon Comprehend uses that file as input. If
105 more than one file begins with the prefix, Amazon Comprehend uses all
106 of them as input.
107  
108 This parameter is required if you set C<DataFormat> to
109 C<COMPREHEND_CSV>.
110  
111  
112  
113 =head1 SEE ALSO
114  
115 This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend>
116  
117 =head1 BUGS and CONTRIBUTIONS
118  
119 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
120  
121 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
122  
123 =cut
124