blib/lib/Paws/SageMaker/S3DataSource.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::SageMaker::S3DataSource;
3 use Moose;
4 has AttributeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has S3DataDistributionType => (is => 'ro', isa => 'Str');
6 has S3DataType => (is => 'ro', isa => 'Str', required => 1);
7 has S3Uri => (is => 'ro', isa => 'Str', required => 1);
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::SageMaker::S3DataSource
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::SageMaker::S3DataSource object:
27  
28 $service_obj->Method(Att1 => { AttributeNames => $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::SageMaker::S3DataSource object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->AttributeNames
36  
37 =head1 DESCRIPTION
38  
39 Describes the S3 data source.
40  
41 =head1 ATTRIBUTES
42  
43  
44 =head2 AttributeNames => ArrayRef[Str|Undef]
45  
46 A list of one or more attribute names to use that are found in a
47 specified augmented manifest file.
48  
49  
50 =head2 S3DataDistributionType => Str
51  
52 If you want Amazon SageMaker to replicate the entire dataset on each ML
53 compute instance that is launched for model training, specify
54 C<FullyReplicated>.
55  
56 If you want Amazon SageMaker to replicate a subset of data on each ML
57 compute instance that is launched for model training, specify
58 C<ShardedByS3Key>. If there are I<n> ML compute instances launched for
59 a training job, each instance gets approximately 1/I<n> of the number
60 of S3 objects. In this case, model training on each machine uses only
61 the subset of training data.
62  
63 Don't choose more ML compute instances for training than available S3
64 objects. If you do, some nodes won't get any data and you will pay for
65 nodes that aren't getting any training data. This applies in both File
66 and Pipe modes. Keep this in mind when developing algorithms.
67  
68 In distributed training, where you use multiple ML compute EC2
69 instances, you might choose C<ShardedByS3Key>. If the algorithm
70 requires copying training data to the ML storage volume (when
71 C<TrainingInputMode> is set to C<File>), this copies 1/I<n> of the
72 number of objects.
73  
74  
75 =head2 B<REQUIRED> S3DataType => Str
76  
77 If you choose C<S3Prefix>, C<S3Uri> identifies a key name prefix.
78 Amazon SageMaker uses all objects that match the specified key name
79 prefix for model training.
80  
81 If you choose C<ManifestFile>, C<S3Uri> identifies an object that is a
82 manifest file containing a list of object keys that you want Amazon
83 SageMaker to use for model training.
84  
85 If you choose C<AugmentedManifestFile>, S3Uri identifies an object that
86 is an augmented manifest file in JSON lines format. This file contains
87 the data you want to use for model training. C<AugmentedManifestFile>
88 can only be used if the Channel's input mode is C<Pipe>.
89  
90  
91 =head2 B<REQUIRED> S3Uri => Str
92  
93 Depending on the value specified for the C<S3DataType>, identifies
94 either a key name prefix or a manifest. For example:
95  
96 =over
97  
98 =item *
99  
100 A key name prefix might look like this:
101 C<s3://bucketname/exampleprefix>
102  
103 =item *
104  
105 A manifest might look like this: C<s3://bucketname/example.manifest>
106  
107 A manifest is an S3 object which is a JSON file consisting of an array
108 of elements. The first element is a prefix which is followed by one or
109 more suffixes. SageMaker appends the suffix elements to the prefix to
110 get a full set of C<S3Uri>. Note that the prefix must be a valid
111 non-empty C<S3Uri> that precludes users from specifying a manifest
112 whose individual C<S3Uri> is sourced from different S3 buckets.
113  
114 The following code example shows a valid manifest format:
115  
116 C<[ {"prefix": "s3://customer_bucket/some/prefix/"},>
117  
118 C<"relative/path/to/custdata-1",>
119  
120 C<"relative/path/custdata-2",>
121  
122 C<...>
123  
124 C<"relative/path/custdata-N">
125  
126 C<]>
127  
128 This JSON is equivalent to the following C<S3Uri> list:
129  
130 C<s3://customer_bucket/some/prefix/relative/path/to/custdata-1>
131  
132 C<s3://customer_bucket/some/prefix/relative/path/custdata-2>
133  
134 C<...>
135  
136 C<s3://customer_bucket/some/prefix/relative/path/custdata-N>
137  
138 The complete set of C<S3Uri> in this manifest is the input data for the
139 channel for this data source. The object that each C<S3Uri> points to
140 must be readable by the IAM role that Amazon SageMaker uses to perform
141 tasks on your behalf.
142  
143 =back
144  
145  
146  
147  
148 =head1 SEE ALSO
149  
150 This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker>
151  
152 =head1 BUGS and CONTRIBUTIONS
153  
154 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
155  
156 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
157  
158 =cut
159