[−][src]Struct linfa_clustering::KMeansHyperParamsBuilder
An helper struct used to construct a set of valid hyperparameters for the K-means algorithm (using the builder pattern).
Implementations
impl<F: Float, R: Rng + Clone> KMeansHyperParamsBuilder<F, R>
[src]
pub fn n_runs(mut self: Self, n_runs: u64) -> Self
[src]
Set the value of n_runs
.
The final results will be the best output of n_runs consecutive runs in terms of inertia (sum of squared distances to the closest centroid for all observations in the training set)
pub fn max_n_iterations(mut self: Self, max_n_iterations: u64) -> Self
[src]
Set the value of max_n_iterations
.
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 tolerance(mut self: Self, tolerance: F) -> Self
[src]
Set the value of tolerance
.
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 build(&self) -> KMeansHyperParams<F, R>
[src]
Return an instance of KMeansHyperParams
after
having performed validation checks on all the specified hyperparamters.
Panics if any of the validation checks fails.
Trait Implementations
impl<'a, F: Float, R: Rng + Clone, D: Data<Elem = F>, T: Targets> Fit<'a, ArrayBase<D, Dim<[usize; 2]>>, T> for KMeansHyperParamsBuilder<F, R>
[src]
type Object = Result<KMeans<F>, KMeansError>
pub fn fit(&self, dataset: &DatasetBase<ArrayBase<D, Ix2>, T>) -> Self::Object
[src]
Auto Trait Implementations
impl<F, R> RefUnwindSafe for KMeansHyperParamsBuilder<F, R> where
F: RefUnwindSafe,
R: RefUnwindSafe,
[src]
F: RefUnwindSafe,
R: RefUnwindSafe,
impl<F, R> Send for KMeansHyperParamsBuilder<F, R> where
R: Send,
[src]
R: Send,
impl<F, R> Sync for KMeansHyperParamsBuilder<F, R> where
R: Sync,
[src]
R: Sync,
impl<F, R> Unpin for KMeansHyperParamsBuilder<F, R> where
F: Unpin,
R: Unpin,
[src]
F: Unpin,
R: Unpin,
impl<F, R> UnwindSafe for KMeansHyperParamsBuilder<F, R> where
F: UnwindSafe,
R: UnwindSafe,
[src]
F: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub unsafe fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,