Struct DictionaryLearning 

pub struct DictionaryLearning { /* private fields */ }

Dictionary Learning configuration.

Holds hyperparameters for the dictionary learning algorithm. Calling Fit::fit learns a dictionary and returns a FittedDictionaryLearning.

Implementations

impl DictionaryLearning

pub fn new(n_components: usize) -> Self

Create a new DictionaryLearning with n_components atoms.

Defaults: alpha=1.0, max_iter=1000, tol=1e-8, fit_algorithm=CoordinateDescent, transform_algorithm=Omp.

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

Set the sparsity penalty.

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

Set the maximum number of iterations.

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

Set the convergence tolerance.

pub fn with_fit_algorithm(self, algo: DictFitAlgorithm) -> Self

Set the fit algorithm.

pub fn with_transform_algorithm(self, algo: DictTransformAlgorithm) -> Self

Set the transform algorithm.

pub fn with_transform_n_nonzero_coefs(self, n: usize) -> Self

Set the maximum number of non-zero coefficients for OMP transform.

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

Set the random seed.

pub fn n_components(&self) -> usize

Return the configured number of components.

pub fn alpha(&self) -> f64

Return the configured alpha.

pub fn max_iter(&self) -> usize

Return the configured maximum iterations.

pub fn tol(&self) -> f64

Return the configured tolerance.

pub fn fit_algorithm(&self) -> DictFitAlgorithm

Return the configured fit algorithm.

pub fn transform_algorithm(&self) -> DictTransformAlgorithm

Return the configured transform algorithm.

pub fn random_state(&self) -> Option<u64>

Return the configured random state, if any.

Trait Implementations

impl Clone for DictionaryLearning

fn clone(&self) -> DictionaryLearning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DictionaryLearning

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

Formats the value using the given formatter.

impl Fit<ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ()> for DictionaryLearning

fn fit( &self, x: &Array2<f64>, _y: &(), ) -> Result<FittedDictionaryLearning, FerroError>

Fit the dictionary learning model.

Errors

• FerroError::InvalidParameter if n_components is zero or alpha is negative.
• FerroError::InsufficientSamples if there are zero samples or zero features.

type Fitted = FittedDictionaryLearning

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.