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

Class HyperParameterTuningJobSummary

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

Provides summary information about a hyperparameter tuning job.

See Also:

  • Method Details

    • hyperParameterTuningJobName

      public final String hyperParameterTuningJobName()

      The name of the tuning job.

      Returns:
      The name of the tuning job.

    • hyperParameterTuningJobArn

      public final String hyperParameterTuningJobArn()

      The Amazon Resource Name (ARN) of the tuning job.

      Returns:
      The Amazon Resource Name (ARN) of the tuning job.

    • hyperParameterTuningJobStatus

      public final HyperParameterTuningJobStatus hyperParameterTuningJobStatus()

      The status of the tuning job.

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

      Returns:
      The status of the tuning job.
      See Also:

    • hyperParameterTuningJobStatusAsString

      public final String hyperParameterTuningJobStatusAsString()

      The status of the tuning job.

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

      Returns:
      The status of the tuning job.
      See Also:

    • strategy

      public final HyperParameterTuningJobStrategyType strategy()

      Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

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

      Returns:
      Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

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

      Returns:
      Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
      See Also:

    • creationTime

      public final Instant creationTime()

      The date and time that the tuning job was created.

      Returns:
      The date and time that the tuning job was created.

    • hyperParameterTuningEndTime

      public final Instant hyperParameterTuningEndTime()

      The date and time that the tuning job ended.

      Returns:
      The date and time that the tuning job ended.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time that the tuning job was modified.

      Returns:
      The date and time that the tuning job was modified.

    • trainingJobStatusCounters

      public final TrainingJobStatusCounters trainingJobStatusCounters()

      The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

      Returns:
      The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

    • objectiveStatusCounters

      public final ObjectiveStatusCounters objectiveStatusCounters()

      The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

      Returns:
      The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

    • resourceLimits

      public final ResourceLimits resourceLimits()

      The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

      Returns:
      The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

    • toBuilder

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

    • builder

      public static HyperParameterTuningJobSummary.Builder builder()

    • serializableBuilderClass

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