« blib/lib/Paws/SageMaker/HyperParameterTrainingJobSummary.pm
↑ Summary
blib/lib/Paws/SageMaker/HyperParameterTuningJobObjective.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::HyperParameterTuningJobConfig; | ||
| 3 | use Moose; | ||
| 4 | has HyperParameterTuningJobObjective => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTuningJobObjective'); | ||
| 5 | has ParameterRanges => (is => 'ro', isa => 'Paws::SageMaker::ParameterRanges'); | ||
| 6 | has ResourceLimits => (is => 'ro', isa => 'Paws::SageMaker::ResourceLimits', required => 1); | ||
| 7 | has Strategy => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has TrainingJobEarlyStoppingType => (is => 'ro', isa => 'Str'); | ||
| 9 | has TuningJobCompletionCriteria => (is => 'ro', isa => 'Paws::SageMaker::TuningJobCompletionCriteria'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SageMaker::HyperParameterTuningJobConfig | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::SageMaker::HyperParameterTuningJobConfig object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { HyperParameterTuningJobObjective => $value, ..., TuningJobCompletionCriteria => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::HyperParameterTuningJobConfig object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->HyperParameterTuningJobObjective | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Configures a hyperparameter tuning job. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 HyperParameterTuningJobObjective => L<Paws::SageMaker::HyperParameterTuningJobObjective> | ||
| 47 | |||
| 48 | The HyperParameterTuningJobObjective object that specifies the | ||
| 49 | objective metric for this tuning job. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 ParameterRanges => L<Paws::SageMaker::ParameterRanges> | ||
| 53 | |||
| 54 | The ParameterRanges object that specifies the ranges of hyperparameters | ||
| 55 | that this tuning job searches. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> ResourceLimits => L<Paws::SageMaker::ResourceLimits> | ||
| 59 | |||
| 60 | The ResourceLimits object that specifies the maximum number of training | ||
| 61 | jobs and parallel training jobs for this tuning job. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Strategy => Str | ||
| 65 | |||
| 66 | Specifies how hyperparameter tuning chooses the combinations of | ||
| 67 | hyperparameter values to use for the training job it launches. To use | ||
| 68 | the Bayesian search strategy, set this to C<Bayesian>. To randomly | ||
| 69 | search, set it to C<Random>. For information about search strategies, | ||
| 70 | see How Hyperparameter Tuning Works | ||
| 71 | (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html). | ||
| 72 | |||
| 73 | |||
| 74 | =head2 TrainingJobEarlyStoppingType => Str | ||
| 75 | |||
| 76 | Specifies whether to use early stopping for training jobs launched by | ||
| 77 | the hyperparameter tuning job. This can be one of the following values | ||
| 78 | (the default value is C<OFF>): | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item OFF | ||
| 83 | |||
| 84 | Training jobs launched by the hyperparameter tuning job do not use | ||
| 85 | early stopping. | ||
| 86 | |||
| 87 | =item AUTO | ||
| 88 | |||
| 89 | Amazon SageMaker stops training jobs launched by the hyperparameter | ||
| 90 | tuning job when they are unlikely to perform better than previously | ||
| 91 | completed training jobs. For more information, see Stop Training Jobs | ||
| 92 | Early | ||
| 93 | (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 TuningJobCompletionCriteria => L<Paws::SageMaker::TuningJobCompletionCriteria> | ||
| 100 | |||
| 101 | The tuning job's completion criteria. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |