Struct ConvergenceDetected

#[non_exhaustive]
pub struct ConvergenceDetected {
    pub complete_on_convergence: Option<CompleteOnConvergence>,
}

A flag to indicating that automatic model tuning (AMT) has detected model convergence, defined as a lack of significant improvement (1% or less) against an objective metric.

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.

complete_on_convergence: Option<CompleteOnConvergence>

A flag to stop a tuning job once AMT has detected that the job has converged.

Implementations

impl ConvergenceDetected

pub fn complete_on_convergence(&self) -> Option<&CompleteOnConvergence>

A flag to stop a tuning job once AMT has detected that the job has converged.

impl ConvergenceDetected

pub fn builder() -> ConvergenceDetectedBuilder

Creates a new builder-style object to manufacture ConvergenceDetected.

Trait Implementations

impl Clone for ConvergenceDetected

fn clone(&self) -> ConvergenceDetected

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvergenceDetected

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

Formats the value using the given formatter.

impl PartialEq for ConvergenceDetected

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