« blib/lib/Paws/SageMaker/TrainingJobSummary.pm
↑ Summary
blib/lib/Paws/SageMaker/TransformDataSource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::TrainingSpecification; | ||
| 3 | use Moose; | ||
| 4 | has MetricDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::MetricDefinition]'); | ||
| 5 | has SupportedHyperParameters => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::HyperParameterSpecification]'); | ||
| 6 | has SupportedTrainingInstanceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | has SupportedTuningJobObjectiveMetrics => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::HyperParameterTuningJobObjective]'); | ||
| 8 | has SupportsDistributedTraining => (is => 'ro', isa => 'Bool'); | ||
| 9 | has TrainingChannels => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::ChannelSpecification]', required => 1); | ||
| 10 | has TrainingImage => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has TrainingImageDigest => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SageMaker::TrainingSpecification | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::SageMaker::TrainingSpecification object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { MetricDefinitions => $value, ..., TrainingImageDigest => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::TrainingSpecification object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->MetricDefinitions | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Defines how the algorithm is used for a training job. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 MetricDefinitions => ArrayRef[L<Paws::SageMaker::MetricDefinition>] | ||
| 49 | |||
| 50 | A list of C<MetricDefinition> objects, which are used for parsing | ||
| 51 | metrics generated by the algorithm. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 SupportedHyperParameters => ArrayRef[L<Paws::SageMaker::HyperParameterSpecification>] | ||
| 55 | |||
| 56 | A list of the C<HyperParameterSpecification> objects, that define the | ||
| 57 | supported hyperparameters. This is required if the algorithm supports | ||
| 58 | automatic model tuning.E<gt> | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> SupportedTrainingInstanceTypes => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | A list of the instance types that this algorithm can use for training. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 SupportedTuningJobObjectiveMetrics => ArrayRef[L<Paws::SageMaker::HyperParameterTuningJobObjective>] | ||
| 67 | |||
| 68 | A list of the metrics that the algorithm emits that can be used as the | ||
| 69 | objective metric in a hyperparameter tuning job. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 SupportsDistributedTraining => Bool | ||
| 73 | |||
| 74 | Indicates whether the algorithm supports distributed training. If set | ||
| 75 | to false, buyers can't request more than one instance during training. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> TrainingChannels => ArrayRef[L<Paws::SageMaker::ChannelSpecification>] | ||
| 79 | |||
| 80 | A list of C<ChannelSpecification> objects, which specify the input | ||
| 81 | sources to be used by the algorithm. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> TrainingImage => Str | ||
| 85 | |||
| 86 | The Amazon ECR registry path of the Docker image that contains the | ||
| 87 | training algorithm. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 TrainingImageDigest => Str | ||
| 91 | |||
| 92 | An MD5 hash of the training algorithm that identifies the Docker image | ||
| 93 | used for training. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |