Struct HyperParameterTuningJobObjective

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

Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter. If you want to define a custom objective metric, see Define metrics and environment variables.

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>

Whether to minimize or maximize the objective metric.

metric_name: Option<String>

The name of the metric to use for the objective metric.

Implementations

impl HyperParameterTuningJobObjective

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

Whether to minimize or maximize the objective metric.

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

The name of the metric to use for the objective metric.

impl HyperParameterTuningJobObjective

pub fn builder() -> HyperParameterTuningJobObjectiveBuilder

Creates a new builder-style object to manufacture HyperParameterTuningJobObjective.

Trait Implementations

impl Clone for HyperParameterTuningJobObjective

fn clone(&self) -> HyperParameterTuningJobObjective

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperParameterTuningJobObjective

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

Formats the value using the given formatter.

impl PartialEq for HyperParameterTuningJobObjective

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