« blib/lib/Paws/SageMaker/ResolvedAttributes.pm
↑ Summary
blib/lib/Paws/SageMaker/ResourceLimits.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::ResourceConfig; | ||
| 3 | use Moose; | ||
| 4 | has InstanceCount => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has InstanceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has VolumeKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | has VolumeSizeInGB => (is => 'ro', isa => 'Int', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SageMaker::ResourceConfig | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SageMaker::ResourceConfig object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { InstanceCount => $value, ..., VolumeSizeInGB => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::ResourceConfig object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->InstanceCount | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes the resources, including ML compute instances and ML storage | ||
| 40 | volumes, to use for model training. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> InstanceCount => Int | ||
| 46 | |||
| 47 | The number of ML compute instances to use. For distributed training, | ||
| 48 | provide a value greater than 1. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> InstanceType => Str | ||
| 52 | |||
| 53 | The ML compute instance type. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 VolumeKmsKeyId => Str | ||
| 57 | |||
| 58 | The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt | ||
| 59 | data on the storage volume attached to the ML compute instance(s) that | ||
| 60 | run the training job. | ||
| 61 | |||
| 62 | Certain Nitro-based instances include local storage, dependent on the | ||
| 63 | instance type. Local storage volumes are encrypted using a hardware | ||
| 64 | module on the instance. You can't request a C<VolumeKmsKeyId> when | ||
| 65 | using an instance type with local storage. | ||
| 66 | |||
| 67 | For a list of instance types that support local instance storage, see | ||
| 68 | Instance Store Volumes | ||
| 69 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 70 | |||
| 71 | For more information about local instance storage encryption, see SSD | ||
| 72 | Instance Store Volumes | ||
| 73 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html). | ||
| 74 | |||
| 75 | The C<VolumeKmsKeyId> can be in any of the following formats: | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | // KMS Key ID | ||
| 82 | |||
| 83 | C<"1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | // Amazon Resource Name (ARN) of a KMS Key | ||
| 88 | |||
| 89 | C<"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"> | ||
| 90 | |||
| 91 | =back | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> VolumeSizeInGB => Int | ||
| 96 | |||
| 97 | The size of the ML storage volume that you want to provision. | ||
| 98 | |||
| 99 | ML storage volumes store model artifacts and incremental states. | ||
| 100 | Training algorithms might also use the ML storage volume for scratch | ||
| 101 | space. If you want to store the training data in the ML storage volume, | ||
| 102 | choose C<File> as the C<TrainingInputMode> in the algorithm | ||
| 103 | specification. | ||
| 104 | |||
| 105 | You must specify sufficient ML storage for your scenario. | ||
| 106 | |||
| 107 | Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage | ||
| 108 | volume type. | ||
| 109 | |||
| 110 | Certain Nitro-based instances include local storage with a fixed total | ||
| 111 | size, dependent on the instance type. When using these instances for | ||
| 112 | training, Amazon SageMaker mounts the local instance storage instead of | ||
| 113 | Amazon EBS gp2 storage. You can't request a C<VolumeSizeInGB> greater | ||
| 114 | than the total size of the local instance storage. | ||
| 115 | |||
| 116 | For a list of instance types that support local instance storage, | ||
| 117 | including the total size per instance type, see Instance Store Volumes | ||
| 118 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |