software.amazon.awscdk.services.stepfunctions.tasks

Interface SageMakerCreateTrainingJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

SageMakerCreateTrainingJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.541Z")
 @Stability(value=Stable)
public interface SageMakerCreateTrainingJobProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for creating an Amazon SageMaker training job.

Example:

 SageMakerCreateTrainingJob.Builder.create(this, "TrainSagemaker")
         .trainingJobName(JsonPath.stringAt("$.JobName"))
         .algorithmSpecification(AlgorithmSpecification.builder()
                 .algorithmName("BlazingText")
                 .trainingInputMode(InputMode.FILE)
                 .build())
         .inputDataConfig(List.of(Channel.builder()
                 .channelName("train")
                 .dataSource(DataSource.builder()
                         .s3DataSource(S3DataSource.builder()
                                 .s3DataType(S3DataType.S3_PREFIX)
                                 .s3Location(S3Location.fromJsonExpression("$.S3Bucket"))
                                 .build())
                         .build())
                 .build()))
         .outputDataConfig(OutputDataConfig.builder()
                 .s3OutputLocation(S3Location.fromBucket(Bucket.fromBucketName(this, "Bucket", "mybucket"), "myoutputpath"))
                 .build())
         .resourceConfig(ResourceConfig.builder()
                 .instanceCount(1)
                 .instanceType(new InstanceType(JsonPath.stringAt("$.InstanceType")))
                 .volumeSize(Size.gibibytes(50))
                 .build()) // optional: default is 1 instance of EC2 `M4.XLarge` with `10GB` volume
         .stoppingCondition(StoppingCondition.builder()
                 .maxRuntime(Duration.hours(2))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SageMakerCreateTrainingJobProps.Builder A builder for SageMakerCreateTrainingJobProps
static class	SageMakerCreateTrainingJobProps.Jsii$Proxy An implementation for SageMakerCreateTrainingJobProps

Method Summary

Modifier and Type	Method and Description
static SageMakerCreateTrainingJobProps.Builder	builder()
AlgorithmSpecification	getAlgorithmSpecification() Identifies the training algorithm to use.
default Boolean	getEnableNetworkIsolation() Isolates the training container.
default Map<String,String>	getEnvironment() Environment variables to set in the Docker container.
default Map<String,Object>	getHyperparameters() Algorithm-specific parameters that influence the quality of the model.
List<Channel>	getInputDataConfig() Describes the various datasets (e.g.
OutputDataConfig	getOutputDataConfig() Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.
default ResourceConfig	getResourceConfig() Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.
default IRole	getRole() Role for the Training Job.
default StoppingCondition	getStoppingCondition() Sets a time limit for training.
default Map<String,String>	getTags() Tags to be applied to the train job.
String	getTrainingJobName() Training Job Name.
default VpcConfig	getVpcConfig() Specifies the VPC that you want your training job to connect to.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlgorithmSpecification

@Stability(value=Stable)
 @NotNull
AlgorithmSpecification getAlgorithmSpecification()

Identifies the training algorithm to use.

getInputDataConfig

@Stability(value=Stable)
 @NotNull
List<Channel> getInputDataConfig()

Describes the various datasets (e.g. train, validation, test) and the Amazon S3 location where stored.

getOutputDataConfig

@Stability(value=Stable)
 @NotNull
OutputDataConfig getOutputDataConfig()

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training.

getTrainingJobName

@Stability(value=Stable)
 @NotNull
String getTrainingJobName()

Training Job Name.

getEnableNetworkIsolation

@Stability(value=Stable)
 @Nullable
default Boolean getEnableNetworkIsolation()

Isolates the training container.

No inbound or outbound network calls can be made to or from the training container.

Default: false

getEnvironment

@Stability(value=Stable)
 @Nullable
default Map<String,String> getEnvironment()

Environment variables to set in the Docker container.

Default: - No environment variables

getHyperparameters

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getHyperparameters()

Algorithm-specific parameters that influence the quality of the model.

Set hyperparameters before you start the learning process. For a list of hyperparameters provided by Amazon SageMaker

Default: - No hyperparameters

See Also:

https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html

getResourceConfig

@Stability(value=Stable)
 @Nullable
default ResourceConfig getResourceConfig()

Specifies the resources, ML compute instances, and ML storage volumes to deploy for model training.

Default: - 1 instance of EC2 `M4.XLarge` with `10GB` volume

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

Role for the Training Job.

The role must be granted all necessary permissions for the SageMaker training job to be able to operate.

See https://docs.aws.amazon.com/fr_fr/sagemaker/latest/dg/sagemaker-roles.html#sagemaker-roles-createtrainingjob-perms

Default: - a role will be created.

getStoppingCondition

@Stability(value=Stable)
 @Nullable
default StoppingCondition getStoppingCondition()

Sets a time limit for training.

Default: - max runtime of 1 hour

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

Tags to be applied to the train job.

Default: - No tags

getVpcConfig

@Stability(value=Stable)
 @Nullable
default VpcConfig getVpcConfig()

Specifies the VPC that you want your training job to connect to.

Default: - No VPC

builder

@Stability(value=Stable)
static SageMakerCreateTrainingJobProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a SageMakerCreateTrainingJobProps.Builder of SageMakerCreateTrainingJobProps