Classification Fast Nearest Neighbor Search Learner

Calls FNN::knn from package FNN.

Dictionary

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

mlr_learners$get("classif.fnn")
lrn("classif.fnn")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

• Feature Types: “integer”, “numeric”

• Required Packages: mlr3extralearners, FNN

Parameters

Id	Type	Default	Levels	Range
k	integer	1		\([1, \infty)\)
algorithm	character	kd_tree	kd_tree, cover_tree, brute	\((-\infty, \infty)\)

See also

• 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).

• Chapter in the mlr3book: https://mlr3book.mlr-org.com/basics.html#learners

• mlr3learners for a selection of recommended learners.

• mlr3cluster for unsupervised clustering learners.

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

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

Author

be-marc

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifFNN

Methods

Public methods

• LearnerClassifFNN$new()

• LearnerClassifFNN$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$reset()

• mlr3::Learner$train()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClassifFNN$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifFNN$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("FNN", quietly = TRUE)) {
  learner = mlr3::lrn("classif.fnn")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}
#> <LearnerClassifFNN:classif.fnn>
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3extralearners, FNN
#> * Predict Type: response
#> * Feature types: integer, numeric
#> * Properties: multiclass, twoclass
#> [1] "k"         "algorithm"