Struct TrainingJobDefinitionBuilder

#[non_exhaustive]
pub struct TrainingJobDefinitionBuilder { /* private fields */ }

A builder for TrainingJobDefinition.

Implementations

impl TrainingJobDefinitionBuilder

pub fn training_input_mode(self, input: TrainingInputMode) -> Self

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

This field is required.

pub fn set_training_input_mode(self, input: Option<TrainingInputMode>) -> Self

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

pub fn get_training_input_mode(&self) -> &Option<TrainingInputMode>

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

pub fn hyper_parameters( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to hyper_parameters.

To override the contents of this collection use set_hyper_parameters.

The hyperparameters used for the training job.

pub fn set_hyper_parameters( self, input: Option<HashMap<String, String>>, ) -> Self

The hyperparameters used for the training job.

pub fn get_hyper_parameters(&self) -> &Option<HashMap<String, String>>

The hyperparameters used for the training job.

pub fn input_data_config(self, input: Channel) -> Self

Appends an item to input_data_config.

To override the contents of this collection use set_input_data_config.

An array of Channel objects, each of which specifies an input source.

pub fn set_input_data_config(self, input: Option<Vec<Channel>>) -> Self

An array of Channel objects, each of which specifies an input source.

pub fn get_input_data_config(&self) -> &Option<Vec<Channel>>

An array of Channel objects, each of which specifies an input source.

pub fn output_data_config(self, input: OutputDataConfig) -> Self

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

This field is required.

pub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

pub fn get_output_data_config(&self) -> &Option<OutputDataConfig>

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

pub fn resource_config(self, input: ResourceConfig) -> Self

The resources, including the ML compute instances and ML storage volumes, to use for model training.

This field is required.

pub fn set_resource_config(self, input: Option<ResourceConfig>) -> Self

The resources, including the ML compute instances and ML storage volumes, to use for model training.

pub fn get_resource_config(&self) -> &Option<ResourceConfig>

The resources, including the ML compute instances and ML storage volumes, to use for model training.

pub fn stopping_condition(self, input: StoppingCondition) -> Self

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 field is required.

pub fn set_stopping_condition(self, input: Option<StoppingCondition>) -> Self

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.

pub fn get_stopping_condition(&self) -> &Option<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.

pub fn build(self) -> TrainingJobDefinition

Consumes the builder and constructs a TrainingJobDefinition.

Trait Implementations

impl Clone for TrainingJobDefinitionBuilder

fn clone(&self) -> TrainingJobDefinitionBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrainingJobDefinitionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TrainingJobDefinitionBuilder

fn default() -> TrainingJobDefinitionBuilder

Returns the “default value” for a type.

impl PartialEq for TrainingJobDefinitionBuilder

fn eq(&self, other: &TrainingJobDefinitionBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TrainingJobDefinitionBuilder