Class TrainingJobDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TrainingJobDefinition.Builder,
TrainingJobDefinition>
Defines the input needed to run a training job using the algorithm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HyperParameters property.final boolean
For responses, this returns true if the service returned a value for the InputDataConfig property.The hyperparameters used for the training job.An array ofChannel
objects, each of which specifies an input source.final OutputDataConfig
the path to the S3 bucket where you want to store model artifacts.final ResourceConfig
The resources, including the ML compute instances and ML storage volumes, to use for model training.static Class
<? extends TrainingJobDefinition.Builder> final StoppingCondition
Specifies a limit to how long a model training job can run.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TrainingInputMode
Returns the value of the TrainingInputMode property for this object.final String
Returns the value of the TrainingInputMode property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
trainingInputMode
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
trainingInputModeAsString
Returns the value of the TrainingInputMode property for this object.If the service returns an enum value that is not available in the current SDK version,
trainingInputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtrainingInputModeAsString()
.- Returns:
- The value of the TrainingInputMode property for this object.
- See Also:
-
hasHyperParameters
public final boolean hasHyperParameters()For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
hyperParameters
The hyperparameters used for the training job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasHyperParameters()
method.- Returns:
- The hyperparameters used for the training job.
-
hasInputDataConfig
public final boolean hasInputDataConfig()For responses, this returns true if the service returned a value for the InputDataConfig property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
inputDataConfig
An array of
Channel
objects, each of which specifies an input source.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInputDataConfig()
method.- Returns:
- An array of
Channel
objects, each of which specifies an input source.
-
outputDataConfig
the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
- Returns:
- the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
-
resourceConfig
The resources, including the ML compute instances and ML storage volumes, to use for model training.
- Returns:
- The resources, including the ML compute instances and ML storage volumes, to use for model training.
-
stoppingCondition
Specifies a limit to how long a model training 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 job. Use this API to cap model training costs.
To stop a 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.
- Returns:
- Specifies a limit to how long a model training 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 job. Use
this API to cap model training costs.
To stop a 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TrainingJobDefinition.Builder,
TrainingJobDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-