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

Class TuningJobCompletionCriteria

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TuningJobCompletionCriteria

All Implemented Interfaces:

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

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

The job completion criteria.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TuningJobCompletionCriteria.Builder

Method Summary

Modifier and Type	Method	Description
BestObjectiveNotImproving	bestObjectiveNotImproving()	A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
static TuningJobCompletionCriteria.Builder	builder()
ConvergenceDetected	convergenceDetected()	A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TuningJobCompletionCriteria.Builder>	serializableBuilderClass()
Float	targetObjectiveMetricValue()	The value of the objective metric.
TuningJobCompletionCriteria.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

targetObjectiveMetricValue

public final Float targetObjectiveMetricValue()

The value of the objective metric.

Returns:

The value of the objective metric.

bestObjectiveNotImproving

public final BestObjectiveNotImproving bestObjectiveNotImproving()

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

Returns:

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

convergenceDetected

public final ConvergenceDetected convergenceDetected()

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

Returns:

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

toBuilder

public TuningJobCompletionCriteria.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TuningJobCompletionCriteria.Builder,TuningJobCompletionCriteria>

builder

public static TuningJobCompletionCriteria.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo