Skip to main content

CategorizationModel

Struct CategorizationModel 

Source
pub struct CategorizationModel { /* private fields */ }
Expand description

A trained categorization model.

Wraps a Multinomial Naive Bayes classifier trained on TF-IDF features extracted from transaction payee/narration text.

Implementations§

Source§

impl CategorizationModel

Source

pub fn train(directives: &[DirectiveWrapper]) -> Result<Self, MlError>

Train a model from existing ledger directives.

Extracts (text, account) pairs from transactions where the second posting’s account is the categorization target. Requires at least 2 distinct categories with at least 1 transaction each.

§Errors

Returns MlError::InsufficientData if there aren’t enough transactions or distinct categories to train a useful model.

Source

pub fn predict( &self, narration: &str, payee: Option<&str>, ) -> Vec<(String, f64)>

Predict the account for a transaction.

Returns predictions sorted by confidence (highest first). Each prediction is an (account, probability) pair. The probabilities are the class-conditional posteriors from the underlying Multinomial Naive Bayes model (they sum to 1.0 across all classes), so callers can treat them as honest scores.

Source

pub const fn num_categories(&self) -> usize

Number of distinct categories the model was trained on.

Source

pub fn vocab_size(&self) -> usize

Number of features (vocabulary size).

Auto Trait Implementations§

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> 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, 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.