Struct linfa_linear::TweedieRegressorParams

pub struct TweedieRegressorParams<F>(/* private fields */);

The set of hyperparameters that can be specified for the execution of the Tweedie Regressor.

Implementations

impl<F: Float> TweedieRegressorParams<F>

pub fn new() -> Self

pub fn alpha(self, alpha: F) -> Self

Constant that multiplies with the penalty term and thus determines the regularization strenght. alpha set to 0 is equivalent to unpenalized GLM.

pub fn fit_intercept(self, fit_intercept: bool) -> Self

Specifies whether a bias or intercept should be added to the model

pub fn power(self, power: F) -> Self

The power determines the underlying target distribution

pub fn link(self, link: Link) -> Self

The link function of the GLM, for mapping from linear predictor x @ coeff + intercept to the prediction. If no value is set, the link will be selected based on the following,

• identity for Normal distribution (power = 0)
• log for Poisson, Gamma and Inverse Gaussian distributions (power >= 1)

pub fn max_iter(self, max_iter: usize) -> Self

Maximum number of iterations for the LBFGS solver

pub fn tol(self, tol: F) -> Self

Stopping criterion for the LBFGS solver

Trait Implementations

impl<F: Clone> Clone for TweedieRegressorParams<F>

fn clone(&self) -> TweedieRegressorParams<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for TweedieRegressorParams<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for TweedieRegressorParams<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float> ParamGuard for TweedieRegressorParams<F>

type Checked = TweedieRegressorValidParams<F>

The checked hyperparameters

type Error = LinearError<F>

Error type resulting from failed hyperparameter checking

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

fn check_unwrap(self) -> Self::Checked

where Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq> PartialEq for TweedieRegressorParams<F>

fn eq(&self, other: &TweedieRegressorParams<F>) -> 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<F> StructuralPartialEq for TweedieRegressorParams<F>