public static interface TrainingJob.Builder extends SdkPojo, CopyableBuilder<TrainingJob.Builder,TrainingJob>
Modifier and Type | Method and Description |
---|---|
TrainingJob.Builder |
algorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
default TrainingJob.Builder |
algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
TrainingJob.Builder |
creationTime(Instant creationTime)
A timestamp that indicates when the training job was created.
|
TrainingJob.Builder |
enableNetworkIsolation(Boolean enableNetworkIsolation)
If the
TrainingJob was created with network isolation, the value is set to true . |
TrainingJob.Builder |
failureReason(String failureReason)
If the training job failed, the reason it failed.
|
TrainingJob.Builder |
finalMetricDataList(Collection<MetricData> finalMetricDataList)
A list of final metric values that are set when the Training Job completes.
|
TrainingJob.Builder |
finalMetricDataList(Consumer<MetricData.Builder>... finalMetricDataList)
A list of final metric values that are set when the Training Job completes.
|
TrainingJob.Builder |
finalMetricDataList(MetricData... finalMetricDataList)
A list of final metric values that are set when the Training Job completes.
|
TrainingJob.Builder |
hyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
|
TrainingJob.Builder |
inputDataConfig(Channel... inputDataConfig)
An array of
Channel objects that describes each data input channel. |
TrainingJob.Builder |
inputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel objects that describes each data input channel. |
TrainingJob.Builder |
inputDataConfig(Consumer<Channel.Builder>... inputDataConfig)
An array of
Channel objects that describes each data input channel. |
TrainingJob.Builder |
labelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job.
|
TrainingJob.Builder |
lastModifiedTime(Instant lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
|
default TrainingJob.Builder |
modelArtifacts(Consumer<ModelArtifacts.Builder> modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
TrainingJob.Builder |
modelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
default TrainingJob.Builder |
outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
TrainingJob.Builder |
outputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
default TrainingJob.Builder |
resourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
TrainingJob.Builder |
resourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
TrainingJob.Builder |
roleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
|
TrainingJob.Builder |
secondaryStatus(SecondaryStatus secondaryStatus)
Provides detailed information about the state of the training job.
|
TrainingJob.Builder |
secondaryStatus(String secondaryStatus)
Provides detailed information about the state of the training job.
|
TrainingJob.Builder |
secondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
TrainingJob.Builder |
secondaryStatusTransitions(Consumer<SecondaryStatusTransition.Builder>... secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
TrainingJob.Builder |
secondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
default TrainingJob.Builder |
stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)
The condition under which to stop the training job.
|
TrainingJob.Builder |
stoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
|
TrainingJob.Builder |
tags(Collection<Tag> tags)
An array of key-value pairs.
|
TrainingJob.Builder |
tags(Consumer<Tag.Builder>... tags)
An array of key-value pairs.
|
TrainingJob.Builder |
tags(Tag... tags)
An array of key-value pairs.
|
TrainingJob.Builder |
trainingEndTime(Instant trainingEndTime)
Indicates the time when the training job ends on training instances.
|
TrainingJob.Builder |
trainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
|
TrainingJob.Builder |
trainingJobName(String trainingJobName)
The name of the training job.
|
TrainingJob.Builder |
trainingJobStatus(String trainingJobStatus)
The status of the training job.
|
TrainingJob.Builder |
trainingJobStatus(TrainingJobStatus trainingJobStatus)
The status of the training job.
|
TrainingJob.Builder |
trainingStartTime(Instant trainingStartTime)
Indicates the time when the training job starts on training instances.
|
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.
|
default TrainingJob.Builder |
vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
A VpcConfig object that specifies the VPC that this training job has access to.
|
TrainingJob.Builder |
vpcConfig(VpcConfig vpcConfig)
A VpcConfig object that specifies the VPC that this training job has access to.
|
copy
applyMutation, build
TrainingJob.Builder trainingJobName(String trainingJobName)
The name of the training job.
trainingJobName
- The name of the training job.TrainingJob.Builder trainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
trainingJobArn
- The Amazon Resource Name (ARN) of the training job.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.
tuningJobArn
- The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was
launched by a hyperparameter tuning job.TrainingJob.Builder labelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job.
labelingJobArn
- The Amazon Resource Name (ARN) of the labeling job.TrainingJob.Builder modelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
modelArtifacts
- Information about the Amazon S3 location that is configured for storing model artifacts.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 that creates an instance of theModelArtifacts.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)
.modelArtifacts
- a consumer that will call methods on ModelArtifacts.Builder
modelArtifacts(ModelArtifacts)
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
.
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
.
TrainingJobStatus
,
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
.
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
.
TrainingJobStatus
,
TrainingJobStatus
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.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
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
- The training job has completed.
Failed
- The training job has failed. The reason for the failure is returned in the
FailureReason
field of DescribeTrainingJobResponse
.
MaxRuntimeExceeded
- The job stopped because it exceeded the maximum allowed runtime.
Stopped
- The training job has stopped.
Stopping
- Stopping the training job.
Valid values for SecondaryStatus
are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
secondaryStatus
- Provides detailed information about the state of the training job. For detailed information about the
secondary status of the training job, see StatusMessage
under
SecondaryStatusTransition.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
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
- The training job has completed.
Failed
- The training job has failed. The reason for the failure is returned in the
FailureReason
field of DescribeTrainingJobResponse
.
MaxRuntimeExceeded
- The job stopped because it exceeded the maximum allowed runtime.
Stopped
- The training job has stopped.
Stopping
- Stopping the training job.
Valid values for SecondaryStatus
are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
SecondaryStatus
,
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.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
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
- The training job has completed.
Failed
- The training job has failed. The reason for the failure is returned in the
FailureReason
field of DescribeTrainingJobResponse
.
MaxRuntimeExceeded
- The job stopped because it exceeded the maximum allowed runtime.
Stopped
- The training job has stopped.
Stopping
- Stopping the training job.
Valid values for SecondaryStatus
are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
secondaryStatus
- Provides detailed information about the state of the training job. For detailed information about the
secondary status of the training job, see StatusMessage
under
SecondaryStatusTransition.
Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:
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
- The training job has completed.
Failed
- The training job has failed. The reason for the failure is returned in the
FailureReason
field of DescribeTrainingJobResponse
.
MaxRuntimeExceeded
- The job stopped because it exceeded the maximum allowed runtime.
Stopped
- The training job has stopped.
Stopping
- Stopping the training job.
Valid values for SecondaryStatus
are subject to change.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
SecondaryStatus
,
SecondaryStatus
TrainingJob.Builder failureReason(String failureReason)
If the training job failed, the reason it failed.
failureReason
- If the training job failed, the reason it failed.TrainingJob.Builder hyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
hyperParameters
- Algorithm-specific parameters.TrainingJob.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
algorithmSpecification
- Information about the algorithm used for training, and algorithm metadata.default TrainingJob.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
This is a convenience that creates an instance of theAlgorithmSpecification.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)
.algorithmSpecification
- a consumer that will call methods on AlgorithmSpecification.Builder
algorithmSpecification(AlgorithmSpecification)
TrainingJob.Builder roleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
roleArn
- The AWS Identity and Access Management (IAM) role configured for the training job.TrainingJob.Builder inputDataConfig(Collection<Channel> inputDataConfig)
An array of Channel
objects that describes each data input channel.
inputDataConfig
- An array of Channel
objects that describes each data input channel.TrainingJob.Builder inputDataConfig(Channel... inputDataConfig)
An array of Channel
objects that describes each data input channel.
inputDataConfig
- An array of Channel
objects that describes each data input channel.TrainingJob.Builder inputDataConfig(Consumer<Channel.Builder>... inputDataConfig)
An array of Channel
objects that describes each data input channel.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #inputDataConfig(List)
.inputDataConfig
- a consumer that will call methods on List.Builder
#inputDataConfig(List)
TrainingJob.Builder outputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
outputDataConfig
- The S3 path where model artifacts that you configured when creating the job are stored. Amazon
SageMaker creates subfolders for model artifacts.default TrainingJob.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
This is a convenience that creates an instance of theOutputDataConfig.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)
.outputDataConfig
- a consumer that will call methods on OutputDataConfig.Builder
outputDataConfig(OutputDataConfig)
TrainingJob.Builder resourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
resourceConfig
- Resources, including ML compute instances and ML storage volumes, that are configured for model
training.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 that creates an instance of theResourceConfig.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)
.resourceConfig
- a consumer that will call methods on ResourceConfig.Builder
resourceConfig(ResourceConfig)
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.
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.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 that creates an instance of theVpcConfig.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)
.vpcConfig
- a consumer that will call methods on VpcConfig.Builder
vpcConfig(VpcConfig)
TrainingJob.Builder stoppingCondition(StoppingCondition stoppingCondition)
The condition under which to stop the training job.
stoppingCondition
- The condition under which to stop the training job.default TrainingJob.Builder stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)
The condition under which to stop the training job.
This is a convenience that creates an instance of theStoppingCondition.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)
.stoppingCondition
- a consumer that will call methods on StoppingCondition.Builder
stoppingCondition(StoppingCondition)
TrainingJob.Builder creationTime(Instant creationTime)
A timestamp that indicates when the training job was created.
creationTime
- A timestamp that indicates when the training job was created.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.
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.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 Amazon SageMaker
detects a job failure.
trainingEndTime
- Indicates the time when the training job ends on training instances. You are billed for the time
interval between the value of TrainingStartTime
and this time. For successful jobs and
stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time
when Amazon SageMaker detects a job failure.TrainingJob.Builder lastModifiedTime(Instant lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
lastModifiedTime
- A timestamp that indicates when the status of the training job was last modified.TrainingJob.Builder secondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
secondaryStatusTransitions
- A history of all of the secondary statuses that the training job has transitioned through.TrainingJob.Builder secondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
secondaryStatusTransitions
- A history of all of the secondary statuses that the training job has transitioned through.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 that creates an instance of theList.Builder
avoiding the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called
immediately and its result is passed to #secondaryStatusTransitions(List)
.secondaryStatusTransitions
- a consumer that will call methods on List.Builder
#secondaryStatusTransitions(List)
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.
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.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.
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.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 that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #finalMetricDataList(List)
.finalMetricDataList
- a consumer that will call methods on List.Builder
#finalMetricDataList(List)
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.
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.TrainingJob.Builder tags(Collection<Tag> tags)
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
tags
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.TrainingJob.Builder tags(Tag... tags)
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
tags
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.TrainingJob.Builder tags(Consumer<Tag.Builder>... tags)
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.