Documentation

Contains information about a training job.

See: newTrainingJob smart constructor.

Create a value of TrainingJob 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:creationTime:TrainingJob', trainingJob_creationTime - A timestamp that indicates when the training job was created.

$sel:labelingJobArn:TrainingJob', trainingJob_labelingJobArn - The Amazon Resource Name (ARN) of the labeling job.

$sel:failureReason:TrainingJob', trainingJob_failureReason - If the training job failed, the reason it failed.

$sel:secondaryStatusTransitions:TrainingJob', trainingJob_secondaryStatusTransitions - A history of all of the secondary statuses that the training job has transitioned through.

$sel:modelArtifacts:TrainingJob', trainingJob_modelArtifacts - Information about the Amazon S3 location that is configured for storing model artifacts.

$sel:trainingEndTime:TrainingJob', trainingJob_trainingEndTime - Indicates 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 Amazon SageMaker detects a job failure.

$sel:environment:TrainingJob', trainingJob_environment - The environment variables to set in the Docker container.

$sel:billableTimeInSeconds:TrainingJob', trainingJob_billableTimeInSeconds - The billable time in seconds.

$sel:debugHookConfig:TrainingJob', trainingJob_debugHookConfig - Undocumented member.

$sel:checkpointConfig:TrainingJob', trainingJob_checkpointConfig - Undocumented member.

$sel:retryStrategy:TrainingJob', trainingJob_retryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.

$sel:stoppingCondition:TrainingJob', trainingJob_stoppingCondition - Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

$sel:debugRuleEvaluationStatuses:TrainingJob', trainingJob_debugRuleEvaluationStatuses - Information about the evaluation status of the rules for the training job.

$sel:trainingJobStatus:TrainingJob', trainingJob_trainingJobStatus - The status of the training job.

Training job statuses are:

• InProgress - The training is in progress.
• Completed - The training job has completed.
• Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
• Stopping - The training job is stopping.
• Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

$sel:enableNetworkIsolation:TrainingJob', trainingJob_enableNetworkIsolation - If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

$sel:experimentConfig:TrainingJob', trainingJob_experimentConfig - Undocumented member.

$sel:lastModifiedTime:TrainingJob', trainingJob_lastModifiedTime - A timestamp that indicates when the status of the training job was last modified.

$sel:debugRuleConfigurations:TrainingJob', trainingJob_debugRuleConfigurations - Information about the debug rule configuration.

$sel:enableManagedSpotTraining:TrainingJob', trainingJob_enableManagedSpotTraining - When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

$sel:autoMLJobArn:TrainingJob', trainingJob_autoMLJobArn - The Amazon Resource Name (ARN) of the job.

$sel:hyperParameters:TrainingJob', trainingJob_hyperParameters - Algorithm-specific parameters.

$sel:inputDataConfig:TrainingJob', trainingJob_inputDataConfig - An array of Channel objects that describes each data input channel.

$sel:vpcConfig:TrainingJob', trainingJob_vpcConfig - A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

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

$sel:algorithmSpecification:TrainingJob', trainingJob_algorithmSpecification - Information about the algorithm used for training, and algorithm metadata.

$sel:finalMetricDataList:TrainingJob', trainingJob_finalMetricDataList - A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

$sel:outputDataConfig:TrainingJob', trainingJob_outputDataConfig - The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

$sel:trainingStartTime:TrainingJob', trainingJob_trainingStartTime - Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

$sel:tuningJobArn:TrainingJob', trainingJob_tuningJobArn - The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

$sel:trainingJobName:TrainingJob', trainingJob_trainingJobName - The name of the training job.

$sel:resourceConfig:TrainingJob', trainingJob_resourceConfig - Resources, including ML compute instances and ML storage volumes, that are configured for model training.

$sel:enableInterContainerTrafficEncryption:TrainingJob', trainingJob_enableInterContainerTrafficEncryption - To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

$sel:tensorBoardOutputConfig:TrainingJob', trainingJob_tensorBoardOutputConfig - Undocumented member.

$sel:secondaryStatus:TrainingJob', trainingJob_secondaryStatus - Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

- Starting - Starting the training job.

• Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
• Training - Training is in progress.
• Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

- Completed - The training job has completed.

Failed

- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

• Stopped - The training job has stopped.

Stopping

- Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

• LaunchingMLInstances

• PreparingTrainingStack

• DownloadingTrainingImage

$sel:tags:TrainingJob', trainingJob_tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

$sel:trainingTimeInSeconds:TrainingJob', trainingJob_trainingTimeInSeconds - The training time in seconds.

$sel:roleArn:TrainingJob', trainingJob_roleArn - The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

A timestamp that indicates when the training job was created.

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

If the training job failed, the reason it failed.

A history of all of the secondary statuses that the training job has transitioned through.

Information about the Amazon S3 location that is configured for storing model artifacts.

Indicates 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 Amazon SageMaker detects a job failure.

The environment variables to set in the Docker container.

The billable time in seconds.

Undocumented member.

Undocumented member.

The number of times to retry the job when the job fails due to an InternalServerError.

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Information about the evaluation status of the rules for the training job.

The status of the training job.

Training job statuses are:

• InProgress - The training is in progress.
• Completed - The training job has completed.
• Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
• Stopping - The training job is stopping.
• Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

Undocumented member.

A timestamp that indicates when the status of the training job was last modified.

Information about the debug rule configuration.

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

The Amazon Resource Name (ARN) of the job.

Algorithm-specific parameters.

An array of Channel objects that describes each data input channel.

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

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

Information about the algorithm used for training, and algorithm metadata.

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

The name of the training job.

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

Undocumented member.

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress

- Starting - Starting the training job.

• Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
• Training - Training is in progress.
• Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

Completed

- Completed - The training job has completed.

Failed

- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

Stopped

- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

• Stopped - The training job has stopped.

Stopping

- Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

• LaunchingMLInstances

• PreparingTrainingStack

• DownloadingTrainingImage

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

The training time in seconds.

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.