software.amazon.awssdk.services.sagemaker.model

Class HyperParameterTuningInstanceConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterTuningInstanceConfig

All Implemented Interfaces:

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

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

The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HyperParameterTuningInstanceConfig.Builder

Method Summary

Modifier and Type	Method and Description
static HyperParameterTuningInstanceConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount() The number of instances of the type specified by InstanceType.
TrainingInstanceType	instanceType() The instance type used for processing of hyperparameter optimization jobs.
String	instanceTypeAsString() The instance type used for processing of hyperparameter optimization jobs.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTuningInstanceConfig.Builder>	serializableBuilderClass()
HyperParameterTuningInstanceConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	volumeSizeInGB() The volume size in GB of the data to be processed for hyperparameter optimization (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 for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

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 for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

See Also:

TrainingInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

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 for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

See Also:

TrainingInstanceType

instanceCount

public final Integer instanceCount()

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See SageMaker distributed training jobs for more information.

Returns:

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See SageMaker distributed training jobs for more information.

volumeSizeInGB

public final Integer volumeSizeInGB()

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

Returns:

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

toBuilder

public HyperParameterTuningInstanceConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTuningInstanceConfig.Builder,HyperParameterTuningInstanceConfig>

builder

public static HyperParameterTuningInstanceConfig.Builder builder()

serializableBuilderClass

public static Class<? extends HyperParameterTuningInstanceConfig.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