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

Interface TrainingJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TrainingJob.Builder,TrainingJob>, SdkBuilder<TrainingJob.Builder,TrainingJob>, SdkPojo
Enclosing class:
TrainingJob
public static interface TrainingJob.Builder extends SdkPojo, CopyableBuilder<TrainingJob.Builder,TrainingJob>

  • Method Details

    • trainingJobName

      TrainingJob.Builder trainingJobName(String trainingJobName)

      The name of the training job.

      Parameters:
      trainingJobName - The name of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingJobArn

      TrainingJob.Builder trainingJobArn(String trainingJobArn)

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

      Parameters:
      trainingJobArn - The Amazon Resource Name (ARN) of the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tuningJobArn

      TrainingJob.Builder tuningJobArn(String tuningJobArn)

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

      Parameters:
      tuningJobArn - The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labelingJobArn

      TrainingJob.Builder labelingJobArn(String labelingJobArn)

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

      Parameters:
      labelingJobArn - The Amazon Resource Name (ARN) of the labeling job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoMLJobArn

      TrainingJob.Builder autoMLJobArn(String autoMLJobArn)

      The Amazon Resource Name (ARN) of the job.

      Parameters:
      autoMLJobArn - The Amazon Resource Name (ARN) of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelArtifacts

      TrainingJob.Builder modelArtifacts(ModelArtifacts modelArtifacts)

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

      Parameters:
      modelArtifacts - Information about the Amazon S3 location that is configured for storing model artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelArtifacts

      default TrainingJob.Builder modelArtifacts(Consumer<ModelArtifacts.Builder> modelArtifacts)

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

      This is a convenience method that creates an instance of the ModelArtifacts.Builder avoiding the need to create one manually via ModelArtifacts.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelArtifacts(ModelArtifacts).

      Parameters:
      modelArtifacts - a consumer that will call methods on ModelArtifacts.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingJobStatus

      TrainingJob.Builder trainingJobStatus(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingJobStatus

      TrainingJob.Builder trainingJobStatus(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryStatus

      TrainingJob.Builder secondaryStatus(String 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryStatus

      TrainingJob.Builder secondaryStatus(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      TrainingJob.Builder failureReason(String failureReason)

      If the training job failed, the reason it failed.

      Parameters:
      failureReason - If the training job failed, the reason it failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hyperParameters

      TrainingJob.Builder hyperParameters(Map<String,String> hyperParameters)

      Algorithm-specific parameters.

      Parameters:
      hyperParameters - Algorithm-specific parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmSpecification

      TrainingJob.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification)

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

      Parameters:
      algorithmSpecification - Information about the algorithm used for training, and algorithm metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmSpecification

      default TrainingJob.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification)

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

      This is a convenience method that creates an instance of the AlgorithmSpecification.Builder avoiding the need to create one manually via AlgorithmSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to algorithmSpecification(AlgorithmSpecification).

      Parameters:
      algorithmSpecification - a consumer that will call methods on AlgorithmSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      TrainingJob.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      TrainingJob.Builder inputDataConfig(Collection<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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      TrainingJob.Builder inputDataConfig(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      TrainingJob.Builder inputDataConfig(Consumer<Channel.Builder>... 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.

      This is a convenience method that creates an instance of the Channel.Builder avoiding the need to create one manually via Channel.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(List<Channel>).

      Parameters:
      inputDataConfig - a consumer that will call methods on Channel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputDataConfig

      TrainingJob.Builder outputDataConfig(OutputDataConfig outputDataConfig)

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

      Parameters:
      outputDataConfig - The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default TrainingJob.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

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

      This is a convenience method that creates an instance of the OutputDataConfig.Builder avoiding the need to create one manually via OutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(OutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on OutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceConfig

      TrainingJob.Builder resourceConfig(ResourceConfig resourceConfig)

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

      Parameters:
      resourceConfig - Resources, including ML compute instances and ML storage volumes, that are configured for model training.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceConfig

      default TrainingJob.Builder resourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)

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

      This is a convenience method that creates an instance of the ResourceConfig.Builder avoiding the need to create one manually via ResourceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceConfig(ResourceConfig).

      Parameters:
      resourceConfig - a consumer that will call methods on ResourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      TrainingJob.Builder vpcConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default TrainingJob.Builder vpcConfig(Consumer<VpcConfig.Builder> 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.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stoppingCondition

      TrainingJob.Builder stoppingCondition(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingCondition

      default TrainingJob.Builder stoppingCondition(Consumer<StoppingCondition.Builder> 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.

      This is a convenience method that creates an instance of the StoppingCondition.Builder avoiding the need to create one manually via StoppingCondition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stoppingCondition(StoppingCondition).

      Parameters:
      stoppingCondition - a consumer that will call methods on StoppingCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationTime

      TrainingJob.Builder creationTime(Instant creationTime)

      A timestamp that indicates when the training job was created.

      Parameters:
      creationTime - A timestamp that indicates when the training job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingStartTime

      TrainingJob.Builder trainingStartTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • trainingEndTime

      TrainingJob.Builder trainingEndTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      TrainingJob.Builder lastModifiedTime(Instant lastModifiedTime)

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

      Parameters:
      lastModifiedTime - A timestamp that indicates when the status of the training job was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryStatusTransitions

      TrainingJob.Builder secondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)

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

      Parameters:
      secondaryStatusTransitions - A history of all of the secondary statuses that the training job has transitioned through.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryStatusTransitions

      TrainingJob.Builder secondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)

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

      Parameters:
      secondaryStatusTransitions - A history of all of the secondary statuses that the training job has transitioned through.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryStatusTransitions

      TrainingJob.Builder secondaryStatusTransitions(Consumer<SecondaryStatusTransition.Builder>... secondaryStatusTransitions)

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

      This is a convenience method that creates an instance of the SecondaryStatusTransition.Builder avoiding the need to create one manually via SecondaryStatusTransition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secondaryStatusTransitions(List<SecondaryStatusTransition>).

      Parameters:
      secondaryStatusTransitions - a consumer that will call methods on SecondaryStatusTransition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • finalMetricDataList

      TrainingJob.Builder finalMetricDataList(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • finalMetricDataList

      TrainingJob.Builder finalMetricDataList(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • finalMetricDataList

      TrainingJob.Builder finalMetricDataList(Consumer<MetricData.Builder>... 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.

      This is a convenience method that creates an instance of the MetricData.Builder avoiding the need to create one manually via MetricData.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to finalMetricDataList(List<MetricData>).

      Parameters:
      finalMetricDataList - a consumer that will call methods on MetricData.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableNetworkIsolation

      TrainingJob.Builder enableNetworkIsolation(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • enableInterContainerTrafficEncryption

      TrainingJob.Builder enableInterContainerTrafficEncryption(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • enableManagedSpotTraining

      TrainingJob.Builder enableManagedSpotTraining(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • checkpointConfig

      TrainingJob.Builder checkpointConfig(CheckpointConfig checkpointConfig)
      Sets the value of the CheckpointConfig property for this object.
      Parameters:
      checkpointConfig - The new value for the CheckpointConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checkpointConfig

      default TrainingJob.Builder checkpointConfig(Consumer<CheckpointConfig.Builder> checkpointConfig)
      Sets the value of the CheckpointConfig property for this object. This is a convenience method that creates an instance of the CheckpointConfig.Builder avoiding the need to create one manually via CheckpointConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to checkpointConfig(CheckpointConfig).

      Parameters:
      checkpointConfig - a consumer that will call methods on CheckpointConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingTimeInSeconds

      TrainingJob.Builder trainingTimeInSeconds(Integer trainingTimeInSeconds)

      The training time in seconds.

      Parameters:
      trainingTimeInSeconds - The training time in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • billableTimeInSeconds

      TrainingJob.Builder billableTimeInSeconds(Integer billableTimeInSeconds)

      The billable time in seconds.

      Parameters:
      billableTimeInSeconds - The billable time in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugHookConfig

      TrainingJob.Builder debugHookConfig(DebugHookConfig debugHookConfig)
      Sets the value of the DebugHookConfig property for this object.
      Parameters:
      debugHookConfig - The new value for the DebugHookConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugHookConfig

      default TrainingJob.Builder debugHookConfig(Consumer<DebugHookConfig.Builder> debugHookConfig)
      Sets the value of the DebugHookConfig property for this object. This is a convenience method that creates an instance of the DebugHookConfig.Builder avoiding the need to create one manually via DebugHookConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to debugHookConfig(DebugHookConfig).

      Parameters:
      debugHookConfig - a consumer that will call methods on DebugHookConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • experimentConfig

      TrainingJob.Builder experimentConfig(ExperimentConfig experimentConfig)
      Sets the value of the ExperimentConfig property for this object.
      Parameters:
      experimentConfig - The new value for the ExperimentConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experimentConfig

      default TrainingJob.Builder experimentConfig(Consumer<ExperimentConfig.Builder> experimentConfig)
      Sets the value of the ExperimentConfig property for this object. This is a convenience method that creates an instance of the ExperimentConfig.Builder avoiding the need to create one manually via ExperimentConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to experimentConfig(ExperimentConfig).

      Parameters:
      experimentConfig - a consumer that will call methods on ExperimentConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • debugRuleConfigurations

      TrainingJob.Builder debugRuleConfigurations(Collection<DebugRuleConfiguration> debugRuleConfigurations)

      Information about the debug rule configuration.

      Parameters:
      debugRuleConfigurations - Information about the debug rule configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugRuleConfigurations

      TrainingJob.Builder debugRuleConfigurations(DebugRuleConfiguration... debugRuleConfigurations)

      Information about the debug rule configuration.

      Parameters:
      debugRuleConfigurations - Information about the debug rule configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugRuleConfigurations

      TrainingJob.Builder debugRuleConfigurations(Consumer<DebugRuleConfiguration.Builder>... debugRuleConfigurations)

      Information about the debug rule configuration.

      This is a convenience method that creates an instance of the DebugRuleConfiguration.Builder avoiding the need to create one manually via DebugRuleConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to debugRuleConfigurations(List<DebugRuleConfiguration>).

      Parameters:
      debugRuleConfigurations - a consumer that will call methods on DebugRuleConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tensorBoardOutputConfig

      TrainingJob.Builder tensorBoardOutputConfig(TensorBoardOutputConfig tensorBoardOutputConfig)
      Sets the value of the TensorBoardOutputConfig property for this object.
      Parameters:
      tensorBoardOutputConfig - The new value for the TensorBoardOutputConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tensorBoardOutputConfig

      default TrainingJob.Builder tensorBoardOutputConfig(Consumer<TensorBoardOutputConfig.Builder> tensorBoardOutputConfig)
      Sets the value of the TensorBoardOutputConfig property for this object. This is a convenience method that creates an instance of the TensorBoardOutputConfig.Builder avoiding the need to create one manually via TensorBoardOutputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tensorBoardOutputConfig(TensorBoardOutputConfig).

      Parameters:
      tensorBoardOutputConfig - a consumer that will call methods on TensorBoardOutputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • debugRuleEvaluationStatuses

      TrainingJob.Builder debugRuleEvaluationStatuses(Collection<DebugRuleEvaluationStatus> debugRuleEvaluationStatuses)

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

      Parameters:
      debugRuleEvaluationStatuses - Information about the evaluation status of the rules for the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugRuleEvaluationStatuses

      TrainingJob.Builder debugRuleEvaluationStatuses(DebugRuleEvaluationStatus... debugRuleEvaluationStatuses)

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

      Parameters:
      debugRuleEvaluationStatuses - Information about the evaluation status of the rules for the training job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • debugRuleEvaluationStatuses

      TrainingJob.Builder debugRuleEvaluationStatuses(Consumer<DebugRuleEvaluationStatus.Builder>... debugRuleEvaluationStatuses)

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

      This is a convenience method that creates an instance of the DebugRuleEvaluationStatus.Builder avoiding the need to create one manually via DebugRuleEvaluationStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to debugRuleEvaluationStatuses(List<DebugRuleEvaluationStatus>).

      Parameters:
      debugRuleEvaluationStatuses - a consumer that will call methods on DebugRuleEvaluationStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • profilerConfig

      TrainingJob.Builder profilerConfig(ProfilerConfig profilerConfig)
      Sets the value of the ProfilerConfig property for this object.
      Parameters:
      profilerConfig - The new value for the ProfilerConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profilerConfig

      default TrainingJob.Builder profilerConfig(Consumer<ProfilerConfig.Builder> profilerConfig)
      Sets the value of the ProfilerConfig property for this object. This is a convenience method that creates an instance of the ProfilerConfig.Builder avoiding the need to create one manually via ProfilerConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to profilerConfig(ProfilerConfig).

      Parameters:
      profilerConfig - a consumer that will call methods on ProfilerConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environment

      TrainingJob.Builder environment(Map<String,String> environment)

      The environment variables to set in the Docker container.

      Parameters:
      environment - The environment variables to set in the Docker container.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retryStrategy

      TrainingJob.Builder retryStrategy(RetryStrategy retryStrategy)

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

      Parameters:
      retryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retryStrategy

      default TrainingJob.Builder retryStrategy(Consumer<RetryStrategy.Builder> retryStrategy)

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

      This is a convenience method that creates an instance of the RetryStrategy.Builder avoiding the need to create one manually via RetryStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryStrategy(RetryStrategy).

      Parameters:
      retryStrategy - a consumer that will call methods on RetryStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      TrainingJob.Builder tags(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      TrainingJob.Builder tags(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      TrainingJob.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: