K-Means Clustering Learner from Weka

A LearnerClust for Simple K Means clustering implemented in RWeka::SimpleKMeans(). The predict method uses RWeka::predict.Weka_clusterer() to compute the cluster memberships for new data.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("clust.SimpleKMeans")
lrn("clust.SimpleKMeans")

Meta Information

• Task type: “clust”

• Predict Types: “partition”

• Feature Types: “logical”, “integer”, “numeric”

• Required Packages: mlr3, mlr3cluster, RWeka

Parameters

Id	Type	Default	Levels	Range
A	untyped	weka.core.EuclideanDistance		-
C	logical	FALSE	TRUE, FALSE	-
fast	logical	FALSE	TRUE, FALSE	-
I	integer	100		\([1, \infty)\)
init	integer	0		\([0, 3]\)
M	logical	FALSE	TRUE, FALSE	-
max_candidates	integer	100		\([1, \infty)\)
min_density	integer	2		\([1, \infty)\)
N	integer	2		\([1, \infty)\)
num_slots	integer	1		\([1, \infty)\)
O	logical	FALSE	TRUE, FALSE	-
periodic_pruning	integer	10000		\([1, \infty)\)
S	integer	10		\([0, \infty)\)
t2	numeric	-1		\((-\infty, \infty)\)
t1	numeric	-1.5		\((-\infty, \infty)\)
V	logical	FALSE	TRUE, FALSE	-
output_debug_info	logical	FALSE	TRUE, FALSE	-

Super classes

mlr3::Learner -> mlr3cluster::LearnerClust -> LearnerClustSimpleKMeans

Methods

Public methods

• LearnerClustSimpleKMeans$new()

• LearnerClustSimpleKMeans$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$format()
• mlr3::Learner$help()
• mlr3::Learner$predict()
• mlr3::Learner$predict_newdata()
• mlr3::Learner$print()
• mlr3::Learner$train()
• mlr3cluster::LearnerClust$reset()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClustSimpleKMeans$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClustSimpleKMeans$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("RWeka")) {
  learner = mlr3::lrn("clust.SimpleKMeans")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}
#> <LearnerClustSimpleKMeans:clust.SimpleKMeans>: K-Means (Weka)
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3cluster, RWeka
#> * Predict Types:  [partition]
#> * Feature Types: logical, integer, numeric
#> * Properties: complete, exclusive, partitional
#>  [1] "A"                 "C"                 "fast"             
#>  [4] "I"                 "init"              "M"                
#>  [7] "max_candidates"    "min_density"       "N"                
#> [10] "num_slots"         "O"                 "periodic_pruning" 
#> [13] "S"                 "t2"                "t1"               
#> [16] "V"                 "output_debug_info"