linfa_bayes

Struct MultinomialNbParams

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

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

NameDefaultPurposeRange
alpha1Additive (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§

Source§

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

Source

pub fn new() -> Self

Create new MultinomialNbParams set with default values for its parameters

Source

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§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

type Checked = MultinomialNbValidParams<F, L>

The checked hyperparameters
Source§

type Error = NaiveBayesError

Error type resulting from failed hyperparameter checking
Source§

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

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

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
Source§

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

Source§

fn eq(&self, other: &MultinomialNbParams<F, L>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

Auto Trait Implementations§

§

impl<F, L> Freeze for MultinomialNbParams<F, L>
where F: Freeze,

§

impl<F, L> RefUnwindSafe for MultinomialNbParams<F, L>
where F: RefUnwindSafe, L: RefUnwindSafe,

§

impl<F, L> Send for MultinomialNbParams<F, L>
where F: Send, L: Send,

§

impl<F, L> Sync for MultinomialNbParams<F, L>
where F: Sync, L: Sync,

§

impl<F, L> Unpin for MultinomialNbParams<F, L>
where F: Unpin, L: Unpin,

§

impl<F, L> UnwindSafe for MultinomialNbParams<F, L>
where F: UnwindSafe, L: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V