Struct linfa_clustering::KMeansParams
source · pub struct KMeansParams<F: Float, R: Rng, D: Distance<F>>(/* private fields */);
Expand description
An helper struct used to construct a set of valid hyperparameters for the K-means algorithm (using the builder pattern).
Implementations§
source§impl<F: Float, R: Rng, D: Distance<F>> KMeansParams<F, R, D>
impl<F: Float, R: Rng, D: Distance<F>> KMeansParams<F, R, D>
sourcepub fn new(n_clusters: usize, rng: R, dist_fn: D) -> Self
pub fn new(n_clusters: usize, rng: R, dist_fn: D) -> Self
new
lets us configure our training algorithm parameters:
- we will be looking for
n_clusters
in the training dataset; - the training is considered complete if the euclidean distance
between the old set of centroids and the new set of centroids
after a training iteration is lower or equal than
tolerance
; - we exit the training loop when the number of training iterations
exceeds
max_n_iterations
even if thetolerance
convergence condition has not been met. - As KMeans convergence depends on centroids initialization
we run the algorithm
n_runs
times and we keep the best outputs in terms of inertia that the ones which minimizes the sum of squared euclidean distances to the closest centroid for all observations.
Defaults are provided if optional parameters are not specified:
tolerance = 1e-4
max_n_iterations = 300
n_runs = 10
init = KMeansPlusPlus
sourcepub fn max_n_iterations(self, max_n_iterations: u64) -> Self
pub fn max_n_iterations(self, max_n_iterations: u64) -> Self
Change the value of max_n_iterations
sourcepub fn init_method(self, init: KMeansInit<F>) -> Self
pub fn init_method(self, init: KMeansInit<F>) -> Self
Change the value of init
Trait Implementations§
source§impl<F: Clone + Float, R: Clone + Rng, D: Clone + Distance<F>> Clone for KMeansParams<F, R, D>
impl<F: Clone + Float, R: Clone + Rng, D: Clone + Distance<F>> Clone for KMeansParams<F, R, D>
source§fn clone(&self) -> KMeansParams<F, R, D>
fn clone(&self) -> KMeansParams<F, R, D>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<F: Debug + Float, R: Debug + Rng, D: Debug + Distance<F>> Debug for KMeansParams<F, R, D>
impl<F: Debug + Float, R: Debug + Rng, D: Debug + Distance<F>> Debug for KMeansParams<F, R, D>
source§impl<F: Float, R: Rng, D: Distance<F>> ParamGuard for KMeansParams<F, R, D>
impl<F: Float, R: Rng, D: Distance<F>> ParamGuard for KMeansParams<F, R, D>
§type Checked = KMeansValidParams<F, R, D>
type Checked = KMeansValidParams<F, R, D>
The checked hyperparameters
§type Error = KMeansParamsError
type Error = KMeansParamsError
Error type resulting from failed hyperparameter checking
source§fn check_ref(&self) -> Result<&Self::Checked, Self::Error>
fn check_ref(&self) -> Result<&Self::Checked, Self::Error>
Checks the hyperparameters and returns a reference to the checked hyperparameters if
successful
source§fn check(self) -> Result<Self::Checked, Self::Error>
fn check(self) -> Result<Self::Checked, Self::Error>
Checks the hyperparameters and returns the checked hyperparameters if successful
source§fn check_unwrap(self) -> Self::Checkedwhere
Self: Sized,
fn check_unwrap(self) -> Self::Checkedwhere Self: Sized,
Calls
check()
and unwraps the resultsource§impl<F: PartialEq + Float, R: PartialEq + Rng, D: PartialEq + Distance<F>> PartialEq for KMeansParams<F, R, D>
impl<F: PartialEq + Float, R: PartialEq + Rng, D: PartialEq + Distance<F>> PartialEq for KMeansParams<F, R, D>
source§fn eq(&self, other: &KMeansParams<F, R, D>) -> bool
fn eq(&self, other: &KMeansParams<F, R, D>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl<F: Float, R: Rng, D: Distance<F>> StructuralPartialEq for KMeansParams<F, R, D>
Auto Trait Implementations§
impl<F, R, D> RefUnwindSafe for KMeansParams<F, R, D>where D: RefUnwindSafe, F: RefUnwindSafe, R: RefUnwindSafe,
impl<F, R, D> Send for KMeansParams<F, R, D>where R: Send,
impl<F, R, D> Sync for KMeansParams<F, R, D>where R: Sync,
impl<F, R, D> Unpin for KMeansParams<F, R, D>where R: Unpin,
impl<F, R, D> UnwindSafe for KMeansParams<F, R, D>where D: UnwindSafe, F: UnwindSafe + RefUnwindSafe, R: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more