mlr_learners_clust.skmeans: Spherical K-Means Clustering Learner

In mlr3cluster: Cluster Extension for 'mlr3'

Spherical K-Means Clustering Learner

Description

Spherical k-means clustering for data on the unit hypersphere. Calls skmeans::skmeans() from package skmeans.

The k parameter is set to 2 by default since skmeans::skmeans() doesn't have a default value for the number of clusters. Observations are partitioned by maximising cosine similarity to cluster prototypes. Predictions on new data assign each observation to the prototype with the highest cosine similarity. Rows with zero norm are not allowed by skmeans::skmeans().

Dictionary

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

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

Meta Information

• Task type: “clust”

• Predict Types: “partition”

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

• Required Packages: mlr3, mlr3cluster, skmeans

Parameters

Id	Type	Default	Levels	Range
k	integer	-		[1, \infty)
method	character	-	genetic, pclust, CLUTO, gmeans, kmndirs, LIH, LIHC	-
m	numeric	1		[1, \infty)
weights	untyped	1		-
maxiter	integer	-		[1, \infty)
nruns	integer	-		[1, \infty)
popsize	integer	-		[1, \infty)
mutations	numeric	-		[0, 1]
reltol	numeric	-		[0, \infty)
verbose	logical	-	TRUE, FALSE	-

Super classes

mlr3::Learner -> LearnerClust -> LearnerClustSKMeans

Methods

Public methods

• LearnerClustSKMeans$new()

• LearnerClustSKMeans$clone()

Inherited methods

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

---

LearnerClustSKMeans$new()

Creates a new instance of this R6 class.

Usage

LearnerClustSKMeans$new()

---

LearnerClustSKMeans$clone()

The objects of this class are cloneable with this method.

Usage

LearnerClustSKMeans$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

References

Dhillon, S I, Modha, S D (2001). “Concept decompositions for large sparse text data using clustering.” Machine Learning, 42(1), 143–175. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1023/A:1007612920971")}.

Hornik, Kurt, Feinerer, Ingo, Kober, Martin, Buchta, Christian (2012). “Spherical k-Means Clustering.” Journal of Statistical Software, 50(10), 1–22. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.18637/jss.v050.i10")}.

See Also

• Chapter in the mlr3book: https://mlr3book.mlr-org.com/chapters/chapter2/data_and_basic_modeling.html#sec-learners

• Package mlr3extralearners for more learners.

• Dictionary of Learners: mlr3::mlr_learners

• as.data.table(mlr_learners) for a table of available Learners in the running session (depending on the loaded packages).

• mlr3pipelines to combine learners with pre- and postprocessing steps.

• Package mlr3viz for some generic visualizations.

• Extension packages for additional task types:

  • mlr3proba for probabilistic supervised regression and survival analysis.

  • mlr3cluster for unsupervised clustering.

• mlr3tuning for tuning of hyperparameters, mlr3tuningspaces for established default tuning spaces.

Other Learner: mlr_learners_clust.MBatchKMeans, mlr_learners_clust.SimpleKMeans, mlr_learners_clust.agnes, mlr_learners_clust.ap, mlr_learners_clust.bico, mlr_learners_clust.birch, mlr_learners_clust.clara, mlr_learners_clust.cmeans, mlr_learners_clust.cobweb, mlr_learners_clust.dbscan, mlr_learners_clust.dbscan_fpc, mlr_learners_clust.diana, mlr_learners_clust.em, mlr_learners_clust.fanny, mlr_learners_clust.featureless, mlr_learners_clust.ff, mlr_learners_clust.flexmix, mlr_learners_clust.genie, mlr_learners_clust.hclust, mlr_learners_clust.hdbscan, mlr_learners_clust.kcca, mlr_learners_clust.kkmeans, mlr_learners_clust.kmeans, mlr_learners_clust.kproto, mlr_learners_clust.mclust, mlr_learners_clust.meanshift, mlr_learners_clust.movMF, mlr_learners_clust.optics, mlr_learners_clust.pam, mlr_learners_clust.protoclust, mlr_learners_clust.som, mlr_learners_clust.specc, mlr_learners_clust.stdbscan, mlr_learners_clust.tclust, mlr_learners_clust.xmeans

Examples

# Define the Learner and set parameter values
learner = lrn("clust.skmeans")
print(learner)

# Define a Task
task = tsk("usarrests")

# Train the learner on the task
learner$train(task)

# Print the model
print(learner$model)

# Make predictions for the task
prediction = learner$predict(task)

# Score the predictions
prediction$score(task = task)

mlr3cluster documentation built on June 11, 2026, 5:06 p.m.