Struct aws_sdk_sagemaker::types::FinalHyperParameterTuningJobObjectiveMetric

#[non_exhaustive]
pub struct FinalHyperParameterTuningJobObjectiveMetric {
    pub type: Option<HyperParameterTuningJobObjectiveType>,
    pub metric_name: Option<String>,
    pub value: f32,
}

Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

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.

type: Option<HyperParameterTuningJobObjectiveType>

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

metric_name: Option<String>

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

value: f32

The value of the objective metric.

Implementations

impl FinalHyperParameterTuningJobObjectiveMetric

pub fn type(&self) -> Option<&HyperParameterTuningJobObjectiveType>

Select if you want to minimize or maximize the objective metric during hyperparameter tuning.

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

The name of the objective metric. For SageMaker built-in algorithms, metrics are defined per algorithm. See the metrics for XGBoost as an example. You can also use a custom algorithm for training and define your own metrics. For more information, see Define metrics and environment variables.

pub fn value(&self) -> f32

The value of the objective metric.

impl FinalHyperParameterTuningJobObjectiveMetric

pub fn builder() -> FinalHyperParameterTuningJobObjectiveMetricBuilder

Creates a new builder-style object to manufacture FinalHyperParameterTuningJobObjectiveMetric.

Trait Implementations

impl Clone for FinalHyperParameterTuningJobObjectiveMetric

fn clone(&self) -> FinalHyperParameterTuningJobObjectiveMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FinalHyperParameterTuningJobObjectiveMetric

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

Formats the value using the given formatter.

impl PartialEq<FinalHyperParameterTuningJobObjectiveMetric> for FinalHyperParameterTuningJobObjectiveMetric

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

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

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

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

impl StructuralPartialEq for FinalHyperParameterTuningJobObjectiveMetric