Class AutoMLJobCompletionCriteria

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

How long a job is allowed to run, or how many candidates a job is allowed to generate.

See Also:

  • Method Details

    • maxCandidates

      public final Integer maxCandidates()

      The maximum number of times a training job is allowed to run.

      For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

      Returns:
      The maximum number of times a training job is allowed to run.

      For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.

    • maxRuntimePerTrainingJobInSeconds

      public final Integer maxRuntimePerTrainingJobInSeconds()

      The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

      For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

      For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

      Returns:
      The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the StoppingCondition used by the CreateHyperParameterTuningJob action.

      For job V2s (jobs created by calling CreateAutoMLJobV2), this field controls the runtime of the job candidate.

      For TextGenerationJobConfig problem types, the maximum time defaults to 72 hours (259200 seconds).

    • maxAutoMLJobRuntimeInSeconds

      public final Integer maxAutoMLJobRuntimeInSeconds()

      The maximum runtime, in seconds, an AutoML job has to complete.

      If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

      Returns:
      The maximum runtime, in seconds, an AutoML job has to complete.

      If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.

    • toBuilder

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

    • builder

      public static AutoMLJobCompletionCriteria.Builder builder()

    • serializableBuilderClass

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