JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.sagemaker.model

Class TrainingJob

    • Constructor Detail

      • TrainingJob

        public TrainingJob()
    • Method Detail

      • setTrainingJobName

        public void setTrainingJobName(String trainingJobName)

        The name of the training job.

        Parameters:
        trainingJobName - The name of the training job.
      • getTrainingJobName

        public String getTrainingJobName()

        The name of the training job.

        Returns:
        The name of the training job.
      • withTrainingJobName

        public TrainingJob withTrainingJobName(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.
      • setTrainingJobArn

        public void setTrainingJobArn(String trainingJobArn)

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

        Parameters:
        trainingJobArn - The Amazon Resource Name (ARN) of the training job.
      • getTrainingJobArn

        public String getTrainingJobArn()

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

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

        public TrainingJob withTrainingJobArn(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.
      • setTuningJobArn

        public void setTuningJobArn(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.
      • getTuningJobArn

        public String getTuningJobArn()

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

        public TrainingJob withTuningJobArn(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.
      • setLabelingJobArn

        public void setLabelingJobArn(String labelingJobArn)

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

        Parameters:
        labelingJobArn - The Amazon Resource Name (ARN) of the labeling job.
      • getLabelingJobArn

        public String getLabelingJobArn()

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

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

        public TrainingJob withLabelingJobArn(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.
      • setAutoMLJobArn

        public void setAutoMLJobArn(String autoMLJobArn)

        The Amazon Resource Name (ARN) of the job.

        Parameters:
        autoMLJobArn - The Amazon Resource Name (ARN) of the job.
      • getAutoMLJobArn

        public String getAutoMLJobArn()

        The Amazon Resource Name (ARN) of the job.

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

        public TrainingJob withAutoMLJobArn(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.
      • setModelArtifacts

        public void setModelArtifacts(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.
      • getModelArtifacts

        public ModelArtifacts getModelArtifacts()

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

        public TrainingJob withModelArtifacts(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.
      • setTrainingJobStatus

        public void setTrainingJobStatus(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.

        See Also:
        TrainingJobStatus
      • getTrainingJobStatus

        public String getTrainingJobStatus()

        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:
        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:
        TrainingJobStatus
      • withTrainingJobStatus

        public TrainingJob withTrainingJobStatus(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
      • withTrainingJobStatus

        public TrainingJob withTrainingJobStatus(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:
        TrainingJobStatus
      • setSecondaryStatus

        public void setSecondaryStatus(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

        See Also:
        SecondaryStatus
      • getSecondaryStatus

        public String getSecondaryStatus()

        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:
        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:
        SecondaryStatus
      • withSecondaryStatus

        public TrainingJob withSecondaryStatus(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
      • withSecondaryStatus

        public TrainingJob withSecondaryStatus(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:
        SecondaryStatus
      • setFailureReason

        public void setFailureReason(String failureReason)

        If the training job failed, the reason it failed.

        Parameters:
        failureReason - If the training job failed, the reason it failed.
      • getFailureReason

        public String getFailureReason()

        If the training job failed, the reason it failed.

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

        public TrainingJob withFailureReason(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.
      • getHyperParameters

        public Map<String,String> getHyperParameters()

        Algorithm-specific parameters.

        Returns:
        Algorithm-specific parameters.
      • setHyperParameters

        public void setHyperParameters(Map<String,String> hyperParameters)

        Algorithm-specific parameters.

        Parameters:
        hyperParameters - Algorithm-specific parameters.
      • withHyperParameters

        public TrainingJob withHyperParameters(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.
      • clearHyperParametersEntries

        public TrainingJob clearHyperParametersEntries()
        Removes all the entries added into HyperParameters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAlgorithmSpecification

        public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)

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

        Parameters:
        algorithmSpecification - Information about the algorithm used for training, and algorithm metadata.
      • getAlgorithmSpecification

        public AlgorithmSpecification getAlgorithmSpecification()

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

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

        public TrainingJob withAlgorithmSpecification(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.
      • setRoleArn

        public void setRoleArn(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.
      • getRoleArn

        public String getRoleArn()

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

        public TrainingJob withRoleArn(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.
      • getInputDataConfig

        public List<Channel> getInputDataConfig()

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

      • setInputDataConfig

        public void setInputDataConfig(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.

      • withInputDataConfig

        public TrainingJob withInputDataConfig(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.

        NOTE: This method appends the values to the existing list (if any). Use setInputDataConfig(java.util.Collection) or withInputDataConfig(java.util.Collection) if you want to override the existing values.

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

        public TrainingJob withInputDataConfig(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.
      • setOutputDataConfig

        public void setOutputDataConfig(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.
      • getOutputDataConfig

        public OutputDataConfig getOutputDataConfig()

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

        public TrainingJob withOutputDataConfig(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.
      • setResourceConfig

        public void setResourceConfig(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.
      • getResourceConfig

        public ResourceConfig getResourceConfig()

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

        public TrainingJob withResourceConfig(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.
      • setStoppingCondition

        public void setStoppingCondition(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.

      • getStoppingCondition

        public StoppingCondition getStoppingCondition()

        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.

      • withStoppingCondition

        public TrainingJob withStoppingCondition(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.
      • setCreationTime

        public void setCreationTime(Date creationTime)

        A timestamp that indicates when the training job was created.

        Parameters:
        creationTime - A timestamp that indicates when the training job was created.
      • getCreationTime

        public Date getCreationTime()

        A timestamp that indicates when the training job was created.

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

        public TrainingJob withCreationTime(Date 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.
      • setTrainingStartTime

        public void setTrainingStartTime(Date 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.
      • getTrainingStartTime

        public Date getTrainingStartTime()

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

        public TrainingJob withTrainingStartTime(Date 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.
      • setTrainingEndTime

        public void setTrainingEndTime(Date 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.
      • getTrainingEndTime

        public Date getTrainingEndTime()

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

        public TrainingJob withTrainingEndTime(Date 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.
      • setLastModifiedTime

        public void setLastModifiedTime(Date 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.
      • getLastModifiedTime

        public Date getLastModifiedTime()

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

        public TrainingJob withLastModifiedTime(Date 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.
      • getSecondaryStatusTransitions

        public List<SecondaryStatusTransition> getSecondaryStatusTransitions()

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

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

        public void setSecondaryStatusTransitions(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.
      • withSecondaryStatusTransitions

        public TrainingJob withSecondaryStatusTransitions(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.
      • getFinalMetricDataList

        public List<MetricData> getFinalMetricDataList()

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

        public void setFinalMetricDataList(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.
      • withFinalMetricDataList

        public TrainingJob withFinalMetricDataList(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.

        NOTE: This method appends the values to the existing list (if any). Use setFinalMetricDataList(java.util.Collection) or withFinalMetricDataList(java.util.Collection) if you want to override the existing values.

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

        public TrainingJob withFinalMetricDataList(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.
      • setEnableNetworkIsolation

        public void setEnableNetworkIsolation(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.
      • getEnableNetworkIsolation

        public Boolean getEnableNetworkIsolation()

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

        public TrainingJob withEnableNetworkIsolation(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.
      • isEnableNetworkIsolation

        public Boolean isEnableNetworkIsolation()

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

        public void setEnableInterContainerTrafficEncryption(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.
      • getEnableInterContainerTrafficEncryption

        public Boolean getEnableInterContainerTrafficEncryption()

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

        public TrainingJob withEnableInterContainerTrafficEncryption(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.
      • isEnableInterContainerTrafficEncryption

        public Boolean isEnableInterContainerTrafficEncryption()

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

        public void setEnableManagedSpotTraining(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.
      • getEnableManagedSpotTraining

        public Boolean getEnableManagedSpotTraining()

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

        public TrainingJob withEnableManagedSpotTraining(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.
      • isEnableManagedSpotTraining

        public Boolean isEnableManagedSpotTraining()

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

        public void setCheckpointConfig(CheckpointConfig checkpointConfig)
        Parameters:
        checkpointConfig -
      • withCheckpointConfig

        public TrainingJob withCheckpointConfig(CheckpointConfig checkpointConfig)
        Parameters:
        checkpointConfig -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setTrainingTimeInSeconds

        public void setTrainingTimeInSeconds(Integer trainingTimeInSeconds)

        The training time in seconds.

        Parameters:
        trainingTimeInSeconds - The training time in seconds.
      • getTrainingTimeInSeconds

        public Integer getTrainingTimeInSeconds()

        The training time in seconds.

        Returns:
        The training time in seconds.
      • withTrainingTimeInSeconds

        public TrainingJob withTrainingTimeInSeconds(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.
      • setBillableTimeInSeconds

        public void setBillableTimeInSeconds(Integer billableTimeInSeconds)

        The billable time in seconds.

        Parameters:
        billableTimeInSeconds - The billable time in seconds.
      • getBillableTimeInSeconds

        public Integer getBillableTimeInSeconds()

        The billable time in seconds.

        Returns:
        The billable time in seconds.
      • withBillableTimeInSeconds

        public TrainingJob withBillableTimeInSeconds(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.
      • setDebugHookConfig

        public void setDebugHookConfig(DebugHookConfig debugHookConfig)
        Parameters:
        debugHookConfig -
      • withDebugHookConfig

        public TrainingJob withDebugHookConfig(DebugHookConfig debugHookConfig)
        Parameters:
        debugHookConfig -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setExperimentConfig

        public void setExperimentConfig(ExperimentConfig experimentConfig)
        Parameters:
        experimentConfig -
      • withExperimentConfig

        public TrainingJob withExperimentConfig(ExperimentConfig experimentConfig)
        Parameters:
        experimentConfig -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getDebugRuleConfigurations

        public List<DebugRuleConfiguration> getDebugRuleConfigurations()

        Information about the debug rule configuration.

        Returns:
        Information about the debug rule configuration.
      • setDebugRuleConfigurations

        public void setDebugRuleConfigurations(Collection<DebugRuleConfiguration> debugRuleConfigurations)

        Information about the debug rule configuration.

        Parameters:
        debugRuleConfigurations - Information about the debug rule configuration.
      • withDebugRuleConfigurations

        public TrainingJob withDebugRuleConfigurations(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.
      • setTensorBoardOutputConfig

        public void setTensorBoardOutputConfig(TensorBoardOutputConfig tensorBoardOutputConfig)
        Parameters:
        tensorBoardOutputConfig -
      • withTensorBoardOutputConfig

        public TrainingJob withTensorBoardOutputConfig(TensorBoardOutputConfig tensorBoardOutputConfig)
        Parameters:
        tensorBoardOutputConfig -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getDebugRuleEvaluationStatuses

        public List<DebugRuleEvaluationStatus> getDebugRuleEvaluationStatuses()

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

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

        public void setDebugRuleEvaluationStatuses(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.
      • withDebugRuleEvaluationStatuses

        public TrainingJob withDebugRuleEvaluationStatuses(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.
      • setProfilerConfig

        public void setProfilerConfig(ProfilerConfig profilerConfig)
        Parameters:
        profilerConfig -
      • getProfilerConfig

        public ProfilerConfig getProfilerConfig()
        Returns:
      • withProfilerConfig

        public TrainingJob withProfilerConfig(ProfilerConfig profilerConfig)
        Parameters:
        profilerConfig -
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getEnvironment

        public Map<String,String> getEnvironment()

        The environment variables to set in the Docker container.

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

        public void setEnvironment(Map<String,String> environment)

        The environment variables to set in the Docker container.

        Parameters:
        environment - The environment variables to set in the Docker container.
      • withEnvironment

        public TrainingJob withEnvironment(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.
      • clearEnvironmentEntries

        public TrainingJob clearEnvironmentEntries()
        Removes all the entries added into Environment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRetryStrategy

        public void setRetryStrategy(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.
      • getRetryStrategy

        public RetryStrategy getRetryStrategy()

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

        public TrainingJob withRetryStrategy(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.
      • getTags

        public List<Tag> getTags()

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

        public void setTags(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.
      • withTags

        public TrainingJob withTags(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.

        NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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

        public TrainingJob withTags(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.
      • toString

        public 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /