Trait linfa::param_guard::ParamGuard

pub trait ParamGuard {
    type Checked;
    type Error: Error;
    fn check_ref(&self) -> Result<&Self::Checked, Self::Error>;
    fn check(self) -> Result<Self::Checked, Self::Error>;

    fn check_unwrap(self) -> Self::Checked
    where
        Self: Sized,
    { ... }
}

A set of hyperparameters whose values have not been checked for validity. A reference to the checked hyperparameters can only be obtained after checking has completed. If the Transformer, Fit, or FitWith traits have been implemented on the checked hyperparameters, they will also be implemented on the unchecked hyperparameters with the checking step done automatically.

The hyperparameter validation done in check_ref() and check() should be identical.

Associated Types

type Checked

The checked hyperparameters

type Error: Error

Error type resulting from failed hyperparameter checking

Required methods

fn check_ref(&self) -> Result<&Self::Checked, Self::Error>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked, Self::Error>

Checks the hyperparameters and returns the checked hyperparameters if successful

Provided methods

fn check_unwrap(self) -> Self::Checked where
    Self: Sized, 

Calls check() and unwraps the result

Implementors

impl<F: Float, O> ParamGuard for PlattParams<F, O>

type Checked = PlattValidParams<F, O>

type Error = PlattError