public static interface ResourceConfig.Builder extends SdkPojo, CopyableBuilder<ResourceConfig.Builder,ResourceConfig>
| Modifier and Type | Method and Description |
|---|---|
ResourceConfig.Builder |
instanceCount(Integer instanceCount)
The number of ML compute instances to use.
|
ResourceConfig.Builder |
instanceGroups(Collection<InstanceGroup> instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
|
ResourceConfig.Builder |
instanceGroups(Consumer<InstanceGroup.Builder>... instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
|
ResourceConfig.Builder |
instanceGroups(InstanceGroup... instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
|
ResourceConfig.Builder |
instanceType(String instanceType)
The ML compute instance type.
|
ResourceConfig.Builder |
instanceType(TrainingInstanceType instanceType)
The ML compute instance type.
|
ResourceConfig.Builder |
keepAlivePeriodInSeconds(Integer keepAlivePeriodInSeconds)
The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
|
ResourceConfig.Builder |
volumeKmsKeyId(String volumeKmsKeyId)
The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML
compute instance(s) that run the training job.
|
ResourceConfig.Builder |
volumeSizeInGB(Integer volumeSizeInGB)
The size of the ML storage volume that you want to provision.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildResourceConfig.Builder instanceType(String instanceType)
The ML compute instance type.
instanceType - The ML compute instance type.TrainingInstanceType,
TrainingInstanceTypeResourceConfig.Builder instanceType(TrainingInstanceType instanceType)
The ML compute instance type.
instanceType - The ML compute instance type.TrainingInstanceType,
TrainingInstanceTypeResourceConfig.Builder instanceCount(Integer instanceCount)
The number of ML compute instances to use. For distributed training, provide a value greater than 1.
instanceCount - The number of ML compute instances to use. For distributed training, provide a value greater than 1.ResourceConfig.Builder volumeSizeInGB(Integer volumeSizeInGB)
The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML
storage volume for scratch space. If you want to store the training data in the ML storage volume, choose
File as the TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD
volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is
fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets,
checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML
instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and
ml.g5.
When using an ML instance with the EBS-only storage option and without instance storage, you must define the
size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example,
ML instance families that use EBS volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
volumeSizeInGB - The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use
the ML storage volume for scratch space. If you want to store the training data in the ML storage
volume, choose File as the TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage.
Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage
paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of
the instance storage. For example, ML instance families with the NVMe-type instance storage include
ml.p4d, ml.g4dn, and ml.g5.
When using an ML instance with the EBS-only storage option and without instance storage, you must
define the size of EBS volume through VolumeSizeInGB in the ResourceConfig
API. For example, ML instance families that use EBS volumes include ml.c5 and
ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
ResourceConfig.Builder volumeKmsKeyId(String volumeKmsKeyId)
The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes
are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when
using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
volumeKmsKeyId - The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to
the ML compute instance(s) that run the training job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage
volumes are encrypted using a hardware module on the instance. You can't request a
VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
"1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ResourceConfig.Builder instanceGroups(Collection<InstanceGroup> instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
instanceGroups - The configuration of a heterogeneous cluster in JSON format.ResourceConfig.Builder instanceGroups(InstanceGroup... instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
instanceGroups - The configuration of a heterogeneous cluster in JSON format.ResourceConfig.Builder instanceGroups(Consumer<InstanceGroup.Builder>... instanceGroups)
The configuration of a heterogeneous cluster in JSON format.
This is a convenience method that creates an instance of theInstanceGroup.Builder avoiding the need to create one
manually via InstanceGroup.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #instanceGroups(List.
instanceGroups - a consumer that will call methods on
InstanceGroup.Builder#instanceGroups(java.util.Collection) ResourceConfig.Builder keepAlivePeriodInSeconds(Integer keepAlivePeriodInSeconds)
The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
keepAlivePeriodInSeconds - The duration of time in seconds to retain configured resources in a warm pool for subsequent training
jobs.Copyright © 2022. All rights reserved.