Struct linfa_ftrl::FtrlParams

pub struct FtrlParams<F: Float, R: Rng>(_);

Implementations

impl<F: Float, R: Rng> FtrlParams<F, R>

pub fn new(alpha: F, beta: F, l1_ratio: F, l2_ratio: F, rng: R) -> Self

Create new hyperparameters with pre-defined values

pub fn default_with_rng(rng: R) -> Self

Create new hyperparameters with pre-defined random number generator

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

Set the learning rate.

Defaults to 0.005 if not set

alpha must be positive and finite

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

Set the beta parameter.

Defaults to 0.0 if not set

beta must be positive and finite

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

Set l1_ratio parameter. Controls how the parameter

Defaults to 0.5 if not set

l1_ratio must be between 0.0 and 1.0.

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

Set l2_ratio parameter. Controls how the parameter penalty is distributed to L2 regularization.

Defaults to 0.5 if not set

l2_ratio must be between 0.0 and 1.0.

pub fn rng(self, rng: R) -> Self

Set random number generator. Used to initialize Z values

Defaults to Xoshiro256Plus

rng must have Clone trait implemented.

Trait Implementations

impl<F: Clone + Float, R: Clone + Rng> Clone for FtrlParams<F, R>

fn clone(&self) -> FtrlParams<F, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float, R: Debug + Rng> Debug for FtrlParams<F, R>

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

Formats the value using the given formatter.

impl<'de, F: Float, R: Rng> Deserialize<'de> for FtrlParams<F, R> where
    F: Deserialize<'de>,
    R: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<F: Float, R: Rng> ParamGuard for FtrlParams<F, R>

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

Validate the hyper parameters

type Checked = FtrlValidParams<F, R>

The checked hyperparameters

type Error = FtrlError

Error type resulting from failed hyperparameter checking

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

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checked

Calls check() and unwraps the result

impl<F: PartialEq + Float, R: PartialEq + Rng> PartialEq<FtrlParams<F, R>> for FtrlParams<F, R>

fn eq(&self, other: &FtrlParams<F, R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FtrlParams<F, R>) -> bool

This method tests for !=.

impl<F: Float, R: Rng> Serialize for FtrlParams<F, R> where
    F: Serialize,
    R: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<F: Float, R: Rng> StructuralPartialEq for FtrlParams<F, R>