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

Interface TuningJobCompletionCriteria.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TuningJobCompletionCriteria.Builder,TuningJobCompletionCriteria>, SdkBuilder<TuningJobCompletionCriteria.Builder,TuningJobCompletionCriteria>, SdkPojo

Enclosing class:

TuningJobCompletionCriteria

public static interface TuningJobCompletionCriteria.Builder
extends SdkPojo, CopyableBuilder<TuningJobCompletionCriteria.Builder,TuningJobCompletionCriteria>

Method Summary

Modifier and Type	Method	Description
default TuningJobCompletionCriteria.Builder	bestObjectiveNotImproving(Consumer<BestObjectiveNotImproving.Builder> bestObjectiveNotImproving)	A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
TuningJobCompletionCriteria.Builder	bestObjectiveNotImproving(BestObjectiveNotImproving bestObjectiveNotImproving)	A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.
default TuningJobCompletionCriteria.Builder	convergenceDetected(Consumer<ConvergenceDetected.Builder> 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.
TuningJobCompletionCriteria.Builder	convergenceDetected(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.
TuningJobCompletionCriteria.Builder	targetObjectiveMetricValue(Float targetObjectiveMetricValue)	The value of the objective metric.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

targetObjectiveMetricValue

TuningJobCompletionCriteria.Builder targetObjectiveMetricValue(Float targetObjectiveMetricValue)

The value of the objective metric.

Parameters:

targetObjectiveMetricValue - The value of the objective metric.

Returns:

Returns a reference to this object so that method calls can be chained together.

bestObjectiveNotImproving

TuningJobCompletionCriteria.Builder bestObjectiveNotImproving(BestObjectiveNotImproving bestObjectiveNotImproving)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

bestObjectiveNotImproving

default TuningJobCompletionCriteria.Builder bestObjectiveNotImproving(Consumer<BestObjectiveNotImproving.Builder> bestObjectiveNotImproving)

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

This is a convenience method that creates an instance of the BestObjectiveNotImproving.Builder avoiding the need to create one manually via BestObjectiveNotImproving.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bestObjectiveNotImproving(BestObjectiveNotImproving).

Parameters:

bestObjectiveNotImproving - a consumer that will call methods on BestObjectiveNotImproving.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bestObjectiveNotImproving(BestObjectiveNotImproving)

convergenceDetected

TuningJobCompletionCriteria.Builder convergenceDetected(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

convergenceDetected

default TuningJobCompletionCriteria.Builder convergenceDetected(Consumer<ConvergenceDetected.Builder> 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.

This is a convenience method that creates an instance of the ConvergenceDetected.Builder avoiding the need to create one manually via ConvergenceDetected.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to convergenceDetected(ConvergenceDetected).

Parameters:

convergenceDetected - a consumer that will call methods on ConvergenceDetected.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

convergenceDetected(ConvergenceDetected)