@Generated(value="software.amazon.awssdk:codegen") public final class SecondaryStatusTransition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>
An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.
Modifier and Type | Class and Description |
---|---|
static interface |
SecondaryStatusTransition.Builder |
Modifier and Type | Method and Description |
---|---|
static SecondaryStatusTransition.Builder |
builder() |
Instant |
endTime()
A timestamp that shows when the training job transitioned out of this secondary status state into another
secondary status state or when the training job has ended.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends SecondaryStatusTransition.Builder> |
serializableBuilderClass() |
Instant |
startTime()
A timestamp that shows when the training job transitioned to the current secondary status state.
|
SecondaryStatus |
status()
Contains a secondary status information from a training job.
|
String |
statusAsString()
Contains a secondary status information from a training job.
|
String |
statusMessage()
A detailed description of the progress within a secondary status.
|
SecondaryStatusTransition.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final SecondaryStatus status()
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
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.
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, status
will
return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
Status might be one of the following secondary statuses:
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.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
SecondaryStatus
public final String statusAsString()
Contains a secondary status information from a training job.
Status might be one of the following secondary statuses:
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.
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, status
will
return SecondaryStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
Status might be one of the following secondary statuses:
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.
We no longer support the following secondary statuses:
LaunchingMLInstances
PreparingTrainingStack
DownloadingTrainingImage
SecondaryStatus
public final Instant startTime()
A timestamp that shows when the training job transitioned to the current secondary status state.
public final Instant endTime()
A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
public final String statusMessage()
A detailed description of the progress within a secondary status.
SageMaker provides secondary statuses and status messages that apply to each of them:
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Downloading the training image.
Training image download completed. Training in progress.
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus
and
SecondaryStatus
in DescribeTrainingJob, and StatusMessage
together. For example,
at the start of a training job, you might see the following:
TrainingJobStatus
- InProgress
SecondaryStatus
- Training
StatusMessage
- Downloading the training image
SageMaker provides secondary statuses and status messages that apply to each of them:
Starting the training job.
Launching requested ML instances.
Insufficient capacity error from EC2 while launching instances, retrying!
Launched instance was unhealthy, replacing it!
Preparing the instances for training.
Downloading the training image.
Training image download completed. Training in progress.
Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.
To have an overview of your training job's progress, view TrainingJobStatus
and
SecondaryStatus
in DescribeTrainingJob, and StatusMessage
together. For
example, at the start of a training job, you might see the following:
TrainingJobStatus
- InProgress
SecondaryStatus
- Training
StatusMessage
- Downloading the training image
public SecondaryStatusTransition.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<SecondaryStatusTransition.Builder,SecondaryStatusTransition>
public static SecondaryStatusTransition.Builder builder()
public static Class<? extends SecondaryStatusTransition.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.