Skip to content

HyperParameterTrainingJobSummary

Source code in docs_src/capo_sagemaker/types/hyper_parameter_training_job_summary.py
class HyperParameterTrainingJobSummary(TypedDict, closed=True):
    training_job_definition_name: NotRequired[
        "capo_sagemaker.types.hyper_parameter_training_job_definition_name.HyperParameterTrainingJobDefinitionName"
    ]
    """<p>The training job definition name.</p>"""
    training_job_name: NotRequired[
        "capo_sagemaker.types.training_job_name.TrainingJobName"
    ]
    """<p>The name of the training job.</p>"""
    training_job_arn: NotRequired[
        "capo_sagemaker.types.training_job_arn.TrainingJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the training job.</p>"""
    tuning_job_name: NotRequired[
        "capo_sagemaker.types.hyper_parameter_tuning_job_name.HyperParameterTuningJobName"
    ]
    """<p>The HyperParameter tuning job that launched the training job.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The date and time that the training job was created.</p>"""
    training_start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The date and time that the training job started.</p>"""
    training_end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of <code>TrainingStartTime</code> 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.</p>"""
    training_job_status: NotRequired[
        "capo_sagemaker.types.training_job_status.TrainingJobStatus"
    ]
    """<p>The status of the training job.</p>"""
    tuned_hyper_parameters: NotRequired[
        "capo_sagemaker.types.hyper_parameters.HyperParameters"
    ]
    """<p>A list of the hyperparameters for which you specified ranges to search.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The reason that the training job failed. </p>"""
    final_hyper_parameter_tuning_job_objective_metric: NotRequired[
        "capo_sagemaker.types.final_hyper_parameter_tuning_job_objective_metric.FinalHyperParameterTuningJobObjectiveMetric"
    ]
    """<p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_FinalHyperParameterTuningJobObjectiveMetric.html">FinalHyperParameterTuningJobObjectiveMetric</a> object that specifies the value of the objective metric of the tuning job that launched this training job.</p>"""
    objective_status: NotRequired[
        "capo_sagemaker.types.objective_status.ObjectiveStatus"
    ]
    """<p>The status of the objective metric for the training job:</p> <ul> <li> <p>Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.</p> </li> </ul> <ul> <li> <p>Pending: The training job is in progress and evaluation of its final objective metric is pending.</p> </li> </ul> <ul> <li> <p>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.</p> </li> </ul>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The date and time that the training job was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The reason that the training job failed.

final_hyper_parameter_tuning_job_objective_metric instance-attribute

final_hyper_parameter_tuning_job_objective_metric: NotRequired[
    FinalHyperParameterTuningJobObjectiveMetric
]

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

objective_status instance-attribute

objective_status: NotRequired[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.

training_end_time instance-attribute

training_end_time: NotRequired[Timestamp]

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.

training_job_arn instance-attribute

training_job_arn: NotRequired[TrainingJobArn]

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

training_job_definition_name instance-attribute

training_job_definition_name: NotRequired[HyperParameterTrainingJobDefinitionName]

The training job definition name.

training_job_name instance-attribute

training_job_name: NotRequired[TrainingJobName]

The name of the training job.

training_job_status instance-attribute

training_job_status: NotRequired[TrainingJobStatus]

The status of the training job.

training_start_time instance-attribute

training_start_time: NotRequired[Timestamp]

The date and time that the training job started.

tuned_hyper_parameters instance-attribute

tuned_hyper_parameters: NotRequired[HyperParameters]

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

tuning_job_name instance-attribute

tuning_job_name: NotRequired[HyperParameterTuningJobName]

The HyperParameter tuning job that launched the training job.