Class HyperParameterTrainingJobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HyperParameterTrainingJobSummary.Builder,
HyperParameterTrainingJobSummary>
The container for the summary information about a training job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date and time that the training job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The reason that the training job failed.The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TunedHyperParameters property.final ObjectiveStatus
The status of the objective metric for the training job:final String
The status of the objective metric for the training job:static Class
<? extends HyperParameterTrainingJobSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
Specifies the time when the training job ends on training instances.final String
The Amazon Resource Name (ARN) of the training job.final String
The training job definition name.final String
The name of the training job.final TrainingJobStatus
The status of the training job.final String
The status of the training job.final Instant
The date and time that the training job started.A list of the hyperparameters for which you specified ranges to search.final String
The HyperParameter tuning job that launched the training job.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
trainingJobDefinitionName
The training job definition name.
- Returns:
- The training job definition name.
-
trainingJobName
The name of the training job.
- Returns:
- The name of the training job.
-
trainingJobArn
The Amazon Resource Name (ARN) of the training job.
- Returns:
- The Amazon Resource Name (ARN) of the training job.
-
tuningJobName
The HyperParameter tuning job that launched the training job.
- Returns:
- The HyperParameter tuning job that launched the training job.
-
creationTime
The date and time that the training job was created.
- Returns:
- The date and time that the training job was created.
-
trainingStartTime
The date and time that the training job started.
- Returns:
- The date and time that the training job started.
-
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
The status of the training job.
If the service returns an enum value that is not available in the current SDK version,
trainingJobStatus
will returnTrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingJobStatusAsString()
.- Returns:
- The status of the training job.
- See Also:
-
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 returnTrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingJobStatusAsString()
.- Returns:
- The status of the training job.
- See Also:
-
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 theisEmpty()
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
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
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
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 returnObjectiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectiveStatusAsString()
.- 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:
-
-
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 returnObjectiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectiveStatusAsString()
.- 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:
-
-
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 interfaceToCopyableBuilder<HyperParameterTrainingJobSummary.Builder,
HyperParameterTrainingJobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-