Package software.amazon.awssdk.services.sagemaker.model

Class TrainingJob

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.TrainingJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TrainingJob.Builder,TrainingJob>
@Generated("software.amazon.awssdk:codegen") public final class TrainingJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrainingJob.Builder,TrainingJob>

Contains information about a training job.

See Also:

  • Method Details

    • 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.

    • tuningJobArn

      public final String tuningJobArn()

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

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

    • labelingJobArn

      public final String labelingJobArn()

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

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

    • autoMLJobArn

      public final String autoMLJobArn()

      The Amazon Resource Name (ARN) of the job.

      Returns:
      The Amazon Resource Name (ARN) of the job.

    • modelArtifacts

      public final ModelArtifacts modelArtifacts()

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

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

    • trainingJobStatus

      public final TrainingJobStatus 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.

      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.

      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.

      See Also:

    • trainingJobStatusAsString

      public final String trainingJobStatusAsString()

      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 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.

      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.

      See Also:

    • secondaryStatus

      public final SecondaryStatus 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.

      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

      If the service returns an enum value that is not available in the current SDK version, secondaryStatus will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from secondaryStatusAsString().

      Returns:
      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.

      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

      See Also:

    • secondaryStatusAsString

      public final String secondaryStatusAsString()

      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.

      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

      If the service returns an enum value that is not available in the current SDK version, secondaryStatus will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from secondaryStatusAsString().

      Returns:
      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.

      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

      See Also:

    • failureReason

      public final String failureReason()

      If the training job failed, the reason it failed.

      Returns:
      If the training job failed, the reason it failed.

    • hasHyperParameters

      public final boolean hasHyperParameters()
      For responses, this returns true if the service returned a value for the HyperParameters 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.

    • hyperParameters

      public final Map<String,String> hyperParameters()

      Algorithm-specific parameters.

      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 hasHyperParameters() method.

      Returns:
      Algorithm-specific parameters.

    • algorithmSpecification

      public final AlgorithmSpecification algorithmSpecification()

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

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

    • roleArn

      public final String roleArn()

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

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

    • hasInputDataConfig

      public final boolean hasInputDataConfig()
      For responses, this returns true if the service returned a value for the InputDataConfig 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.

    • inputDataConfig

      public final List<Channel> inputDataConfig()

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

      Your input must be in the same Amazon Web Services region as your training job.

      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 hasInputDataConfig() method.

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

      Your input must be in the same Amazon Web Services region as your training job.

    • outputDataConfig

      public final OutputDataConfig outputDataConfig()

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

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

    • resourceConfig

      public final ResourceConfig resourceConfig()

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

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

    • vpcConfig

      public final VpcConfig 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.

      Returns:
      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.

    • stoppingCondition

      public final StoppingCondition 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, SageMaker ends the training job. Use this API to cap model training costs.

      To stop a job, 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.

      Returns:
      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, SageMaker ends the training job. Use this API to cap model training costs.

      To stop a job, 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.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the training job was created.

      Returns:
      A timestamp that indicates when the training job was created.

    • trainingStartTime

      public final Instant 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.

      Returns:
      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.

    • trainingEndTime

      public final Instant 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 SageMaker detects a job failure.

      Returns:
      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 SageMaker detects a job failure.

    • lastModifiedTime

      public final Instant lastModifiedTime()

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

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

    • hasSecondaryStatusTransitions

      public final boolean hasSecondaryStatusTransitions()
      For responses, this returns true if the service returned a value for the SecondaryStatusTransitions 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.

    • secondaryStatusTransitions

      public final List<SecondaryStatusTransition> secondaryStatusTransitions()

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

      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 hasSecondaryStatusTransitions() method.

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

    • hasFinalMetricDataList

      public final boolean hasFinalMetricDataList()
      For responses, this returns true if the service returned a value for the FinalMetricDataList 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.

    • finalMetricDataList

      public final List<MetricData> 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.

      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 hasFinalMetricDataList() method.

      Returns:
      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.

    • enableNetworkIsolation

      public final Boolean 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.

      Returns:
      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.

    • enableInterContainerTrafficEncryption

      public final Boolean 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.

      Returns:
      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.

    • enableManagedSpotTraining

      public final Boolean 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.

      Returns:
      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.

    • checkpointConfig

      public final CheckpointConfig checkpointConfig()
      Returns the value of the CheckpointConfig property for this object.
      Returns:
      The value of the CheckpointConfig property for this object.

    • trainingTimeInSeconds

      public final Integer trainingTimeInSeconds()

      The training time in seconds.

      Returns:
      The training time in seconds.

    • billableTimeInSeconds

      public final Integer billableTimeInSeconds()

      The billable time in seconds.

      Returns:
      The billable time in seconds.

    • debugHookConfig

      public final DebugHookConfig debugHookConfig()
      Returns the value of the DebugHookConfig property for this object.
      Returns:
      The value of the DebugHookConfig property for this object.

    • experimentConfig

      public final ExperimentConfig experimentConfig()
      Returns the value of the ExperimentConfig property for this object.
      Returns:
      The value of the ExperimentConfig property for this object.

    • hasDebugRuleConfigurations

      public final boolean hasDebugRuleConfigurations()
      For responses, this returns true if the service returned a value for the DebugRuleConfigurations 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.

    • debugRuleConfigurations

      public final List<DebugRuleConfiguration> debugRuleConfigurations()

      Information about the debug rule configuration.

      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 hasDebugRuleConfigurations() method.

      Returns:
      Information about the debug rule configuration.

    • tensorBoardOutputConfig

      public final TensorBoardOutputConfig tensorBoardOutputConfig()
      Returns the value of the TensorBoardOutputConfig property for this object.
      Returns:
      The value of the TensorBoardOutputConfig property for this object.

    • hasDebugRuleEvaluationStatuses

      public final boolean hasDebugRuleEvaluationStatuses()
      For responses, this returns true if the service returned a value for the DebugRuleEvaluationStatuses 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.

    • debugRuleEvaluationStatuses

      public final List<DebugRuleEvaluationStatus> debugRuleEvaluationStatuses()

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

      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 hasDebugRuleEvaluationStatuses() method.

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

    • profilerConfig

      public final ProfilerConfig profilerConfig()
      Returns the value of the ProfilerConfig property for this object.
      Returns:
      The value of the ProfilerConfig property for this object.

    • hasEnvironment

      public final boolean hasEnvironment()
      For responses, this returns true if the service returned a value for the Environment 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.

    • environment

      public final Map<String,String> environment()

      The environment variables to set in the Docker container.

      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 hasEnvironment() method.

      Returns:
      The environment variables to set in the Docker container.

    • retryStrategy

      public final RetryStrategy retryStrategy()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> 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.

      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 hasTags() method.

      Returns:
      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.

    • toBuilder

      public TrainingJob.Builder 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 interface ToCopyableBuilder<TrainingJob.Builder,TrainingJob>
      Returns:
      a builder for type T

    • builder

      public static TrainingJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TrainingJob.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.