software.amazon.awssdk.services.sagemaker.model

Class HyperParameterTuningJobConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.HyperParameterTuningJobConfig

All Implemented Interfaces:

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

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

Configures a hyperparameter tuning job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HyperParameterTuningJobConfig.Builder

Method Summary

Modifier and Type	Method and Description
static HyperParameterTuningJobConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HyperParameterTuningJobObjective	hyperParameterTuningJobObjective() The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.
ParameterRanges	parameterRanges() The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.
ResourceLimits	resourceLimits() The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.
List<SdkField<?>>	sdkFields()
static Class<? extends HyperParameterTuningJobConfig.Builder>	serializableBuilderClass()
HyperParameterTuningJobStrategyType	strategy() Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches.
String	strategyAsString() Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches.
HyperParameterTuningJobStrategyConfig	strategyConfig() The configuration for the Hyperband optimization strategy.
HyperParameterTuningJobConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrainingJobEarlyStoppingType	trainingJobEarlyStoppingType() Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job.
String	trainingJobEarlyStoppingTypeAsString() Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job.
TuningJobCompletionCriteria	tuningJobCompletionCriteria() The tuning job's completion criteria.

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

strategy

public final HyperParameterTuningJobStrategyType strategy()

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

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

Returns:

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

See Also:

HyperParameterTuningJobStrategyType

strategyAsString

public final String strategyAsString()

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

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

Returns:

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

See Also:

HyperParameterTuningJobStrategyType

strategyConfig

public final HyperParameterTuningJobStrategyConfig strategyConfig()

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

Returns:

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig .

hyperParameterTuningJobObjective

public final HyperParameterTuningJobObjective hyperParameterTuningJobObjective()

The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

Returns:

The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

resourceLimits

public final ResourceLimits resourceLimits()

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

Returns:

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

parameterRanges

public final ParameterRanges parameterRanges()

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

Returns:

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

trainingJobEarlyStoppingType

public final TrainingJobEarlyStoppingType trainingJobEarlyStoppingType()

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

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

Returns:

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

See Also:

TrainingJobEarlyStoppingType

trainingJobEarlyStoppingTypeAsString

public final String trainingJobEarlyStoppingTypeAsString()

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

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

Returns:

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

See Also:

TrainingJobEarlyStoppingType

tuningJobCompletionCriteria

public final TuningJobCompletionCriteria tuningJobCompletionCriteria()

The tuning job's completion criteria.

Returns:

The tuning job's completion criteria.

toBuilder

public HyperParameterTuningJobConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTuningJobConfig.Builder,HyperParameterTuningJobConfig>

builder

public static HyperParameterTuningJobConfig.Builder builder()

serializableBuilderClass

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