@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeTrainingJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeTrainingJobResult() |
Modifier and Type | Method and Description |
---|---|
DescribeTrainingJobResult |
addHyperParametersEntry(String key,
String value) |
DescribeTrainingJobResult |
clearHyperParametersEntries()
Removes all the entries added into HyperParameters.
|
DescribeTrainingJobResult |
clone() |
boolean |
equals(Object obj) |
AlgorithmSpecification |
getAlgorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
|
Date |
getCreationTime()
A timestamp that indicates when the training job was created.
|
Boolean |
getEnableInterContainerTrafficEncryption()
To encrypt all communications between ML compute instances in distributed training, choose
True . |
Boolean |
getEnableNetworkIsolation()
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster
for distributed training, choose
True . |
String |
getFailureReason()
If the training job failed, the reason it failed.
|
List<MetricData> |
getFinalMetricDataList()
A collection of
MetricData objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch. |
Map<String,String> |
getHyperParameters()
Algorithm-specific parameters.
|
List<Channel> |
getInputDataConfig()
An array of
Channel objects that describes each data input channel. |
String |
getLabelingJobArn()
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or
training job.
|
Date |
getLastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
|
ModelArtifacts |
getModelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
|
OutputDataConfig |
getOutputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored.
|
ResourceConfig |
getResourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
String |
getRoleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
|
String |
getSecondaryStatus()
Provides detailed information about the state of the training job.
|
List<SecondaryStatusTransition> |
getSecondaryStatusTransitions()
A history of all of the secondary statuses that the training job has transitioned through.
|
StoppingCondition |
getStoppingCondition()
Specifies a limit to how long a model training job can run.
|
Date |
getTrainingEndTime()
Indicates the time when the training job ends on training instances.
|
String |
getTrainingJobArn()
The Amazon Resource Name (ARN) of the training job.
|
String |
getTrainingJobName()
Name of the model training job.
|
String |
getTrainingJobStatus()
The status of the training job.
|
Date |
getTrainingStartTime()
Indicates the time when the training job starts on training instances.
|
String |
getTuningJobArn()
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a
hyperparameter tuning job.
|
VpcConfig |
getVpcConfig()
A VpcConfig object that specifies the VPC that this training job has access to.
|
int |
hashCode() |
Boolean |
isEnableInterContainerTrafficEncryption()
To encrypt all communications between ML compute instances in distributed training, choose
True . |
Boolean |
isEnableNetworkIsolation()
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster
for distributed training, choose
True . |
void |
setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
void |
setCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
|
void |
setEnableInterContainerTrafficEncryption(Boolean enableInterContainerTrafficEncryption)
To encrypt all communications between ML compute instances in distributed training, choose
True . |
void |
setEnableNetworkIsolation(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 . |
void |
setFailureReason(String failureReason)
If the training job failed, the reason it failed.
|
void |
setFinalMetricDataList(Collection<MetricData> finalMetricDataList)
A collection of
MetricData objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch. |
void |
setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
|
void |
setInputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel objects that describes each data input channel. |
void |
setLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or
training job.
|
void |
setLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
|
void |
setModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
void |
setOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
void |
setResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
void |
setRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
|
void |
setSecondaryStatus(String secondaryStatus)
Provides detailed information about the state of the training job.
|
void |
setSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
void |
setStoppingCondition(StoppingCondition stoppingCondition)
Specifies a limit to how long a model training job can run.
|
void |
setTrainingEndTime(Date trainingEndTime)
Indicates the time when the training job ends on training instances.
|
void |
setTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
|
void |
setTrainingJobName(String trainingJobName)
Name of the model training job.
|
void |
setTrainingJobStatus(String trainingJobStatus)
The status of the training job.
|
void |
setTrainingStartTime(Date trainingStartTime)
Indicates the time when the training job starts on training instances.
|
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.
|
void |
setVpcConfig(VpcConfig vpcConfig)
A VpcConfig object that specifies the VPC that this training job has access to.
|
String |
toString()
Returns a string representation of this object.
|
DescribeTrainingJobResult |
withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
|
DescribeTrainingJobResult |
withCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
|
DescribeTrainingJobResult |
withEnableInterContainerTrafficEncryption(Boolean enableInterContainerTrafficEncryption)
To encrypt all communications between ML compute instances in distributed training, choose
True . |
DescribeTrainingJobResult |
withEnableNetworkIsolation(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 . |
DescribeTrainingJobResult |
withFailureReason(String failureReason)
If the training job failed, the reason it failed.
|
DescribeTrainingJobResult |
withFinalMetricDataList(Collection<MetricData> finalMetricDataList)
A collection of
MetricData objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch. |
DescribeTrainingJobResult |
withFinalMetricDataList(MetricData... finalMetricDataList)
A collection of
MetricData objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch. |
DescribeTrainingJobResult |
withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
|
DescribeTrainingJobResult |
withInputDataConfig(Channel... inputDataConfig)
An array of
Channel objects that describes each data input channel. |
DescribeTrainingJobResult |
withInputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel objects that describes each data input channel. |
DescribeTrainingJobResult |
withLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or
training job.
|
DescribeTrainingJobResult |
withLastModifiedTime(Date lastModifiedTime)
A timestamp that indicates when the status of the training job was last modified.
|
DescribeTrainingJobResult |
withModelArtifacts(ModelArtifacts modelArtifacts)
Information about the Amazon S3 location that is configured for storing model artifacts.
|
DescribeTrainingJobResult |
withOutputDataConfig(OutputDataConfig outputDataConfig)
The S3 path where model artifacts that you configured when creating the job are stored.
|
DescribeTrainingJobResult |
withResourceConfig(ResourceConfig resourceConfig)
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
|
DescribeTrainingJobResult |
withRoleArn(String roleArn)
The AWS Identity and Access Management (IAM) role configured for the training job.
|
DescribeTrainingJobResult |
withSecondaryStatus(SecondaryStatus secondaryStatus)
Provides detailed information about the state of the training job.
|
DescribeTrainingJobResult |
withSecondaryStatus(String secondaryStatus)
Provides detailed information about the state of the training job.
|
DescribeTrainingJobResult |
withSecondaryStatusTransitions(Collection<SecondaryStatusTransition> secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
DescribeTrainingJobResult |
withSecondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
|
DescribeTrainingJobResult |
withStoppingCondition(StoppingCondition stoppingCondition)
Specifies a limit to how long a model training job can run.
|
DescribeTrainingJobResult |
withTrainingEndTime(Date trainingEndTime)
Indicates the time when the training job ends on training instances.
|
DescribeTrainingJobResult |
withTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
|
DescribeTrainingJobResult |
withTrainingJobName(String trainingJobName)
Name of the model training job.
|
DescribeTrainingJobResult |
withTrainingJobStatus(String trainingJobStatus)
The status of the training job.
|
DescribeTrainingJobResult |
withTrainingJobStatus(TrainingJobStatus trainingJobStatus)
The status of the training job.
|
DescribeTrainingJobResult |
withTrainingStartTime(Date trainingStartTime)
Indicates the time when the training job starts on training instances.
|
DescribeTrainingJobResult |
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.
|
DescribeTrainingJobResult |
withVpcConfig(VpcConfig vpcConfig)
A VpcConfig object that specifies the VPC that this training job has access to.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setTrainingJobName(String trainingJobName)
Name of the model training job.
trainingJobName
- Name of the model training job.public String getTrainingJobName()
Name of the model training job.
public DescribeTrainingJobResult withTrainingJobName(String trainingJobName)
Name of the model training job.
trainingJobName
- Name of the model training job.public void setTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
trainingJobArn
- The Amazon Resource Name (ARN) of the training job.public String getTrainingJobArn()
The Amazon Resource Name (ARN) of the training job.
public DescribeTrainingJobResult withTrainingJobArn(String trainingJobArn)
The Amazon Resource Name (ARN) of the training job.
trainingJobArn
- The Amazon Resource Name (ARN) of the training job.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.
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 getTuningJobArn()
The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.
public DescribeTrainingJobResult 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.
tuningJobArn
- The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was
launched by a hyperparameter tuning job.public void setLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
labelingJobArn
- The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the
transform or training job.public String getLabelingJobArn()
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
public DescribeTrainingJobResult withLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
labelingJobArn
- The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the
transform or training job.public void setModelArtifacts(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.public ModelArtifacts getModelArtifacts()
Information about the Amazon S3 location that is configured for storing model artifacts.
public DescribeTrainingJobResult withModelArtifacts(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.public void setTrainingJobStatus(String 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
.
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
.
TrainingJobStatus
public String getTrainingJobStatus()
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
.
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 DescribeTrainingJobResult withTrainingJobStatus(String 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
.
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
.
TrainingJobStatus
public DescribeTrainingJobResult withTrainingJobStatus(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
.
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
.
TrainingJobStatus
public void setSecondaryStatus(String 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.
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 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.
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 getSecondaryStatus()
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.
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
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 DescribeTrainingJobResult withSecondaryStatus(String 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.
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 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.
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 DescribeTrainingJobResult withSecondaryStatus(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.
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 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.
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 void setFailureReason(String failureReason)
If the training job failed, the reason it failed.
failureReason
- If the training job failed, the reason it failed.public String getFailureReason()
If the training job failed, the reason it failed.
public DescribeTrainingJobResult withFailureReason(String failureReason)
If the training job failed, the reason it failed.
failureReason
- If the training job failed, the reason it failed.public Map<String,String> getHyperParameters()
Algorithm-specific parameters.
public void setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
hyperParameters
- Algorithm-specific parameters.public DescribeTrainingJobResult withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters.
hyperParameters
- Algorithm-specific parameters.public DescribeTrainingJobResult addHyperParametersEntry(String key, String value)
public DescribeTrainingJobResult clearHyperParametersEntries()
public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
algorithmSpecification
- Information about the algorithm used for training, and algorithm metadata.public AlgorithmSpecification getAlgorithmSpecification()
Information about the algorithm used for training, and algorithm metadata.
public DescribeTrainingJobResult withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Information about the algorithm used for training, and algorithm metadata.
algorithmSpecification
- Information about the algorithm used for training, and algorithm metadata.public void setRoleArn(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.public String getRoleArn()
The AWS Identity and Access Management (IAM) role configured for the training job.
public DescribeTrainingJobResult withRoleArn(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.public List<Channel> getInputDataConfig()
An array of Channel
objects that describes each data input channel.
Channel
objects that describes each data input channel.public void setInputDataConfig(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.public DescribeTrainingJobResult withInputDataConfig(Channel... inputDataConfig)
An array of Channel
objects that describes each data input channel.
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.
inputDataConfig
- An array of Channel
objects that describes each data input channel.public DescribeTrainingJobResult withInputDataConfig(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.public void setOutputDataConfig(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.public OutputDataConfig getOutputDataConfig()
The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
public DescribeTrainingJobResult withOutputDataConfig(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.public void setResourceConfig(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.public ResourceConfig getResourceConfig()
Resources, including ML compute instances and ML storage volumes, that are configured for model training.
public DescribeTrainingJobResult withResourceConfig(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.public void setVpcConfig(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.public VpcConfig getVpcConfig()
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 DescribeTrainingJobResult withVpcConfig(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.public void setStoppingCondition(StoppingCondition stoppingCondition)
Specifies a limit to how long a model training job can run. 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.
stoppingCondition
- Specifies a limit to how long a model training job can run. 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.
public StoppingCondition getStoppingCondition()
Specifies a limit to how long a model training job can run. 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 DescribeTrainingJobResult withStoppingCondition(StoppingCondition stoppingCondition)
Specifies a limit to how long a model training job can run. 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.
stoppingCondition
- Specifies a limit to how long a model training job can run. 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.
public void setCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
creationTime
- A timestamp that indicates when the training job was created.public Date getCreationTime()
A timestamp that indicates when the training job was created.
public DescribeTrainingJobResult withCreationTime(Date creationTime)
A timestamp that indicates when the training job was created.
creationTime
- A timestamp that indicates when the training job was created.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.
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.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.
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 DescribeTrainingJobResult 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.
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.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 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.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 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 DescribeTrainingJobResult 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 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.public void setLastModifiedTime(Date 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.public Date getLastModifiedTime()
A timestamp that indicates when the status of the training job was last modified.
public DescribeTrainingJobResult withLastModifiedTime(Date 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.public List<SecondaryStatusTransition> getSecondaryStatusTransitions()
A history of all of the secondary statuses that the training job has transitioned through.
public void setSecondaryStatusTransitions(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.public DescribeTrainingJobResult withSecondaryStatusTransitions(SecondaryStatusTransition... secondaryStatusTransitions)
A history of all of the secondary statuses that the training job has transitioned through.
NOTE: This method appends the values to the existing list (if any). Use
setSecondaryStatusTransitions(java.util.Collection)
or
withSecondaryStatusTransitions(java.util.Collection)
if you want to override the existing values.
secondaryStatusTransitions
- A history of all of the secondary statuses that the training job has transitioned through.public DescribeTrainingJobResult withSecondaryStatusTransitions(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.public List<MetricData> getFinalMetricDataList()
A collection of MetricData
objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch.
MetricData
objects that specify the names, values, and dates and times that
the training algorithm emitted to Amazon CloudWatch.public void setFinalMetricDataList(Collection<MetricData> finalMetricDataList)
A collection of MetricData
objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch.
finalMetricDataList
- A collection of MetricData
objects that specify the names, values, and dates and times that
the training algorithm emitted to Amazon CloudWatch.public DescribeTrainingJobResult withFinalMetricDataList(MetricData... finalMetricDataList)
A collection of MetricData
objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch.
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.
finalMetricDataList
- A collection of MetricData
objects that specify the names, values, and dates and times that
the training algorithm emitted to Amazon CloudWatch.public DescribeTrainingJobResult withFinalMetricDataList(Collection<MetricData> finalMetricDataList)
A collection of MetricData
objects that specify the names, values, and dates and times that the
training algorithm emitted to Amazon CloudWatch.
finalMetricDataList
- A collection of MetricData
objects that specify the names, values, and dates and times that
the training algorithm emitted to Amazon CloudWatch.public void setEnableNetworkIsolation(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.
The Semantic Segmentation built-in algorithm does not support network isolation.
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. The Semantic Segmentation built-in algorithm does not support network isolation.
public Boolean getEnableNetworkIsolation()
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.
The Semantic Segmentation built-in algorithm does not support network isolation.
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. The Semantic Segmentation built-in algorithm does not support network isolation.
public DescribeTrainingJobResult withEnableNetworkIsolation(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.
The Semantic Segmentation built-in algorithm does not support network isolation.
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. The Semantic Segmentation built-in algorithm does not support network isolation.
public Boolean isEnableNetworkIsolation()
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.
The Semantic Segmentation built-in algorithm does not support network isolation.
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. The Semantic Segmentation built-in algorithm does not support network isolation.
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
algorithms in distributed training.
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.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
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 DescribeTrainingJobResult 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
algorithms in distributed training.
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.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
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 String toString()
toString
in class Object
Object.toString()
public DescribeTrainingJobResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.