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

Class DescribeHyperParameterTuningJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeHyperParameterTuningJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeHyperParameterTuningJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>

  • Method Details

    • hyperParameterTuningJobName

      public final String hyperParameterTuningJobName()

      The name of the hyperparameter tuning job.

      Returns:
      The name of the hyperparameter 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.

    • hyperParameterTuningJobConfig

      public final HyperParameterTuningJobConfig hyperParameterTuningJobConfig()

      The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

      Returns:
      The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

    • trainingJobDefinition

      public final HyperParameterTrainingJobDefinition trainingJobDefinition()

      The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

      Returns:
      The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

    • hasTrainingJobDefinitions

      public final boolean hasTrainingJobDefinitions()
      For responses, this returns true if the service returned a value for the TrainingJobDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • trainingJobDefinitions

      public final List<HyperParameterTrainingJobDefinition> trainingJobDefinitions()

      A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTrainingJobDefinitions() method.

      Returns:
      A list of the HyperParameterTrainingJobDefinition objects launched for this 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:

    • creationTime

      public final Instant creationTime()

      The date and time that the tuning job started.

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

    • 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 status of the tuning job was modified.

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

    • trainingJobStatusCounters

      public final TrainingJobStatusCounters trainingJobStatusCounters()

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

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

    • objectiveStatusCounters

      public final ObjectiveStatusCounters objectiveStatusCounters()

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

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

    • bestTrainingJob

      public final HyperParameterTrainingJobSummary bestTrainingJob()

      A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

      Returns:
      A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

    • overallBestTrainingJob

      public final HyperParameterTrainingJobSummary overallBestTrainingJob()

      If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

      Returns:
      If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

    • warmStartConfig

      public final HyperParameterTuningJobWarmStartConfig warmStartConfig()

      The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

      Returns:
      The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

    • autotune

      public final Autotune autotune()

      A flag to indicate if autotune is enabled for the hyperparameter tuning job.

      Returns:
      A flag to indicate if autotune is enabled for the hyperparameter tuning job.

    • failureReason

      public final String failureReason()

      If the tuning job failed, the reason it failed.

      Returns:
      If the tuning job failed, the reason it failed.

    • tuningJobCompletionDetails

      public final HyperParameterTuningJobCompletionDetails tuningJobCompletionDetails()

      Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

      Returns:
      Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.

    • consumedResources

      public final HyperParameterTuningJobConsumedResources consumedResources()
      Returns the value of the ConsumedResources property for this object.
      Returns:
      The value of the ConsumedResources property for this object.

    • toBuilder

      public DescribeHyperParameterTuningJobResponse.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<DescribeHyperParameterTuningJobResponse.Builder,DescribeHyperParameterTuningJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeHyperParameterTuningJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeHyperParameterTuningJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.