Struct NMF 

pub struct NMF { /* private fields */ }

Non-negative Matrix Factorization (NMF)

Finds two non-negative matrices W and H whose product approximates the non-negative input matrix V. The objective function is minimized with multiplicative update rules.

Implementations

impl NMF

pub fn new(ncomponents: usize) -> Self

Creates a new NMF instance

Arguments

• n_components - Number of components to extract

pub fn with_init(self, init: &str) -> Self

Set the initialization method

pub fn with_solver(self, solver: &str) -> Self

Set the solver

pub fn with_beta_loss(self, beta: f64) -> Self

Set the beta divergence parameter

pub fn with_max_iter(self, maxiter: usize) -> Self

Set maximum iterations

pub fn with_tolerance(self, tol: f64) -> Self

Set tolerance

pub fn with_random_state(self, seed: u64) -> Self

Set random state

pub fn with_regularization(self, alpha: f64, l1ratio: f64) -> Self

Set regularization parameters

pub fn fit<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<()>

where S: Data, S::Elem: Float + NumCast,

Fit NMF model to data

Arguments

• x - Input data matrix (must be non-negative)

Returns

• Result<()> - Ok if successful, Err otherwise

pub fn transform<S>(&self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Transform data using fitted NMF model

Arguments

• x - Input data matrix (must be non-negative)

Returns

• Result<Array2<f64>> - Transformed data (W matrix)

pub fn fit_transform<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Fit and transform in one step

Arguments

• x - Input data matrix (must be non-negative)

Returns

• Result<Array2<f64>> - Transformed data (W matrix)

pub fn components(&self) -> Option<&Array2<f64>>

Get the components (H matrix)

pub fn coefficients(&self) -> Option<&Array2<f64>>

Get the coefficients (W matrix)

pub fn reconstruction_error(&self) -> Option<f64>

Get reconstruction error

pub fn n_iterations(&self) -> Option<usize>

Get number of iterations run

pub fn inverse_transform(&self, w: &Array2<f64>) -> Result<Array2<f64>>

Inverse transform - reconstruct data from transformed representation

Trait Implementations

impl Clone for NMF

fn clone(&self) -> NMF

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NMF

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

Formats the value using the given formatter.