@Generated(value="software.amazon.awssdk:codegen") public final class DescribeTrainingJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeTrainingJobResponse.Builder,DescribeTrainingJobResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeTrainingJobResponse.Builder |
Modifier and Type | Method and Description |
---|---|
AlgorithmSpecification |
algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
|
String |
autoMLJobArn()
The Amazon Resource Name (ARN) of an AutoML job.
|
Integer |
billableTimeInSeconds()
The billable time in seconds.
|
static DescribeTrainingJobResponse.Builder |
builder() |
CheckpointConfig |
checkpointConfig()
Returns the value of the CheckpointConfig property for this object.
|
Instant |
creationTime()
A timestamp that indicates when the training job was created.
|
DebugHookConfig |
debugHookConfig()
Returns the value of the DebugHookConfig property for this object.
|
List<DebugRuleConfiguration> |
debugRuleConfigurations()
Configuration information for Debugger rules for debugging output tensors.
|
List<DebugRuleEvaluationStatus> |
debugRuleEvaluationStatuses()
Evaluation status of Debugger rules for debugging on a training job.
|
Boolean |
enableInterContainerTrafficEncryption()
To encrypt all communications between ML compute instances in distributed training, choose
True . |
Boolean |
enableManagedSpotTraining()
A Boolean indicating whether managed spot training is enabled (
True ) or not (False ). |
Boolean |
enableNetworkIsolation()
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster
for distributed training, choose
True . |
Map<String,String> |
environment()
The environment variables to set in the Docker container.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
ExperimentConfig |
experimentConfig()
Returns the value of the ExperimentConfig property for this object.
|
String |
failureReason()
If the training job failed, the reason it failed.
|
List<MetricData> |
finalMetricDataList()
A collection of
MetricData objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDebugRuleConfigurations()
Returns true if the DebugRuleConfigurations property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasDebugRuleEvaluationStatuses()
Returns true if the DebugRuleEvaluationStatuses property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
boolean |
hasEnvironment()
Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasFinalMetricDataList()
Returns true if the FinalMetricDataList property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasHyperParameters()
Returns true if the HyperParameters property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasInputDataConfig()
Returns true if the InputDataConfig property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasProfilerRuleConfigurations()
Returns true if the ProfilerRuleConfigurations property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
boolean |
hasProfilerRuleEvaluationStatuses()
Returns true if the ProfilerRuleEvaluationStatuses property was specified by the sender (it may be empty), or
false if the sender did not specify the value (it will be empty).
|
boolean |
hasSecondaryStatusTransitions()
Returns true if the SecondaryStatusTransitions property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
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 Amazon SageMaker Ground Truth labeling job that created the transform or
training 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.
|
ProfilerConfig |
profilerConfig()
Returns the value of the ProfilerConfig property for this object.
|
List<ProfilerRuleConfiguration> |
profilerRuleConfigurations()
Configuration information for Debugger rules for profiling system and framework metrics.
|
List<ProfilerRuleEvaluationStatus> |
profilerRuleEvaluationStatuses()
Evaluation status of Debugger rules for profiling on a training job.
|
ProfilingStatus |
profilingStatus()
Profiling status of a training job.
|
String |
profilingStatusAsString()
Profiling status of a training job.
|
ResourceConfig |
resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
RetryStrategy |
retryStrategy()
The number of times to retry the job when the job fails due to an
InternalServerError . |
String |
roleArn()
The Amazon Web Services 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 DescribeTrainingJobResponse.Builder> |
serializableBuilderClass() |
StoppingCondition |
stoppingCondition()
Specifies a limit to how long a model training job can run.
|
TensorBoardOutputConfig |
tensorBoardOutputConfig()
Returns the value of the TensorBoardOutputConfig property for this object.
|
DescribeTrainingJobResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
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()
Name of the model 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.
|
Integer |
trainingTimeInSeconds()
The training time in seconds.
|
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.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String trainingJobName()
Name of the model training job.
public final String trainingJobArn()
The Amazon Resource Name (ARN) of the training job.
public final String tuningJobArn()
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
public final String labelingJobArn()
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
public final String autoMLJobArn()
The Amazon Resource Name (ARN) of an AutoML job.
public final ModelArtifacts modelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
public final TrainingJobStatus trainingJobStatus()
The status of the training job.
Amazon SageMaker provides the following training job statuses:
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()
.
Amazon SageMaker provides the following training job statuses:
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 final String trainingJobStatusAsString()
The status of the training job.
Amazon SageMaker provides the following training job statuses:
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()
.
Amazon SageMaker provides the following training job statuses:
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 final SecondaryStatus secondaryStatus()
Provides detailed information about the state of the training job. For detailed information on 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.
Interrupted
- The job stopped because the managed spot training instances were interrupted.
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.
MaxWaitTimeExceeded
- The job stopped because it exceeded the maximum allowed wait time.
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
PreparingTraining
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.
Interrupted
- The job stopped because the managed spot training instances were interrupted.
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.
MaxWaitTimeExceeded
- The job stopped because it exceeded the maximum allowed wait time.
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
PreparingTraining
DownloadingTrainingImage
SecondaryStatus
public final String secondaryStatusAsString()
Provides detailed information about the state of the training job. For detailed information on 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.
Interrupted
- The job stopped because the managed spot training instances were interrupted.
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.
MaxWaitTimeExceeded
- The job stopped because it exceeded the maximum allowed wait time.
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
PreparingTraining
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.
Interrupted
- The job stopped because the managed spot training instances were interrupted.
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.
MaxWaitTimeExceeded
- The job stopped because it exceeded the maximum allowed wait time.
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
PreparingTraining
DownloadingTrainingImage
SecondaryStatus
public final String failureReason()
If the training job failed, the reason it failed.
public final boolean hasHyperParameters()
public final Map<String,String> hyperParameters()
Algorithm-specific parameters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasHyperParameters()
to see if a value was sent in this field.
public final AlgorithmSpecification algorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
public final String roleArn()
The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.
public final boolean hasInputDataConfig()
public final 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.
You can use hasInputDataConfig()
to see if a value was sent in this field.
Channel
objects that describes each data input channel.public final 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 final ResourceConfig resourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
public final VpcConfig vpcConfig()
A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
public final StoppingCondition stoppingCondition()
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon 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.
To stop a job, Amazon 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.
public final Instant creationTime()
A timestamp that indicates when the training job was created.
public final Instant trainingStartTime()
Indicates the time when the training job starts on training instances. You are billed for the time interval
between this time and the value of TrainingEndTime
. The start time in CloudWatch Logs might be later
than this time. The difference is due to the time it takes to download the training data and to the size of the
training container.
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 final Instant trainingEndTime()
Indicates the time when the training job ends on training instances. You are billed for the time interval between
the value of TrainingStartTime
and this time. For successful jobs and stopped jobs, this is the time
after model artifacts are uploaded. For failed jobs, this is the time when 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 final Instant lastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
public final boolean hasSecondaryStatusTransitions()
public final List<SecondaryStatusTransition> secondaryStatusTransitions()
A history of all of the secondary statuses that the training job has transitioned through.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecondaryStatusTransitions()
to see if a value was sent in this field.
public final boolean hasFinalMetricDataList()
public final List<MetricData> finalMetricDataList()
A collection of MetricData
objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFinalMetricDataList()
to see if a value was sent in this field.
MetricData
objects that specify the names, values, and dates and times that
the training algorithm emitted to Amazon CloudWatch.public final Boolean enableNetworkIsolation()
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster
for distributed training, choose True
. If you enable network isolation for training jobs that are
configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the
specified VPC, but the training container does not have network access.
True
. If you enable network isolation for training
jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model
artifacts through the specified VPC, but the training container does not have network access.public final Boolean enableInterContainerTrafficEncryption()
To encrypt all communications between ML compute instances in distributed training, choose True
.
Encryption provides greater security for distributed training, but training might take longer. How long it takes
depends on the amount of communication between compute instances, especially if you use a deep learning
algorithms in distributed training.
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 algorithms in distributed training.public final Boolean enableManagedSpotTraining()
A Boolean indicating whether managed spot training is enabled (True
) or not (False
).
True
) or not (
False
).public final CheckpointConfig checkpointConfig()
public final Integer trainingTimeInSeconds()
The training time in seconds.
public final Integer billableTimeInSeconds()
The billable time in seconds. Billable time refers to the absolute wall-clock time.
Multiply BillableTimeInSeconds
by the number of instances (InstanceCount
) in your
training cluster to get the total compute time Amazon SageMaker will bill you if you run distributed training.
The formula is as follows: BillableTimeInSeconds * InstanceCount
.
You can calculate the savings from using managed spot training using the formula
(1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100
. For example, if
BillableTimeInSeconds
is 100 and TrainingTimeInSeconds
is 500, the savings is 80%.
Multiply BillableTimeInSeconds
by the number of instances (InstanceCount
) in
your training cluster to get the total compute time Amazon SageMaker will bill you if you run distributed
training. The formula is as follows: BillableTimeInSeconds * InstanceCount
.
You can calculate the savings from using managed spot training using the formula
(1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100
. For example, if
BillableTimeInSeconds
is 100 and TrainingTimeInSeconds
is 500, the savings is
80%.
public final DebugHookConfig debugHookConfig()
public final ExperimentConfig experimentConfig()
public final boolean hasDebugRuleConfigurations()
public final List<DebugRuleConfiguration> debugRuleConfigurations()
Configuration information for Debugger rules for debugging output tensors.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDebugRuleConfigurations()
to see if a value was sent in this field.
public final TensorBoardOutputConfig tensorBoardOutputConfig()
public final boolean hasDebugRuleEvaluationStatuses()
public final List<DebugRuleEvaluationStatus> debugRuleEvaluationStatuses()
Evaluation status of Debugger rules for debugging on a training job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDebugRuleEvaluationStatuses()
to see if a value was sent in this field.
public final ProfilerConfig profilerConfig()
public final boolean hasProfilerRuleConfigurations()
public final List<ProfilerRuleConfiguration> profilerRuleConfigurations()
Configuration information for Debugger rules for profiling system and framework metrics.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProfilerRuleConfigurations()
to see if a value was sent in this field.
public final boolean hasProfilerRuleEvaluationStatuses()
public final List<ProfilerRuleEvaluationStatus> profilerRuleEvaluationStatuses()
Evaluation status of Debugger rules for profiling on a training job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProfilerRuleEvaluationStatuses()
to see if a value was sent in this field.
public final ProfilingStatus profilingStatus()
Profiling status of a training job.
If the service returns an enum value that is not available in the current SDK version, profilingStatus
will return ProfilingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from profilingStatusAsString()
.
ProfilingStatus
public final String profilingStatusAsString()
Profiling status of a training job.
If the service returns an enum value that is not available in the current SDK version, profilingStatus
will return ProfilingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from profilingStatusAsString()
.
ProfilingStatus
public final RetryStrategy retryStrategy()
The number of times to retry the job when the job fails due to an InternalServerError
.
InternalServerError
.public final boolean hasEnvironment()
public final Map<String,String> environment()
The environment variables to set in the Docker container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnvironment()
to see if a value was sent in this field.
public DescribeTrainingJobResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DescribeTrainingJobResponse.Builder,DescribeTrainingJobResponse>
toBuilder
in class AwsResponse
public static DescribeTrainingJobResponse.Builder builder()
public static Class<? extends DescribeTrainingJobResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2021. All rights reserved.