Struct aws_sdk_sagemaker::model::MetricDefinition

#[non_exhaustive]
pub struct MetricDefinition {
    pub name: Option<String>,
    pub regex: Option<String>,
}

Specifies a metric that the training algorithm writes to stderr or stdout. Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best 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.

name: Option<String>

The name of the metric.

regex: Option<String>

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

Implementations

impl MetricDefinition

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

The name of the metric.

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

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

impl MetricDefinition

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MetricDefinition

Trait Implementations

impl Clone for MetricDefinition

fn clone(&self) -> MetricDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDefinition

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

Formats the value using the given formatter.

impl PartialEq<MetricDefinition> for MetricDefinition

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

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

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

This method tests for !=.

impl StructuralPartialEq for MetricDefinition