« blib/lib/Paws/SageMaker/DescribeHyperParameterTuningJob.pm
↑ Summary
blib/lib/Paws/SageMaker/DescribeImage.pm »
| 1 | |||
| 2 | package Paws::SageMaker::DescribeHyperParameterTuningJobResponse; | ||
| 3 | use Moose; | ||
| 4 | has BestTrainingJob => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTrainingJobSummary'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 7 | has HyperParameterTuningEndTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has HyperParameterTuningJobArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has HyperParameterTuningJobConfig => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTuningJobConfig', required => 1); | ||
| 10 | has HyperParameterTuningJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has HyperParameterTuningJobStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has LastModifiedTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has ObjectiveStatusCounters => (is => 'ro', isa => 'Paws::SageMaker::ObjectiveStatusCounters', required => 1); | ||
| 14 | has OverallBestTrainingJob => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTrainingJobSummary'); | ||
| 15 | has TrainingJobDefinition => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTrainingJobDefinition'); | ||
| 16 | has TrainingJobDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::HyperParameterTrainingJobDefinition]'); | ||
| 17 | has TrainingJobStatusCounters => (is => 'ro', isa => 'Paws::SageMaker::TrainingJobStatusCounters', required => 1); | ||
| 18 | has WarmStartConfig => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTuningJobWarmStartConfig'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::SageMaker::DescribeHyperParameterTuningJobResponse | ||
| 27 | |||
| 28 | =head1 ATTRIBUTES | ||
| 29 | |||
| 30 | |||
| 31 | =head2 BestTrainingJob => L<Paws::SageMaker::HyperParameterTrainingJobSummary> | ||
| 32 | |||
| 33 | A TrainingJobSummary object that describes the training job that | ||
| 34 | completed with the best current HyperParameterTuningJobObjective. | ||
| 35 | |||
| 36 | |||
| 37 | =head2 B<REQUIRED> CreationTime => Str | ||
| 38 | |||
| 39 | The date and time that the tuning job started. | ||
| 40 | |||
| 41 | |||
| 42 | =head2 FailureReason => Str | ||
| 43 | |||
| 44 | If the tuning job failed, the reason it failed. | ||
| 45 | |||
| 46 | |||
| 47 | =head2 HyperParameterTuningEndTime => Str | ||
| 48 | |||
| 49 | The date and time that the tuning job ended. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> HyperParameterTuningJobArn => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) of the tuning job. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> HyperParameterTuningJobConfig => L<Paws::SageMaker::HyperParameterTuningJobConfig> | ||
| 58 | |||
| 59 | The HyperParameterTuningJobConfig object that specifies the | ||
| 60 | configuration of the tuning job. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> HyperParameterTuningJobName => Str | ||
| 64 | |||
| 65 | The name of the tuning job. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> HyperParameterTuningJobStatus => Str | ||
| 69 | |||
| 70 | The status of the tuning job: InProgress, Completed, Failed, Stopping, | ||
| 71 | or Stopped. | ||
| 72 | |||
| 73 | Valid values are: C<"Completed">, C<"InProgress">, C<"Failed">, C<"Stopped">, C<"Stopping"> | ||
| 74 | =head2 LastModifiedTime => Str | ||
| 75 | |||
| 76 | The date and time that the status of the tuning job was modified. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> ObjectiveStatusCounters => L<Paws::SageMaker::ObjectiveStatusCounters> | ||
| 80 | |||
| 81 | The ObjectiveStatusCounters object that specifies the number of | ||
| 82 | training jobs, categorized by the status of their final objective | ||
| 83 | metric, that this tuning job launched. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 OverallBestTrainingJob => L<Paws::SageMaker::HyperParameterTrainingJobSummary> | ||
| 87 | |||
| 88 | If the hyperparameter tuning job is an warm start tuning job with a | ||
| 89 | C<WarmStartType> of C<IDENTICAL_DATA_AND_ALGORITHM>, this is the | ||
| 90 | TrainingJobSummary for the training job with the best objective metric | ||
| 91 | value of all training jobs launched by this tuning job and all parent | ||
| 92 | jobs specified for the warm start tuning job. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 TrainingJobDefinition => L<Paws::SageMaker::HyperParameterTrainingJobDefinition> | ||
| 96 | |||
| 97 | The HyperParameterTrainingJobDefinition object that specifies the | ||
| 98 | definition of the training jobs that this tuning job launches. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 TrainingJobDefinitions => ArrayRef[L<Paws::SageMaker::HyperParameterTrainingJobDefinition>] | ||
| 102 | |||
| 103 | A list of the HyperParameterTrainingJobDefinition objects launched for | ||
| 104 | this tuning job. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> TrainingJobStatusCounters => L<Paws::SageMaker::TrainingJobStatusCounters> | ||
| 108 | |||
| 109 | The TrainingJobStatusCounters object that specifies the number of | ||
| 110 | training jobs, categorized by status, that this tuning job launched. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 WarmStartConfig => L<Paws::SageMaker::HyperParameterTuningJobWarmStartConfig> | ||
| 114 | |||
| 115 | The configuration for starting the hyperparameter parameter tuning job | ||
| 116 | using one or more previous tuning jobs as a starting point. The results | ||
| 117 | of previous tuning jobs are used to inform which combinations of | ||
| 118 | hyperparameters to search over in the new tuning job. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 _request_id => Str | ||
| 122 | |||
| 123 | |||
| 124 | =cut | ||
| 125 | |||
| 126 | 1; |