blib/lib/Paws/SageMaker/HyperParameterAlgorithmSpecification.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::HyperParameterAlgorithmSpecification;
3 use Moose;
4 has AlgorithmName => (is => 'ro', isa => 'Str');
5 has MetricDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::MetricDefinition]');
6 has TrainingImage => (is => 'ro', isa => 'Str');
7 has TrainingInputMode => (is => 'ro', isa => 'Str', required => 1);
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::SageMaker::HyperParameterAlgorithmSpecification
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::HyperParameterAlgorithmSpecification object:
27  
28 $service_obj->Method(Att1 => { AlgorithmName => $value, ..., TrainingInputMode => $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::HyperParameterAlgorithmSpecification object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->AlgorithmName
36  
37 =head1 DESCRIPTION
38  
39 Specifies which training algorithm to use for training jobs that a
40 hyperparameter tuning job launches and the metrics to monitor.
41  
42 =head1 ATTRIBUTES
43  
44  
45 =head2 AlgorithmName => Str
46  
47 The name of the resource algorithm to use for the hyperparameter tuning
48 job. If you specify a value for this parameter, do not specify a value
49 for C<TrainingImage>.
50  
51  
52 =head2 MetricDefinitions => ArrayRef[L<Paws::SageMaker::MetricDefinition>]
53  
54 An array of MetricDefinition objects that specify the metrics that the
55 algorithm emits.
56  
57  
58 =head2 TrainingImage => Str
59  
60 The registry path of the Docker image that contains the training
61 algorithm. For information about Docker registry paths for built-in
62 algorithms, see Algorithms Provided by Amazon SageMaker: Common
63 Parameters
64 (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html).
65 Amazon SageMaker supports both C<registry/repository[:tag]> and
66 C<registry/repository[@digest]> image path formats. For more
67 information, see Using Your Own Algorithms with Amazon SageMaker
68 (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html).
69  
70  
71 =head2 B<REQUIRED> TrainingInputMode => Str
72  
73 The input mode that the algorithm supports: File or Pipe. In File input
74 mode, Amazon SageMaker downloads the training data from Amazon S3 to
75 the storage volume that is attached to the training instance and mounts
76 the directory to the Docker volume for the training container. In Pipe
77 input mode, Amazon SageMaker streams data directly from Amazon S3 to
78 the container.
79  
80 If you specify File mode, make sure that you provision the storage
81 volume that is attached to the training instance with enough capacity
82 to accommodate the training data downloaded from Amazon S3, the model
83 artifacts, and intermediate information.
84  
85 For more information about input modes, see Algorithms
86 (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).
87  
88  
89  
90 =head1 SEE ALSO
91  
92 This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker>
93  
94 =head1 BUGS and CONTRIBUTIONS
95  
96 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
97  
98 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
99  
100 =cut
101