Documentation

The container for the summary information about a training job.

See: newHyperParameterTrainingJobSummary smart constructor.

Create a value of HyperParameterTrainingJobSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureReason:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_failureReason - The reason that the training job failed.

$sel:finalHyperParameterTuningJobObjectiveMetric:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_finalHyperParameterTuningJobObjectiveMetric - The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

$sel:objectiveStatus:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_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.

$sel:trainingEndTime:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_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.

$sel:trainingJobDefinitionName:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_trainingJobDefinitionName - The training job definition name.

$sel:trainingStartTime:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_trainingStartTime - The date and time that the training job started.

$sel:tuningJobName:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_tuningJobName - The HyperParameter tuning job that launched the training job.

$sel:trainingJobName:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_trainingJobName - The name of the training job.

$sel:trainingJobArn:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_trainingJobArn - The Amazon Resource Name (ARN) of the training job.

$sel:creationTime:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_creationTime - The date and time that the training job was created.

$sel:trainingJobStatus:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_trainingJobStatus - The status of the training job.

$sel:tunedHyperParameters:HyperParameterTrainingJobSummary', hyperParameterTrainingJobSummary_tunedHyperParameters - A list of the hyperparameters for which you specified ranges to search.

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.

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.

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.

The training job definition name.

The date and time that the training job started.

The HyperParameter tuning job that launched the training job.

The name of the training job.

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

The date and time that the training job was created.

The status of the training job.

A list of the hyperparameters for which you specified ranges to search.