HyperParameterTrainingJobSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.HyperParameterTrainingJobSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<HyperParameterTrainingJobSummary.Builder,HyperParameterTrainingJobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class HyperParameterTrainingJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HyperParameterTrainingJobSummary.Builder,HyperParameterTrainingJobSummary>

The container for the summary information about a training job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HyperParameterTrainingJobSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HyperParameterTrainingJobSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HyperParameterTrainingJobSummary.Builder`	`builder()`
`Instant`	`creationTime()` The date and time that the training job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` The reason that the training job failed.
`FinalHyperParameterTuningJobObjectiveMetric`	`finalHyperParameterTuningJobObjectiveMetric()` The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTunedHyperParameters()` For responses, this returns true if the service returned a value for the TunedHyperParameters property.
`ObjectiveStatus`	`objectiveStatus()` The status of the objective metric for the training job:
`String`	`objectiveStatusAsString()` The status of the objective metric for the training job:
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HyperParameterTrainingJobSummary.Builder>`	`serializableBuilderClass()`
`HyperParameterTrainingJobSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`trainingEndTime()` Specifies the time when the training job ends on training instances.
`String`	`trainingJobArn()` The Amazon Resource Name (ARN) of the training job.
`String`	`trainingJobDefinitionName()` The training job definition name.
`String`	`trainingJobName()` The name of the training job.
`TrainingJobStatus`	`trainingJobStatus()` The status of the training job.
`String`	`trainingJobStatusAsString()` The status of the training job.
`Instant`	`trainingStartTime()` The date and time that the training job started.
`Map<String,String>`	`tunedHyperParameters()` A list of the hyperparameters for which you specified ranges to search.
`String`	`tuningJobName()` The HyperParameter tuning job that launched the training job.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - trainingJobDefinitionName
```
public final String trainingJobDefinitionName()
```
    The training job definition name.
    
    Returns:
    
    The training job definition name.
  - trainingJobName
```
public final String trainingJobName()
```
    The name of the training job.
    
    Returns:
    
    The name of the training job.
  - trainingJobArn
```
public final String trainingJobArn()
```
    The Amazon Resource Name (ARN) of the training job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the training job.
  - tuningJobName
```
public final String tuningJobName()
```
    The HyperParameter tuning job that launched the training job.
    
    Returns:
    
    The HyperParameter tuning job that launched the training job.
  - creationTime
```
public final Instant creationTime()
```
    The date and time that the training job was created.
    
    Returns:
    
    The date and time that the training job was created.
  - trainingStartTime
```
public final Instant trainingStartTime()
```
    The date and time that the training job started.
    
    Returns:
    
    The date and time that the training job started.
  - trainingEndTime
```
public final Instant trainingEndTime()
```
    Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
    
    Returns:
    
    Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
  - trainingJobStatus
```
public final TrainingJobStatus trainingJobStatus()
```
    The status of the training job.
    
    If the service returns an enum value that is not available in the current SDK version, trainingJobStatus will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trainingJobStatusAsString().
    
    Returns:
    
    The status of the training job.
    
    See Also:
    
    TrainingJobStatus
  - trainingJobStatusAsString
```
public final String trainingJobStatusAsString()
```
    The status of the training job.
    
    If the service returns an enum value that is not available in the current SDK version, trainingJobStatus will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trainingJobStatusAsString().
    
    Returns:
    
    The status of the training job.
    
    See Also:
    
    TrainingJobStatus
  - hasTunedHyperParameters
```
public final boolean hasTunedHyperParameters()
```
    For responses, this returns true if the service returned a value for the TunedHyperParameters 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.
  - tunedHyperParameters
```
public final Map<String,String> tunedHyperParameters()
```
    A list of the hyperparameters for which you specified ranges to search.
    
    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 hasTunedHyperParameters() method.
    
    Returns:
    
    A list of the hyperparameters for which you specified ranges to search.
  - failureReason
```
public final String failureReason()
```
    The reason that the training job failed.
    
    Returns:
    
    The reason that the training job failed.
  - finalHyperParameterTuningJobObjectiveMetric
```
public final FinalHyperParameterTuningJobObjectiveMetric finalHyperParameterTuningJobObjectiveMetric()
```
    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
    
    Returns:
    
    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.
  - objectiveStatus
```
public final ObjectiveStatus objectiveStatus()
```
    The status of the objective metric for the training job:
    - Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
    - Pending: The training job is in progress and evaluation of its final objective metric is pending.
    - Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
    If the service returns an enum value that is not available in the current SDK version, objectiveStatus will return ObjectiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectiveStatusAsString().
    Returns:
    The status of the objective metric for the training job:
    
    Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
    
    Pending: The training job is in progress and evaluation of its final objective metric is pending.
    
    Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
    See Also:
    
    ObjectiveStatus
  - objectiveStatusAsString
```
public final String objectiveStatusAsString()
```
    The status of the objective metric for the training job:
    - Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
    - Pending: The training job is in progress and evaluation of its final objective metric is pending.
    - Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
    If the service returns an enum value that is not available in the current SDK version, objectiveStatus will return ObjectiveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectiveStatusAsString().
    Returns:
    The status of the objective metric for the training job:
    
    Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
    
    Pending: The training job is in progress and evaluation of its final objective metric is pending.
    
    Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
    See Also:
    
    ObjectiveStatus
  - toBuilder
```
public HyperParameterTrainingJobSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HyperParameterTrainingJobSummary.Builder,HyperParameterTrainingJobSummary>
  - builder
```
public static HyperParameterTrainingJobSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HyperParameterTrainingJobSummary.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class HyperParameterTrainingJobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

trainingJobDefinitionName

trainingJobName

trainingJobArn

tuningJobName

creationTime

trainingStartTime

trainingEndTime

trainingJobStatus

trainingJobStatusAsString

hasTunedHyperParameters

tunedHyperParameters

failureReason

finalHyperParameterTuningJobObjectiveMetric

objectiveStatus

objectiveStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields