ML::kmeans::KMeansParams Struct Reference

#include <kmeans_params.hpp>

Collaboration diagram for ML::kmeans::KMeansParams:

Public Types
enum class	InitMethod { KMeansPlusPlus , Random , Array }

Public Member Functions
cuvs::cluster::kmeans::params	to_cuvs () const

Public Attributes
ML::distance::DistanceType	metric = ML::distance::DistanceType::L2Expanded
int	n_clusters = 8
InitMethod	init = InitMethod::KMeansPlusPlus
int	max_iter = 300
double	tol = 1e-4
rapids_logger::level_enum	verbosity = rapids_logger::level_enum::info
raft::random::RngState	rng_state {0}
int	n_init = 1
double	oversampling_factor = 2.0
int	batch_samples = 1 << 15
int	batch_centroids = 0
bool	inertia_check = false

Member Enumeration Documentation

InitMethod

enum ML::kmeans::KMeansParams::InitMethod

strong

Enumerator
KMeansPlusPlus
Random
Array

Member Function Documentation

to_cuvs()

cuvs::cluster::kmeans::params ML::kmeans::KMeansParams::to_cuvs

(

)

const

Member Data Documentation

batch_centroids

int ML::kmeans::KMeansParams::batch_centroids = 0

batch_samples

int ML::kmeans::KMeansParams::batch_samples = 1 << 15

inertia_check

bool ML::kmeans::KMeansParams::inertia_check = false

init

InitMethod ML::kmeans::KMeansParams::init = InitMethod::KMeansPlusPlus

max_iter

int ML::kmeans::KMeansParams::max_iter = 300

metric

ML::distance::DistanceType ML::kmeans::KMeansParams::metric = ML::distance::DistanceType::L2Expanded

n_clusters

int ML::kmeans::KMeansParams::n_clusters = 8

n_init

int ML::kmeans::KMeansParams::n_init = 1

oversampling_factor

double ML::kmeans::KMeansParams::oversampling_factor = 2.0

rng_state

raft::random::RngState ML::kmeans::KMeansParams::rng_state {0}

tol

double ML::kmeans::KMeansParams::tol = 1e-4

verbosity

rapids_logger::level_enum ML::kmeans::KMeansParams::verbosity = rapids_logger::level_enum::info

---

The documentation for this struct was generated from the following files:

• include/cuml/cluster/kmeans_params.hpp
• src/kmeans/kmeans_params.cpp