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)
<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 the search strategy for hyperparameters.
String	strategyAsString() Specifies the search strategy for hyperparameters.
HyperParameterTuningJobConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

strategy

public HyperParameterTuningJobStrategyType strategy()

Specifies the search strategy for hyperparameters. Currently, the only valid value is Bayesian.

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 the search strategy for hyperparameters. Currently, the only valid value is Bayesian.

See Also:

HyperParameterTuningJobStrategyType

strategyAsString

public String strategyAsString()

Specifies the search strategy for hyperparameters. Currently, the only valid value is Bayesian.

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 the search strategy for hyperparameters. Currently, the only valid value is Bayesian.

See Also:

HyperParameterTuningJobStrategyType

hyperParameterTuningJobObjective

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

toBuilder

public HyperParameterTuningJobConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<HyperParameterTuningJobConfig.Builder,HyperParameterTuningJobConfig>

Returns:

a builder for type T

builder

public static HyperParameterTuningJobConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.