Struct HyperParameterAlgorithmSpecification

pub struct HyperParameterAlgorithmSpecification {
    pub algorithm_name: Option<String>,
    pub metric_definitions: Option<Vec<MetricDefinition>>,
    pub training_image: Option<String>,
    pub training_input_mode: String,
}

Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

Fields

algorithm_name: Option<String>

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

metric_definitions: Option<Vec<MetricDefinition>>

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

training_image: Option<String>

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

training_input_mode: String

The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

For more information about input modes, see Algorithms.

Trait Implementations

impl Clone for HyperParameterAlgorithmSpecification

fn clone(&self) -> HyperParameterAlgorithmSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperParameterAlgorithmSpecification

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

Formats the value using the given formatter.

impl Default for HyperParameterAlgorithmSpecification

fn default() -> HyperParameterAlgorithmSpecification

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HyperParameterAlgorithmSpecification

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HyperParameterAlgorithmSpecification

fn eq(&self, other: &HyperParameterAlgorithmSpecification) -> 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 Serialize for HyperParameterAlgorithmSpecification

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HyperParameterAlgorithmSpecification