software.amazon.awssdk.services.sagemaker.model

Class HyperParameterTuningResourceConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterTuningResourceConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class HyperParameterTuningResourceConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>

The configuration of resources, including compute instances and storage volumes for use in training jobs launched by hyperparameter tuning jobs. HyperParameterTuningResourceConfig is similar to ResourceConfig , but has the additional InstanceConfigs and AllocationStrategy fields to allow for flexible instance management. Specify one or more instance types, count, and the allocation strategy for instance selection.

HyperParameterTuningResourceConfig supports the capabilities of ResourceConfig with the exception of KeepAlivePeriodInSeconds. Hyperparameter tuning jobs use warm pools by default, which reuse clusters between training jobs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HyperParameterTuningResourceConfig.Builder

Method Summary

Modifier and Type	Method and Description
HyperParameterTuningAllocationStrategy	allocationStrategy() The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
String	allocationStrategyAsString() The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.
static HyperParameterTuningResourceConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceConfigs() For responses, this returns true if the service returned a value for the InstanceConfigs property.
List<HyperParameterTuningInstanceConfig>	instanceConfigs() A list containing the configuration(s) for one or more resources for processing hyperparameter jobs.
Integer	instanceCount() The number of compute instances of type InstanceType to use.
TrainingInstanceType	instanceType() The instance type used to run hyperparameter optimization tuning jobs.
String	instanceTypeAsString() The instance type used to run hyperparameter optimization tuning jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTuningResourceConfig.Builder>	serializableBuilderClass()
HyperParameterTuningResourceConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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.
Integer	volumeSizeInGB() The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceType

public final TrainingInstanceType instanceType()

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

If the service returns an enum value that is not available in the current SDK version, instanceType will return TrainingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

See Also:

TrainingInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

If the service returns an enum value that is not available in the current SDK version, instanceType will return TrainingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

See Also:

TrainingInstanceType

instanceCount

public final Integer instanceCount()

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

Returns:

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

volumeSizeInGB

public final 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.

Returns:

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.

volumeKmsKeyId

public final 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.

Returns:

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.

allocationStrategy

public final HyperParameterTuningAllocationStrategy allocationStrategy()

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

If the service returns an enum value that is not available in the current SDK version, allocationStrategy will return HyperParameterTuningAllocationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allocationStrategyAsString().

Returns:

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

See Also:

HyperParameterTuningAllocationStrategy

allocationStrategyAsString

public final String allocationStrategyAsString()

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

If the service returns an enum value that is not available in the current SDK version, allocationStrategy will return HyperParameterTuningAllocationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from allocationStrategyAsString().

Returns:

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

See Also:

HyperParameterTuningAllocationStrategy

hasInstanceConfigs

public final boolean hasInstanceConfigs()

For responses, this returns true if the service returned a value for the InstanceConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

instanceConfigs

public final List<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 in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceConfigs() method.

Returns:

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 in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

toBuilder

public HyperParameterTuningResourceConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTuningResourceConfig.Builder,HyperParameterTuningResourceConfig>

builder

public static HyperParameterTuningResourceConfig.Builder builder()

serializableBuilderClass

public static Class<? extends HyperParameterTuningResourceConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo