Struct linfa_clustering::KMeansHyperParams

pub struct KMeansHyperParams { /* fields omitted */ }

The set of hyperparameters that can be specified for the execution of the K-means algorithm.

Methods

impl KMeansHyperParams

pub fn new(n_clusters: usize) -> KMeansHyperParamsBuilder

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 the tolerance convergence condition has not been met.

n_clusters is mandatory.

Defaults are provided if optional parameters are not specified:

• tolerance = 1e-4;
• max_n_iterations = 300.

pub fn tolerance(&self) -> f64

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.

pub fn max_n_iterations(&self) -> u64

We exit the training loop when the number of training iterations exceeds max_n_iterations even if the tolerance convergence condition has not been met.

pub fn n_clusters(&self) -> usize

The number of clusters we will be looking for in the training dataset.

Trait Implementations

impl Clone for KMeansHyperParams

fn clone(&self) -> KMeansHyperParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<KMeansHyperParams> for KMeansHyperParams

fn eq(&self, other: &KMeansHyperParams) -> bool

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

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

This method tests for !=.

impl Debug for KMeansHyperParams

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

Formats the value using the given formatter.

impl StructuralPartialEq for KMeansHyperParams

impl Serialize for KMeansHyperParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for KMeansHyperParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.