Skip to main content

SparseTsetlinMachine

Struct SparseTsetlinMachine 

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

Sparse Tsetlin Machine for memory-efficient inference.

Inference-only model with 5-100x memory reduction compared to dense TsetlinMachine. Create via TsetlinMachine::to_sparse() after training.

§Example

use tsetlin_rs::{Config, TsetlinMachine};

let config = Config::builder().clauses(20).features(2).build().unwrap();
let mut tm = TsetlinMachine::new(config, 10);

let x = vec![vec![0, 0], vec![0, 1], vec![1, 0], vec![1, 1]];
let y = vec![0, 1, 1, 0];

tm.fit(&x, &y, 200, 42);

// Convert to sparse for deployment
let sparse = tm.to_sparse();

// Same predictions, less memory
assert_eq!(tm.predict(&x[0]), sparse.predict(&x[0]));

Implementations§

Source§

impl SparseTsetlinMachine

Source

pub fn from_clauses( clauses: &[Clause], n_features: usize, threshold: f32, ) -> Self

Creates from dense clauses.

§Arguments
  • clauses - Dense clauses to convert
  • n_features - Number of features
  • threshold - Classification threshold
Source

pub fn new(clauses: SparseClauseBank, threshold: f32) -> Self

Creates from pre-built sparse clause bank.

Source

pub const fn n_clauses(&self) -> usize

Returns number of clauses.

Source

pub const fn n_features(&self) -> usize

Returns number of features.

Source

pub const fn threshold(&self) -> f32

Returns threshold.

Source

pub fn predict(&self, x: &[u8]) -> u8

Predicts class (0 or 1).

Source

pub fn predict_packed(&self, x: &[u64]) -> u8

Predicts using packed u64 input.

Source

pub fn predict_batch(&self, xs: &[Vec<u8>]) -> Vec<u8>

Batch prediction.

Source

pub fn evaluate(&self, x: &[Vec<u8>], y: &[u8]) -> f32

Evaluates accuracy on test data.

Source

pub fn memory_stats(&self) -> SparseMemoryStats

Returns memory statistics.

Source

pub fn compression_ratio(&self) -> f32

Returns compression ratio compared to dense model.

Trait Implementations§

Source§

impl Clone for SparseTsetlinMachine

Source§

fn clone(&self) -> SparseTsetlinMachine

Returns a duplicate 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 Debug for SparseTsetlinMachine

Source§

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

Formats the value using the given formatter. Read more

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

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

Source§

fn vzip(self) -> V