StoppingCondition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.StoppingCondition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StoppingCondition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, 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.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StoppingCondition()

Constructors
Constructor and Description
`StoppingCondition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StoppingCondition`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getMaxRuntimeInSeconds()` The maximum length of time, in seconds, that a training or compilation job can run.
`Integer`	`getMaxWaitTimeInSeconds()` The maximum length of time, in seconds, that a managed Spot training job has to complete.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)` The maximum length of time, in seconds, that a training or compilation job can run.
`void`	`setMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds)` The maximum length of time, in seconds, that a managed Spot training job has to complete.
`String`	`toString()` Returns a string representation of this object.
`StoppingCondition`	`withMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)` The maximum length of time, in seconds, that a training or compilation job can run.
`StoppingCondition`	`withMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds)` The maximum length of time, in seconds, that a managed Spot training job has to complete.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StoppingCondition
```
public StoppingCondition()
```
- Method Detail
  - setMaxRuntimeInSeconds
```
public void setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)
```
    The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
    
    Parameters:
    
    maxRuntimeInSeconds - The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
  - getMaxRuntimeInSeconds
```
public Integer getMaxRuntimeInSeconds()
```
    The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
    
    Returns:
    
    The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
  - withMaxRuntimeInSeconds
```
public StoppingCondition withMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)
```
    The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
    
    Parameters:
    
    maxRuntimeInSeconds - The maximum length of time, in seconds, that a training or compilation job can run.
    
    For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
    
    For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxWaitTimeInSeconds
```
public void setMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds)
```
    The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
    
    Parameters:
    
    maxWaitTimeInSeconds - The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
  - getMaxWaitTimeInSeconds
```
public Integer getMaxWaitTimeInSeconds()
```
    The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
    
    Returns:
    
    The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
  - withMaxWaitTimeInSeconds
```
public StoppingCondition withMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds)
```
    The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
    
    Parameters:
    
    maxWaitTimeInSeconds - The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.
    
    When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StoppingCondition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class StoppingCondition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StoppingCondition

Method Detail

setMaxRuntimeInSeconds

getMaxRuntimeInSeconds

withMaxRuntimeInSeconds

setMaxWaitTimeInSeconds

getMaxWaitTimeInSeconds

withMaxWaitTimeInSeconds

toString

equals

hashCode

clone

marshall