Skip to main content

KMeansConfig

Struct KMeansConfig 

Source
pub struct KMeansConfig {
    pub k: usize,
    pub max_iters: usize,
    pub tol: f64,
    pub seed: u64,
    pub max_points_per_centroid: Option<usize>,
    pub chunk_size_data: usize,
    pub chunk_size_centroids: usize,
    pub verbose: bool,
}
Expand description

Configuration for the FastKMeans algorithm

Fields§

§k: usize

Number of clusters

§max_iters: usize

Maximum number of iterations

§tol: f64

Convergence tolerance. When centroid shift is below this threshold, the algorithm stops early. Set to negative value to disable early stopping.

§seed: u64

Random seed for centroid initialization and subsampling

§max_points_per_centroid: Option<usize>

Maximum points per centroid for subsampling. If n_samples > k * max_points_per_centroid, data will be subsampled. Set to None to disable subsampling.

§chunk_size_data: usize

Chunk size for data processing. Larger values use more memory but may be faster.

§chunk_size_centroids: usize

Chunk size for centroid processing. Larger values use more memory but may be faster.

§verbose: bool

Print verbose output during training

Implementations§

Source§

impl KMeansConfig

Source

pub fn new(k: usize) -> KMeansConfig

Create a new configuration with the specified number of clusters

Source

pub fn with_max_iters(self, max_iters: usize) -> KMeansConfig

Set the maximum number of iterations

Source

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

Set the convergence tolerance

Source

pub fn with_seed(self, seed: u64) -> KMeansConfig

Set the random seed

Source

pub fn with_max_points_per_centroid( self, max_ppc: Option<usize>, ) -> KMeansConfig

Set the maximum points per centroid (for subsampling)

Source

pub fn with_verbose(self, verbose: bool) -> KMeansConfig

Set verbose mode

Source

pub fn with_chunk_size_data(self, chunk_size: usize) -> KMeansConfig

Set the data chunk size

Source

pub fn with_chunk_size_centroids(self, chunk_size: usize) -> KMeansConfig

Set the centroid chunk size

Trait Implementations§

Source§

impl Clone for KMeansConfig

Source§

fn clone(&self) -> KMeansConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KMeansConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KMeansConfig

Source§

fn default() -> KMeansConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V