Interface TrainingJobDefinition.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<TrainingJobDefinition.Builder,TrainingJobDefinition>
,SdkBuilder<TrainingJobDefinition.Builder,TrainingJobDefinition>
,SdkPojo
- Enclosing class:
- TrainingJobDefinition
public static interface TrainingJobDefinition.Builder extends SdkPojo, CopyableBuilder<TrainingJobDefinition.Builder,TrainingJobDefinition>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TrainingJobDefinition.Builder
hyperParameters(Map<String,String> hyperParameters)
The hyperparameters used for the training job.TrainingJobDefinition.Builder
inputDataConfig(Collection<Channel> inputDataConfig)
An array ofChannel
objects, each of which specifies an input source.TrainingJobDefinition.Builder
inputDataConfig(Consumer<Channel.Builder>... inputDataConfig)
An array ofChannel
objects, each of which specifies an input source.TrainingJobDefinition.Builder
inputDataConfig(Channel... inputDataConfig)
An array ofChannel
objects, each of which specifies an input source.default TrainingJobDefinition.Builder
outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)
the path to the S3 bucket where you want to store model artifacts.TrainingJobDefinition.Builder
outputDataConfig(OutputDataConfig outputDataConfig)
the path to the S3 bucket where you want to store model artifacts.default TrainingJobDefinition.Builder
resourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)
The resources, including the ML compute instances and ML storage volumes, to use for model training.TrainingJobDefinition.Builder
resourceConfig(ResourceConfig resourceConfig)
The resources, including the ML compute instances and ML storage volumes, to use for model training.default TrainingJobDefinition.Builder
stoppingCondition(Consumer<StoppingCondition.Builder> stoppingCondition)
Specifies a limit to how long a model training job can run.TrainingJobDefinition.Builder
stoppingCondition(StoppingCondition stoppingCondition)
Specifies a limit to how long a model training job can run.TrainingJobDefinition.Builder
trainingInputMode(String trainingInputMode)
Sets the value of the TrainingInputMode property for this object.TrainingJobDefinition.Builder
trainingInputMode(TrainingInputMode trainingInputMode)
Sets the value of the TrainingInputMode property for this object.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
trainingInputMode
TrainingJobDefinition.Builder trainingInputMode(String trainingInputMode)
Sets the value of the TrainingInputMode property for this object.- Parameters:
trainingInputMode
- The new value for the TrainingInputMode property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingInputMode
,TrainingInputMode
-
trainingInputMode
TrainingJobDefinition.Builder trainingInputMode(TrainingInputMode trainingInputMode)
Sets the value of the TrainingInputMode property for this object.- Parameters:
trainingInputMode
- The new value for the TrainingInputMode property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TrainingInputMode
,TrainingInputMode
-
hyperParameters
TrainingJobDefinition.Builder hyperParameters(Map<String,String> hyperParameters)
The hyperparameters used for the training job.
- Parameters:
hyperParameters
- The hyperparameters used for the training job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
TrainingJobDefinition.Builder inputDataConfig(Collection<Channel> inputDataConfig)
An array of
Channel
objects, each of which specifies an input source.- Parameters:
inputDataConfig
- An array ofChannel
objects, each of which specifies an input source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
TrainingJobDefinition.Builder inputDataConfig(Channel... inputDataConfig)
An array of
Channel
objects, each of which specifies an input source.- Parameters:
inputDataConfig
- An array ofChannel
objects, each of which specifies an input source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
TrainingJobDefinition.Builder inputDataConfig(Consumer<Channel.Builder>... inputDataConfig)
An array of
This is a convenience method that creates an instance of theChannel
objects, each of which specifies an input source.Channel.Builder
avoiding the need to create one manually viaChannel.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#inputDataConfig(List
.) - Parameters:
inputDataConfig
- a consumer that will call methods onChannel.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#inputDataConfig(java.util.Collection
)
-
outputDataConfig
TrainingJobDefinition.Builder outputDataConfig(OutputDataConfig outputDataConfig)
the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
- Parameters:
outputDataConfig
- the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
default TrainingJobDefinition.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)
the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
This is a convenience method that creates an instance of theOutputDataConfig.Builder
avoiding the need to create one manually viaOutputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputDataConfig(OutputDataConfig)
.- Parameters:
outputDataConfig
- a consumer that will call methods onOutputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
outputDataConfig(OutputDataConfig)
-
resourceConfig
TrainingJobDefinition.Builder resourceConfig(ResourceConfig resourceConfig)
The resources, including the ML compute instances and ML storage volumes, to use for model training.
- Parameters:
resourceConfig
- The resources, including the ML compute instances and ML storage volumes, to use for model training.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceConfig
default TrainingJobDefinition.Builder resourceConfig(Consumer<ResourceConfig.Builder> resourceConfig)
The resources, including the ML compute instances and ML storage volumes, to use for model training.
This is a convenience method that creates an instance of theResourceConfig.Builder
avoiding the need to create one manually viaResourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceConfig(ResourceConfig)
.- Parameters:
resourceConfig
- a consumer that will call methods onResourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
resourceConfig(ResourceConfig)
-
stoppingCondition
TrainingJobDefinition.Builder stoppingCondition(StoppingCondition 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
stoppingCondition
default TrainingJobDefinition.Builder stoppingCondition(Consumer<StoppingCondition.Builder> 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.
This is a convenience method that creates an instance of theStoppingCondition.Builder
avoiding the need to create one manually viaStoppingCondition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostoppingCondition(StoppingCondition)
.- Parameters:
stoppingCondition
- a consumer that will call methods onStoppingCondition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
stoppingCondition(StoppingCondition)
-
-