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

Class ConvergenceDetected

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ConvergenceDetected
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ConvergenceDetected.Builder,ConvergenceDetected>
@Generated("software.amazon.awssdk:codegen") public final class ConvergenceDetected extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConvergenceDetected.Builder,ConvergenceDetected>

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

See Also:

  • Method Details

    • completeOnConvergence

      public final CompleteOnConvergence completeOnConvergence()

      A flag to stop a tuning job once AMT has detected that the job has converged.

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

      Returns:
      A flag to stop a tuning job once AMT has detected that the job has converged.
      See Also:

    • completeOnConvergenceAsString

      public final String completeOnConvergenceAsString()

      A flag to stop a tuning job once AMT has detected that the job has converged.

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

      Returns:
      A flag to stop a tuning job once AMT has detected that the job has converged.
      See Also:

    • toBuilder

      public ConvergenceDetected.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<ConvergenceDetected.Builder,ConvergenceDetected>
      Returns:
      a builder for type T

    • builder

      public static ConvergenceDetected.Builder builder()

    • serializableBuilderClass

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