Struct linfa_elasticnet::ElasticNetParamsBase

pub struct ElasticNetParamsBase<F, const MULTI_TASK: bool>(/* private fields */);

Implementations

impl<F: Float, const MULTI_TASK: bool> ElasticNetParamsBase<F, MULTI_TASK>

Configure and fit a Elastic Net model

pub fn new() -> ElasticNetParamsBase<F, MULTI_TASK>

Create default elastic net hyper parameters

By default, an intercept will be fitted. To disable fitting an intercept, call .with_intercept(false) before calling .fit().

To additionally normalize the feature matrix before fitting, call fit_intercept_and_normalize() before calling fit(). The feature matrix will not be normalized by default.

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

Set the overall parameter penalty parameter of the elastic net, otherwise known as alpha. Use l1_ratio to configure how the penalty distributed to L1 and L2 regularization.

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

Set l1_ratio parameter of the elastic net. Controls how the parameter penalty is distributed to L1 and L2 regularization. Setting l1_ratio to 1.0 is equivalent to a “Lasso” penalization, setting it to 0.0 is equivalent to “Ridge” penalization.

Defaults to 0.5 if not set

l1_ratio must be between 0.0 and 1.0.

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

Configure the elastic net model to fit an intercept. Defaults to true if not set.

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

Set the tolerance which is the minimum absolute change in any of the model parameters needed for the parameter optimization to continue.

Defaults to 1e-4 if not set

pub fn max_iterations(self, max_iterations: u32) -> Self

Set the maximum number of iterations for the optimization routine.

Defaults to 1000 if not set

Trait Implementations

impl<F: Clone, const MULTI_TASK: bool> Clone for ElasticNetParamsBase<F, MULTI_TASK>

fn clone(&self) -> ElasticNetParamsBase<F, MULTI_TASK>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug, const MULTI_TASK: bool> Debug for ElasticNetParamsBase<F, MULTI_TASK>

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

Formats the value using the given formatter.

impl<F: Float, const MULTI_TASK: bool> Default for ElasticNetParamsBase<F, MULTI_TASK>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float, const MULTI_TASK: bool> ParamGuard for ElasticNetParamsBase<F, MULTI_TASK>

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

Validate the hyper parameters

type Checked = ElasticNetValidParamsBase<F, MULTI_TASK>

The checked hyperparameters

type Error = ElasticNetError

Error type resulting from failed hyperparameter checking

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

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, const MULTI_TASK: bool> PartialEq for ElasticNetParamsBase<F, MULTI_TASK>

fn eq(&self, other: &ElasticNetParamsBase<F, MULTI_TASK>) -> 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: Eq, const MULTI_TASK: bool> Eq for ElasticNetParamsBase<F, MULTI_TASK>

impl<F, const MULTI_TASK: bool> StructuralEq for ElasticNetParamsBase<F, MULTI_TASK>

impl<F, const MULTI_TASK: bool> StructuralPartialEq for ElasticNetParamsBase<F, MULTI_TASK>