Struct aws_sdk_sagemaker::model::TrainingSpecification

#[non_exhaustive]
pub struct TrainingSpecification {
    pub training_image: Option<String>,
    pub training_image_digest: Option<String>,
    pub supported_hyper_parameters: Option<Vec<HyperParameterSpecification>>,
    pub supported_training_instance_types: Option<Vec<TrainingInstanceType>>,
    pub supports_distributed_training: bool,
    pub metric_definitions: Option<Vec<MetricDefinition>>,
    pub training_channels: Option<Vec<ChannelSpecification>>,
    pub supported_tuning_job_objective_metrics: Option<Vec<HyperParameterTuningJobObjective>>,
}

Defines how the algorithm is used for a training job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

training_image: Option<String>

The Amazon ECR registry path of the Docker image that contains the training algorithm.

training_image_digest: Option<String>

An MD5 hash of the training algorithm that identifies the Docker image used for training.

supported_hyper_parameters: Option<Vec<HyperParameterSpecification>>

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

supported_training_instance_types: Option<Vec<TrainingInstanceType>>

A list of the instance types that this algorithm can use for training.

supports_distributed_training: bool

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

metric_definitions: Option<Vec<MetricDefinition>>

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

training_channels: Option<Vec<ChannelSpecification>>

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

supported_tuning_job_objective_metrics: Option<Vec<HyperParameterTuningJobObjective>>

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

Implementations

impl TrainingSpecification

pub fn training_image(&self) -> Option<&str>

The Amazon ECR registry path of the Docker image that contains the training algorithm.

pub fn training_image_digest(&self) -> Option<&str>

An MD5 hash of the training algorithm that identifies the Docker image used for training.

pub fn supported_hyper_parameters(
    &self
) -> Option<&[HyperParameterSpecification]>

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

pub fn supported_training_instance_types(
    &self
) -> Option<&[TrainingInstanceType]>

A list of the instance types that this algorithm can use for training.

pub fn supports_distributed_training(&self) -> bool

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

pub fn metric_definitions(&self) -> Option<&[MetricDefinition]>

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

pub fn training_channels(&self) -> Option<&[ChannelSpecification]>

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

pub fn supported_tuning_job_objective_metrics(
    &self
) -> Option<&[HyperParameterTuningJobObjective]>

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

impl TrainingSpecification

pub fn builder() -> Builder

Creates a new builder-style object to manufacture TrainingSpecification

Trait Implementations

impl Clone for TrainingSpecification

fn clone(&self) -> TrainingSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrainingSpecification

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

Formats the value using the given formatter.

impl PartialEq<TrainingSpecification> for TrainingSpecification

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for TrainingSpecification