Struct linfa_clustering::GmmParams

pub struct GmmParams<F: Float, R: Rng>(/* private fields */);

The set of hyperparameters that can be specified for the execution of the GMM algorithm.

Implementations

impl<F: Float> GmmParams<F, Xoshiro256Plus>

pub fn new(n_clusters: usize) -> Self

impl<F: Float, R: Rng + Clone> GmmParams<F, R>

pub fn new_with_rng(n_clusters: usize, rng: R) -> GmmParams<F, R>

pub fn covariance_type(self, covar_type: GmmCovarType) -> Self

Set the covariance type.

pub fn tolerance(self, tolerance: F) -> Self

Set the convergence threshold. EM iterations will stop when the lower bound average gain is below this threshold.

pub fn reg_covariance(self, reg_covar: F) -> Self

Non-negative regularization added to the diagonal of covariance. Allows to assure that the covariance matrices are all positive.

pub fn n_runs(self, n_runs: u64) -> Self

Set the number of initializations to perform. The best results are kept.

pub fn max_n_iterations(self, max_n_iter: u64) -> Self

Set the number of EM iterations to perform.

pub fn init_method(self, init_method: GmmInitMethod) -> Self

Set the method used to initialize the weights, the means and the precisions.

pub fn with_rng<R2: Rng + Clone>(self, rng: R2) -> GmmParams<F, R2>

Trait Implementations

impl<F: Clone + Float, R: Clone + Rng> Clone for GmmParams<F, R>

fn clone(&self) -> GmmParams<F, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float, R: Debug + Rng> Debug for GmmParams<F, R>

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

Formats the value using the given formatter.

impl<F: Float, R: Rng> ParamGuard for GmmParams<F, R>

type Checked = GmmValidParams<F, R>

The checked hyperparameters

type Error = GmmError

Error type resulting from failed hyperparameter checking

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

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

fn check(self) -> Result<Self::Checked, GmmError>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checkedwhere Self: Sized,

Calls check() and unwraps the result

impl<F: PartialEq + Float, R: PartialEq + Rng> PartialEq for GmmParams<F, R>

fn eq(&self, other: &GmmParams<F, R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Float, R: Rng> StructuralPartialEq for GmmParams<F, R>