Struct linfa_bayes::MultinomialNbParams

pub struct MultinomialNbParams<F, L>(/* private fields */);

A hyper-parameter set during construction for a Multinomial Naive Bayes model.

The parameter set can be verified into a MultinomialNbValidParams by calling ParamGuard::check. It is also possible to directly fit a model with Fit::fit or FitWith::fit_with which implicitely verifies the parameter set prior to the model estimation and forwards any error.

See MultinomialNb for information on the model.

Parameters

Name	Default	Purpose	Range
alpha	1	Additive (Laplace/Lidstone) smoothing parameter (0 for no smoothing)	[0, inf)

Errors

The following errors can come from invalid hyper-parameters:

Returns InvalidSmoothing if the smoothing parameter is negative.

Implementations

impl<F: Float, L> MultinomialNbParams<F, L>

pub fn new() -> Self

Create new MultinomialNbParams set with default values for its parameters

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

Specifies the portion of the largest variance of all the features that is added to the variance for calculation stability

Trait Implementations

impl<F: Clone, L: Clone> Clone for MultinomialNbParams<F, L>

fn clone(&self) -> MultinomialNbParams<F, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug, L: Debug> Debug for MultinomialNbParams<F, L>

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

Formats the value using the given formatter.

impl<F: Float, L> Default for MultinomialNbParams<F, L>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float, L> ParamGuard for MultinomialNbParams<F, L>

type Checked = MultinomialNbValidParams<F, L>

The checked hyperparameters

type Error = NaiveBayesError

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::Checkedwhere Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq, L: PartialEq> PartialEq for MultinomialNbParams<F, L>

fn eq(&self, other: &MultinomialNbParams<F, L>) -> 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, L: Eq> Eq for MultinomialNbParams<F, L>

impl<F, L> StructuralEq for MultinomialNbParams<F, L>

impl<F, L> StructuralPartialEq for MultinomialNbParams<F, L>