com.amazonaws.services.sagemaker.model

Class StoppingCondition

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 how long model training can run. When model training reaches the limit, Amazon SageMaker ends the training job. Use this API to cap model training cost.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of training is not lost.

Training algorithms provided by Amazon SageMaker automatically saves the intermediate results of a model training job (it is best effort case, as model might not be ready to save as some stages, for example training just started). This intermediate data is a valid model artifact. You can use it to create a model (CreateModel).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StoppingCondition()

Method Summary

Modifier and Type	Method and Description
StoppingCondition	clone()
boolean	equals(Object obj)
Integer	getMaxRuntimeInSeconds() The maximum length of time, in seconds, that the training job can run.
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 the training job can run.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StoppingCondition	withMaxRuntimeInSeconds(Integer maxRuntimeInSeconds) The maximum length of time, in seconds, that the training job can run.

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 the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

Parameters:

maxRuntimeInSeconds - The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

getMaxRuntimeInSeconds

public Integer getMaxRuntimeInSeconds()

The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

Returns:

The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

withMaxRuntimeInSeconds

public StoppingCondition withMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)

The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

Parameters:

maxRuntimeInSeconds - The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.

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; useful for testing and debugging.

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.