/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StoppingCondition implements Serializable, Cloneable, StructuredPojo { /** *

* The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. *

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or * archiving and uploading models after it has been stopped, is 30 days. *

*/ private Integer maxRuntimeInSeconds; /** *

* 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. *

*/ private Integer maxWaitTimeInSeconds; /** *

* The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. *

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or * archiving and uploading models after it has been stopped, is 30 days. *

* * @param maxRuntimeInSeconds * The maximum length of time, in seconds, that a training or compilation job can run before it is * stopped.

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing * metrics or archiving and uploading models after it has been stopped, is 30 days. */ public void setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds) { this.maxRuntimeInSeconds = maxRuntimeInSeconds; } /** *

* The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. *

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or * archiving and uploading models after it has been stopped, is 30 days. *

* * @return The maximum length of time, in seconds, that a training or compilation job can run before it is * stopped.

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing * metrics or archiving and uploading models after it has been stopped, is 30 days. */ public Integer getMaxRuntimeInSeconds() { return this.maxRuntimeInSeconds; } /** *

* The maximum length of time, in seconds, that a training or compilation job can run before it is stopped. *

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or * archiving and uploading models after it has been stopped, is 30 days. *

* * @param maxRuntimeInSeconds * The maximum length of time, in seconds, that a training or compilation job can run before it is * stopped.

*

* 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. *

*

* The maximum time that a TrainingJob can run in total, including any time spent publishing * metrics or archiving and uploading models after it has been stopped, is 30 days. * @return Returns a reference to this object so that method calls can be chained together. */ public StoppingCondition withMaxRuntimeInSeconds(Integer maxRuntimeInSeconds) { setMaxRuntimeInSeconds(maxRuntimeInSeconds); return this; } /** *

* 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. *

* * @param 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. */ public void setMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds) { this.maxWaitTimeInSeconds = 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. *

* * @return 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. */ public Integer getMaxWaitTimeInSeconds() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StoppingCondition withMaxWaitTimeInSeconds(Integer maxWaitTimeInSeconds) { setMaxWaitTimeInSeconds(maxWaitTimeInSeconds); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getMaxRuntimeInSeconds() != null) sb.append("MaxRuntimeInSeconds: ").append(getMaxRuntimeInSeconds()).append(","); if (getMaxWaitTimeInSeconds() != null) sb.append("MaxWaitTimeInSeconds: ").append(getMaxWaitTimeInSeconds()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StoppingCondition == false) return false; StoppingCondition other = (StoppingCondition) obj; if (other.getMaxRuntimeInSeconds() == null ^ this.getMaxRuntimeInSeconds() == null) return false; if (other.getMaxRuntimeInSeconds() != null && other.getMaxRuntimeInSeconds().equals(this.getMaxRuntimeInSeconds()) == false) return false; if (other.getMaxWaitTimeInSeconds() == null ^ this.getMaxWaitTimeInSeconds() == null) return false; if (other.getMaxWaitTimeInSeconds() != null && other.getMaxWaitTimeInSeconds().equals(this.getMaxWaitTimeInSeconds()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMaxRuntimeInSeconds() == null) ? 0 : getMaxRuntimeInSeconds().hashCode()); hashCode = prime * hashCode + ((getMaxWaitTimeInSeconds() == null) ? 0 : getMaxWaitTimeInSeconds().hashCode()); return hashCode; } @Override public StoppingCondition clone() { try { return (StoppingCondition) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.sagemaker.model.transform.StoppingConditionMarshaller.getInstance().marshall(this, protocolMarshaller); } }