Struct aws_sdk_sagemaker::types::TuningJobCompletionCriteria

#[non_exhaustive]
pub struct TuningJobCompletionCriteria {
    pub target_objective_metric_value: Option<f32>,
    pub best_objective_not_improving: Option<BestObjectiveNotImproving>,
    pub convergence_detected: Option<ConvergenceDetected>,
}

The job completion criteria.

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.

target_objective_metric_value: Option<f32>

The value of the objective metric.

best_objective_not_improving: Option<BestObjectiveNotImproving>

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

convergence_detected: Option<ConvergenceDetected>

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

Implementations

impl TuningJobCompletionCriteria

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

The value of the objective metric.

pub fn best_objective_not_improving(&self) -> Option<&BestObjectiveNotImproving>

A flag to stop your hyperparameter tuning job if model performance fails to improve as evaluated against an objective function.

pub fn convergence_detected(&self) -> Option<&ConvergenceDetected>

A flag to top your hyperparameter tuning job if automatic model tuning (AMT) has detected that your model has converged as evaluated against your objective function.

impl TuningJobCompletionCriteria

pub fn builder() -> TuningJobCompletionCriteriaBuilder

Creates a new builder-style object to manufacture TuningJobCompletionCriteria.

Trait Implementations

impl Clone for TuningJobCompletionCriteria

fn clone(&self) -> TuningJobCompletionCriteria

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TuningJobCompletionCriteria

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

Formats the value using the given formatter.

impl PartialEq for TuningJobCompletionCriteria

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