Interface HyperParameterTuningResourceConfig.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>
,SdkBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>
,SdkPojo
- Enclosing class:
- HyperParameterTuningResourceConfig
public static interface HyperParameterTuningResourceConfig.Builder extends SdkPojo, CopyableBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HyperParameterTuningResourceConfig.Builder
allocationStrategy(String allocationStrategy)
The strategy that determines the order of preference for resources specified inInstanceConfigs
used in hyperparameter optimization.HyperParameterTuningResourceConfig.Builder
allocationStrategy(HyperParameterTuningAllocationStrategy allocationStrategy)
The strategy that determines the order of preference for resources specified inInstanceConfigs
used in hyperparameter optimization.HyperParameterTuningResourceConfig.Builder
instanceConfigs(Collection<HyperParameterTuningInstanceConfig> instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs.HyperParameterTuningResourceConfig.Builder
instanceConfigs(Consumer<HyperParameterTuningInstanceConfig.Builder>... instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs.HyperParameterTuningResourceConfig.Builder
instanceConfigs(HyperParameterTuningInstanceConfig... instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs.HyperParameterTuningResourceConfig.Builder
instanceCount(Integer instanceCount)
The number of compute instances of typeInstanceType
to use.HyperParameterTuningResourceConfig.Builder
instanceType(String instanceType)
The instance type used to run hyperparameter optimization tuning jobs.HyperParameterTuningResourceConfig.Builder
instanceType(TrainingInstanceType instanceType)
The instance type used to run hyperparameter optimization tuning jobs.HyperParameterTuningResourceConfig.Builder
volumeKmsKeyId(String volumeKmsKeyId)
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job.HyperParameterTuningResourceConfig.Builder
volumeSizeInGB(Integer volumeSizeInGB)
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional).-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
instanceType
HyperParameterTuningResourceConfig.Builder instanceType(String instanceType)
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
- Parameters:
instanceType
- The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingInstanceType
,TrainingInstanceType
-
instanceType
HyperParameterTuningResourceConfig.Builder instanceType(TrainingInstanceType instanceType)
The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.
- Parameters:
instanceType
- The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingInstanceType
,TrainingInstanceType
-
instanceCount
HyperParameterTuningResourceConfig.Builder instanceCount(Integer instanceCount)
The number of compute instances of type
InstanceType
to use. For distributed training, select a value greater than 1.- Parameters:
instanceCount
- The number of compute instances of typeInstanceType
to use. For distributed training, select a value greater than 1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeSizeInGB
HyperParameterTuningResourceConfig.Builder volumeSizeInGB(Integer volumeSizeInGB)
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for
InstanceConfigs
is also specified.Some instance types have a fixed total local storage size. If you select one of these instances for training,
VolumeSizeInGB
cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.SageMaker supports only the General Purpose SSD (gp2) storage volume type.
- Parameters:
volumeSizeInGB
- The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value forInstanceConfigs
is also specified.Some instance types have a fixed total local storage size. If you select one of these instances for training,
VolumeSizeInGB
cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.SageMaker supports only the General Purpose SSD (gp2) storage volume type.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeKmsKeyId
HyperParameterTuningResourceConfig.Builder volumeKmsKeyId(String volumeKmsKeyId)
A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.
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"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a
VolumeKmsKeyId
. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.- Parameters:
volumeKmsKeyId
- A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.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"
Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a
VolumeKmsKeyId
. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allocationStrategy
HyperParameterTuningResourceConfig.Builder allocationStrategy(String allocationStrategy)
The strategy that determines the order of preference for resources specified in
InstanceConfigs
used in hyperparameter optimization.- Parameters:
allocationStrategy
- The strategy that determines the order of preference for resources specified inInstanceConfigs
used in hyperparameter optimization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HyperParameterTuningAllocationStrategy
,HyperParameterTuningAllocationStrategy
-
allocationStrategy
HyperParameterTuningResourceConfig.Builder allocationStrategy(HyperParameterTuningAllocationStrategy allocationStrategy)
The strategy that determines the order of preference for resources specified in
InstanceConfigs
used in hyperparameter optimization.- Parameters:
allocationStrategy
- The strategy that determines the order of preference for resources specified inInstanceConfigs
used in hyperparameter optimization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HyperParameterTuningAllocationStrategy
,HyperParameterTuningAllocationStrategy
-
instanceConfigs
HyperParameterTuningResourceConfig.Builder instanceConfigs(Collection<HyperParameterTuningInstanceConfig> instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The
AllocationStrategy
controls the order in which multiple configurations provided inInstanceConfigs
are used.If you only want to use a single instance configuration inside the
HyperParameterTuningResourceConfig
API, do not provide a value forInstanceConfigs
. Instead, useInstanceType
,VolumeSizeInGB
andInstanceCount
. If you useInstanceConfigs
, do not provide values forInstanceType
,VolumeSizeInGB
orInstanceCount
.- Parameters:
instanceConfigs
- A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. TheAllocationStrategy
controls the order in which multiple configurations provided inInstanceConfigs
are used.If you only want to use a single instance configuration inside the
HyperParameterTuningResourceConfig
API, do not provide a value forInstanceConfigs
. Instead, useInstanceType
,VolumeSizeInGB
andInstanceCount
. If you useInstanceConfigs
, do not provide values forInstanceType
,VolumeSizeInGB
orInstanceCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConfigs
HyperParameterTuningResourceConfig.Builder instanceConfigs(HyperParameterTuningInstanceConfig... instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The
AllocationStrategy
controls the order in which multiple configurations provided inInstanceConfigs
are used.If you only want to use a single instance configuration inside the
HyperParameterTuningResourceConfig
API, do not provide a value forInstanceConfigs
. Instead, useInstanceType
,VolumeSizeInGB
andInstanceCount
. If you useInstanceConfigs
, do not provide values forInstanceType
,VolumeSizeInGB
orInstanceCount
.- Parameters:
instanceConfigs
- A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. TheAllocationStrategy
controls the order in which multiple configurations provided inInstanceConfigs
are used.If you only want to use a single instance configuration inside the
HyperParameterTuningResourceConfig
API, do not provide a value forInstanceConfigs
. Instead, useInstanceType
,VolumeSizeInGB
andInstanceCount
. If you useInstanceConfigs
, do not provide values forInstanceType
,VolumeSizeInGB
orInstanceCount
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConfigs
HyperParameterTuningResourceConfig.Builder instanceConfigs(Consumer<HyperParameterTuningInstanceConfig.Builder>... instanceConfigs)
A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The
AllocationStrategy
controls the order in which multiple configurations provided inInstanceConfigs
are used.If you only want to use a single instance configuration inside the
HyperParameterTuningResourceConfig
API, do not provide a value forInstanceConfigs
. Instead, useInstanceType
,VolumeSizeInGB
andInstanceCount
. If you useInstanceConfigs
, do not provide values forInstanceType
,VolumeSizeInGB
orInstanceCount
.HyperParameterTuningInstanceConfig.Builder
avoiding the need to create one manually viaHyperParameterTuningInstanceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#instanceConfigs(List
.) - Parameters:
instanceConfigs
- a consumer that will call methods onHyperParameterTuningInstanceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#instanceConfigs(java.util.Collection
)
-
-