Struct aws_sdk_sagemaker::types::builders::FinalHyperParameterTuningJobObjectiveMetricBuilder

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

A builder for FinalHyperParameterTuningJobObjectiveMetric.

Implementations

impl FinalHyperParameterTuningJobObjectiveMetricBuilder

pub fn type(self, input: HyperParameterTuningJobObjectiveType) -> Self

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

pub fn set_type( self, input: Option<HyperParameterTuningJobObjectiveType>, ) -> Self

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

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

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

pub fn metric_name(self, input: impl Into<String>) -> Self

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.

This field is required.

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

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 get_metric_name(&self) -> &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.

pub fn value(self, input: f32) -> Self

The value of the objective metric.

This field is required.

pub fn set_value(self, input: Option<f32>) -> Self

The value of the objective metric.

pub fn get_value(&self) -> &Option<f32>

The value of the objective metric.

pub fn build(self) -> FinalHyperParameterTuningJobObjectiveMetric

Consumes the builder and constructs a FinalHyperParameterTuningJobObjectiveMetric.

Trait Implementations

impl Clone for FinalHyperParameterTuningJobObjectiveMetricBuilder

fn clone(&self) -> FinalHyperParameterTuningJobObjectiveMetricBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FinalHyperParameterTuningJobObjectiveMetricBuilder

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

Formats the value using the given formatter.

impl Default for FinalHyperParameterTuningJobObjectiveMetricBuilder

fn default() -> FinalHyperParameterTuningJobObjectiveMetricBuilder

Returns the “default value” for a type.

impl PartialEq for FinalHyperParameterTuningJobObjectiveMetricBuilder

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