Class Autotune

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.Autotune

All Implemented Interfaces:

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

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

A flag to indicate if you want to use Autotune to automatically find optimal values for the following fields:

• ParameterRanges: The names and ranges of parameters that a hyperparameter tuning job can optimize.

• ResourceLimits: The maximum resources that can be used for a training job. These resources include the maximum number of training jobs, the maximum runtime of a tuning job, and the maximum number of training jobs to run at the same time.

• TrainingJobEarlyStoppingType: A flag that specifies whether or not to use early stopping for training jobs launched by a hyperparameter tuning job.

• RetryStrategy: The number of times to retry a training job.

• Strategy: Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training jobs that it launches.

• ConvergenceDetectedinvalid input: '<'/ a>: A flag to indicate that Automatic model tuning (AMT) has detected model convergence.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Autotune.Builder

Method Summary

Modifier and Type	Method	Description
static Autotune.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final AutotuneMode	mode()	Set Mode to Enabled if you want to use Autotune.
final String	modeAsString()	Set Mode to Enabled if you want to use Autotune.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends Autotune.Builder>	serializableBuilderClass()
Autotune.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

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 Details

mode

public final AutotuneMode mode()

Set Mode to Enabled if you want to use Autotune.

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

Returns:

Set Mode to Enabled if you want to use Autotune.

See Also:

• AutotuneMode

modeAsString

public final String modeAsString()

Set Mode to Enabled if you want to use Autotune.

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

Returns:

Set Mode to Enabled if you want to use Autotune.

See Also:

• AutotuneMode

toBuilder

public Autotune.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<Autotune.Builder,Autotune>

Returns:

a builder for type T

builder

public static Autotune.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.