mlr_learners_clust.MBatchKMeans: Mini Batch K-Means Clustering Learner

In mlr-org/mlr3cluster: Cluster Extension for 'mlr3'

Mini Batch K-Means Clustering Learner

Description

A LearnerClust for mini batch k-means clustering implemented in ClusterR::MiniBatchKmeans(). ClusterR::MiniBatchKmeans() doesn't have a default value for the number of clusters. Therefore, the clusters parameter here is set to 2 by default. The predict method uses ClusterR::predict_MBatchKMeans() to compute the cluster memberships for new data. The learner supports both partitional and fuzzy clustering.

Dictionary

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

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

Meta Information

• Task type: “clust”

• Predict Types: “partition”, “prob”

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

• Required Packages: mlr3, mlr3cluster, ClusterR

Parameters

Id	Type	Default	Levels	Range
clusters	integer	2		[1, Inf)
batch_size	integer	10		[1, Inf)
num_init	integer	1		[1, Inf)
max_iters	integer	100		[1, Inf)
init_fraction	numeric	1		[0, 1]
initializer	character	kmeans++	optimal_init, quantile_init, kmeans++, random	-
early_stop_iter	integer	10		[1, Inf)
verbose	logical	FALSE	TRUE, FALSE	-
CENTROIDS	untyped			-
tol	numeric	1e-04		[0, Inf)
tol_optimal_init	numeric	0.3		[0, Inf)
seed	integer	1		(-Inf, Inf)

Super classes

mlr3::Learner -> mlr3cluster::LearnerClust -> LearnerClustMiniBatchKMeans

Methods

Public methods

• LearnerClustMiniBatchKMeans$new()

• LearnerClustMiniBatchKMeans$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

LearnerClustMiniBatchKMeans$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClustMiniBatchKMeans$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("ClusterR")) {
  learner = mlr3::lrn("clust.MBatchKMeans")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}

mlr-org/mlr3cluster documentation built on March 18, 2023, 10:01 p.m.