@Generated(value="software.amazon.awssdk:codegen") public final class TrainingJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrainingJob.Builder,TrainingJob>
Contains information about a training job.
Modifier and Type | Class and Description |
---|---|
static interface |
TrainingJob.Builder |
Modifier and Type | Method and Description |
---|---|
AlgorithmSpecification |
algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
|
static TrainingJob.Builder |
builder() |
Instant |
creationTime()
A timestamp that indicates when the training job was created.
|
Boolean |
enableNetworkIsolation()
If the
TrainingJob was created with network isolation, the value is set to true . |
boolean |
equals(Object obj) |
String |
failureReason()
If the training job failed, the reason it failed.
|
List<MetricData> |
finalMetricDataList()
A list of final metric values that are set when the Training Job completes.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Map<String,String> |
hyperParameters()
Algorithm-specific parameters.
|
List<Channel> |
inputDataConfig()
An array of
Channel objects that describes each data input channel. |
String |
labelingJobArn()
The Amazon Resource Name (ARN) of the labeling job.
|
Instant |
lastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
|
ModelArtifacts |
modelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
|
OutputDataConfig |
outputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored.
|
ResourceConfig |
resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
String |
roleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
|
List<SdkField<?>> |
sdkFields() |
SecondaryStatus |
secondaryStatus()
Provides detailed information about the state of the training job.
|
String |
secondaryStatusAsString()
Provides detailed information about the state of the training job.
|
List<SecondaryStatusTransition> |
secondaryStatusTransitions()
A history of all of the secondary statuses that the training job has transitioned through.
|
static Class<? extends TrainingJob.Builder> |
serializableBuilderClass() |
StoppingCondition |
stoppingCondition()
The condition under which to stop the training job.
|
List<Tag> |
tags()
An array of key-value pairs.
|
TrainingJob.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Instant |
trainingEndTime()
Indicates the time when the training job ends on training instances.
|
String |
trainingJobArn()
The Amazon Resource Name (ARN) of the training job.
|
String |
trainingJobName()
The name of the training job.
|
TrainingJobStatus |
trainingJobStatus()
The status of the training job.
|
String |
trainingJobStatusAsString()
The status of the training job.
|
Instant |
trainingStartTime()
Indicates the time when the training job starts on training instances.
|
String |
tuningJobArn()
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a
hyperparameter tuning job.
|
VpcConfig |
vpcConfig()
A VpcConfig object that specifies the VPC that this training job has access to.
|
copy
public String trainingJobName()
The name of the training job.
public String trainingJobArn()
The Amazon Resource Name (ARN) of the training job.
public String tuningJobArn()
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
public String labelingJobArn()
The Amazon Resource Name (ARN) of the labeling job.
public ModelArtifacts modelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
public TrainingJobStatus trainingJobStatus()
The status of the training job.
Training job statuses are:
InProgress
- The training is in progress.
Completed
- The training job has completed.
Failed
- The training job has failed. To see the reason for the failure, see the
FailureReason
field in the response to a DescribeTrainingJobResponse
call.
Stopping
- The training job is stopping.
Stopped
- The training job has stopped.
For more detailed information, see SecondaryStatus
.
If the service returns an enum value that is not available in the current SDK version, trainingJobStatus
will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from trainingJobStatusAsString()
.
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
public String trainingJobStatusAsString()
The status of the training job.
Training job statuses are:
InProgress
- The training is in progress.
Completed
- The training job has completed.
Failed
- The training job has failed. To see the reason for the failure, see the
FailureReason
field in the response to a DescribeTrainingJobResponse
call.
Stopping
- The training job is stopping.
Stopped
- The training job has stopped.
For more detailed information, see SecondaryStatus
.
If the service returns an enum value that is not available in the current SDK version, trainingJobStatus
will return TrainingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from trainingJobStatusAsString()
.
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
public 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
If the service returns an enum value that is not available in the current SDK version, secondaryStatus
will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from secondaryStatusAsString()
.
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
public String secondaryStatusAsString()
Provides detailed information about the state of the training job. For detailed information about the secondary
status of the training job, see StatusMessage
under SecondaryStatusTransition.
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
If the service returns an enum value that is not available in the current SDK version, secondaryStatus
will return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from secondaryStatusAsString()
.
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
public String failureReason()
If the training job failed, the reason it failed.
public Map<String,String> hyperParameters()
Algorithm-specific parameters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AlgorithmSpecification algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
public String roleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
public List<Channel> inputDataConfig()
An array of Channel
objects that describes each data input channel.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Channel
objects that describes each data input channel.public OutputDataConfig outputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
public ResourceConfig resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
public 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.
public StoppingCondition stoppingCondition()
The condition under which to stop the training job.
public Instant creationTime()
A timestamp that indicates when the training job was created.
public 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.
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.public 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.
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.public Instant lastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
public List<SecondaryStatusTransition> secondaryStatusTransitions()
A history of all of the secondary statuses that the training job has transitioned through.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<MetricData> finalMetricDataList()
A list of final metric values that are set when the Training Job completes. Used only if the training job was configured to use metrics.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
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.public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public TrainingJob.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<TrainingJob.Builder,TrainingJob>
public static TrainingJob.Builder builder()
public static Class<? extends TrainingJob.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.