« blib/lib/Paws/SageMaker/HyperParameterTrainingJobDefinition.pm
↑ Summary
blib/lib/Paws/SageMaker/HyperParameterTuningJobConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::HyperParameterTrainingJobSummary; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 6 | has FinalHyperParameterTuningJobObjectiveMetric => (is => 'ro', isa => 'Paws::SageMaker::FinalHyperParameterTuningJobObjectiveMetric'); | ||
| 7 | has ObjectiveStatus => (is => 'ro', isa => 'Str'); | ||
| 8 | has TrainingEndTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has TrainingJobArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has TrainingJobDefinitionName => (is => 'ro', isa => 'Str'); | ||
| 11 | has TrainingJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has TrainingJobStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has TrainingStartTime => (is => 'ro', isa => 'Str'); | ||
| 14 | has TunedHyperParameters => (is => 'ro', isa => 'Paws::SageMaker::HyperParameters', required => 1); | ||
| 15 | has TuningJobName => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::SageMaker::HyperParameterTrainingJobSummary | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::SageMaker::HyperParameterTrainingJobSummary object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { CreationTime => $value, ..., TuningJobName => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::HyperParameterTrainingJobSummary object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->CreationTime | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Specifies summary information about a training job. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> CreationTime => Str | ||
| 53 | |||
| 54 | The date and time that the training job was created. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 FailureReason => Str | ||
| 58 | |||
| 59 | The reason that the training job failed. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 FinalHyperParameterTuningJobObjectiveMetric => L<Paws::SageMaker::FinalHyperParameterTuningJobObjectiveMetric> | ||
| 63 | |||
| 64 | The FinalHyperParameterTuningJobObjectiveMetric object that specifies | ||
| 65 | the value of the objective metric of the tuning job that launched this | ||
| 66 | training job. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ObjectiveStatus => Str | ||
| 70 | |||
| 71 | The status of the objective metric for the training job: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Succeeded: The final objective metric for the training job was | ||
| 78 | evaluated by the hyperparameter tuning job and used in the | ||
| 79 | hyperparameter tuning process. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | Pending: The training job is in progress and evaluation of its final | ||
| 88 | objective metric is pending. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | =over | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | Failed: The final objective metric for the training job was not | ||
| 97 | evaluated, and was not used in the hyperparameter tuning process. This | ||
| 98 | typically occurs when the training job failed or did not emit an | ||
| 99 | objective metric. | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 TrainingEndTime => Str | ||
| 106 | |||
| 107 | Specifies the time when the training job ends on training instances. | ||
| 108 | You are billed for the time interval between the value of | ||
| 109 | C<TrainingStartTime> and this time. For successful jobs and stopped | ||
| 110 | jobs, this is the time after model artifacts are uploaded. For failed | ||
| 111 | jobs, this is the time when Amazon SageMaker detects a job failure. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> TrainingJobArn => Str | ||
| 115 | |||
| 116 | The Amazon Resource Name (ARN) of the training job. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 TrainingJobDefinitionName => Str | ||
| 120 | |||
| 121 | The training job definition name. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> TrainingJobName => Str | ||
| 125 | |||
| 126 | The name of the training job. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> TrainingJobStatus => Str | ||
| 130 | |||
| 131 | The status of the training job. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 TrainingStartTime => Str | ||
| 135 | |||
| 136 | The date and time that the training job started. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> TunedHyperParameters => L<Paws::SageMaker::HyperParameters> | ||
| 140 | |||
| 141 | A list of the hyperparameters for which you specified ranges to search. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 TuningJobName => Str | ||
| 145 | |||
| 146 | The HyperParameter tuning job that launched the training job. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |