« blib/lib/Paws/SageMaker/HyperParameterSpecification.pm
↑ Summary
blib/lib/Paws/SageMaker/HyperParameterTrainingJobSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::HyperParameterTrainingJobDefinition; | ||
| 3 | use Moose; | ||
| 4 | has AlgorithmSpecification => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterAlgorithmSpecification', required => 1); | ||
| 5 | has CheckpointConfig => (is => 'ro', isa => 'Paws::SageMaker::CheckpointConfig'); | ||
| 6 | has DefinitionName => (is => 'ro', isa => 'Str'); | ||
| 7 | has EnableInterContainerTrafficEncryption => (is => 'ro', isa => 'Bool'); | ||
| 8 | has EnableManagedSpotTraining => (is => 'ro', isa => 'Bool'); | ||
| 9 | has EnableNetworkIsolation => (is => 'ro', isa => 'Bool'); | ||
| 10 | has HyperParameterRanges => (is => 'ro', isa => 'Paws::SageMaker::ParameterRanges'); | ||
| 11 | has InputDataConfig => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Channel]'); | ||
| 12 | has OutputDataConfig => (is => 'ro', isa => 'Paws::SageMaker::OutputDataConfig', required => 1); | ||
| 13 | has ResourceConfig => (is => 'ro', isa => 'Paws::SageMaker::ResourceConfig', required => 1); | ||
| 14 | has RetryStrategy => (is => 'ro', isa => 'Paws::SageMaker::RetryStrategy'); | ||
| 15 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has StaticHyperParameters => (is => 'ro', isa => 'Paws::SageMaker::HyperParameters'); | ||
| 17 | has StoppingCondition => (is => 'ro', isa => 'Paws::SageMaker::StoppingCondition', required => 1); | ||
| 18 | has TuningObjective => (is => 'ro', isa => 'Paws::SageMaker::HyperParameterTuningJobObjective'); | ||
| 19 | has VpcConfig => (is => 'ro', isa => 'Paws::SageMaker::VpcConfig'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::SageMaker::HyperParameterTrainingJobDefinition | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::SageMaker::HyperParameterTrainingJobDefinition object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { AlgorithmSpecification => $value, ..., VpcConfig => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::HyperParameterTrainingJobDefinition object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->AlgorithmSpecification | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | Defines the training jobs launched by a hyperparameter tuning job. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> AlgorithmSpecification => L<Paws::SageMaker::HyperParameterAlgorithmSpecification> | ||
| 57 | |||
| 58 | The HyperParameterAlgorithmSpecification object that specifies the | ||
| 59 | resource algorithm to use for the training jobs that the tuning job | ||
| 60 | launches. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CheckpointConfig => L<Paws::SageMaker::CheckpointConfig> | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DefinitionName => Str | ||
| 69 | |||
| 70 | The job definition name. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 EnableInterContainerTrafficEncryption => Bool | ||
| 74 | |||
| 75 | To encrypt all communications between ML compute instances in | ||
| 76 | distributed training, choose C<True>. Encryption provides greater | ||
| 77 | security for distributed training, but training might take longer. How | ||
| 78 | long it takes depends on the amount of communication between compute | ||
| 79 | instances, especially if you use a deep learning algorithm in | ||
| 80 | distributed training. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 EnableManagedSpotTraining => Bool | ||
| 84 | |||
| 85 | A Boolean indicating whether managed spot training is enabled (C<True>) | ||
| 86 | or not (C<False>). | ||
| 87 | |||
| 88 | |||
| 89 | =head2 EnableNetworkIsolation => Bool | ||
| 90 | |||
| 91 | Isolates the training container. No inbound or outbound network calls | ||
| 92 | can be made, except for calls between peers within a training cluster | ||
| 93 | for distributed training. If network isolation is used for training | ||
| 94 | jobs that are configured to use a VPC, Amazon SageMaker downloads and | ||
| 95 | uploads customer data and model artifacts through the specified VPC, | ||
| 96 | but the training container does not have network access. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 HyperParameterRanges => L<Paws::SageMaker::ParameterRanges> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 InputDataConfig => ArrayRef[L<Paws::SageMaker::Channel>] | ||
| 105 | |||
| 106 | An array of Channel objects that specify the input for the training | ||
| 107 | jobs that the tuning job launches. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::SageMaker::OutputDataConfig> | ||
| 111 | |||
| 112 | Specifies the path to the Amazon S3 bucket where you store model | ||
| 113 | artifacts from the training jobs that the tuning job launches. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> ResourceConfig => L<Paws::SageMaker::ResourceConfig> | ||
| 117 | |||
| 118 | The resources, including the compute instances and storage volumes, to | ||
| 119 | use for the training jobs that the tuning job launches. | ||
| 120 | |||
| 121 | Storage volumes store model artifacts and incremental states. Training | ||
| 122 | algorithms might also use storage volumes for scratch space. If you | ||
| 123 | want Amazon SageMaker to use the storage volume to store the training | ||
| 124 | data, choose C<File> as the C<TrainingInputMode> in the algorithm | ||
| 125 | specification. For distributed training algorithms, specify an instance | ||
| 126 | count greater than 1. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 RetryStrategy => L<Paws::SageMaker::RetryStrategy> | ||
| 130 | |||
| 131 | The number of times to retry the job when the job fails due to an | ||
| 132 | C<InternalServerError>. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 B<REQUIRED> RoleArn => Str | ||
| 136 | |||
| 137 | The Amazon Resource Name (ARN) of the IAM role associated with the | ||
| 138 | training jobs that the tuning job launches. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 StaticHyperParameters => L<Paws::SageMaker::HyperParameters> | ||
| 142 | |||
| 143 | Specifies the values of hyperparameters that do not change for the | ||
| 144 | tuning job. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 B<REQUIRED> StoppingCondition => L<Paws::SageMaker::StoppingCondition> | ||
| 148 | |||
| 149 | Specifies a limit to how long a model hyperparameter training job can | ||
| 150 | run. It also specifies how long a managed spot training job has to | ||
| 151 | complete. When the job reaches the time limit, Amazon SageMaker ends | ||
| 152 | the training job. Use this API to cap model training costs. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 TuningObjective => L<Paws::SageMaker::HyperParameterTuningJobObjective> | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 VpcConfig => L<Paws::SageMaker::VpcConfig> | ||
| 161 | |||
| 162 | The VpcConfig object that specifies the VPC that you want the training | ||
| 163 | jobs that this hyperparameter tuning job launches to connect to. | ||
| 164 | Control access to and from your training container by configuring the | ||
| 165 | VPC. For more information, see Protect Training Jobs by Using an Amazon | ||
| 166 | Virtual Private Cloud | ||
| 167 | (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |