Package software.amazon.awssdk.services.sagemaker.model

Class HyperbandStrategyConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperbandStrategyConfig

All Implemented Interfaces:

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

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

The configuration for Hyperband, a multi-fidelity based hyperparameter tuning strategy. Hyperband uses the final and intermediate results of a training job to dynamically allocate resources to utilized hyperparameter configurations while automatically stopping under-performing configurations. This parameter should be provided only if Hyperband is selected as the StrategyConfig under the HyperParameterTuningJobConfig API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HyperbandStrategyConfig.Builder

Method Summary

Modifier and Type	Method	Description
static HyperbandStrategyConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResource()	The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job.
Integer	minResource()	The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperbandStrategyConfig.Builder>	serializableBuilderClass()
HyperbandStrategyConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

minResource

public final Integer minResource()

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

Returns:

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job is not stopped by Hyperband.

maxResource

public final Integer maxResource()

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

• epochs

• numepochs

• n-epochs

• n_epochs

• num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

Returns:

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTraining attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

• epochs

• numepochs

• n-epochs

• n_epochs

• num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributed training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

toBuilder

public HyperbandStrategyConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HyperbandStrategyConfig.Builder,HyperbandStrategyConfig>

builder

public static HyperbandStrategyConfig.Builder builder()

serializableBuilderClass

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