Classification IBk Learner

Instance based algorithm: K-nearest neighbours regression. Calls RWeka::IBk() from RWeka.

Dictionary

This Learner can be instantiated via lrn():

lrn("classif.IBk")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

• Feature Types: “integer”, “numeric”, “factor”, “ordered”

• Required Packages: mlr3, mlr3extralearners, RWeka

Parameters

Id	Type	Default	Levels	Range
subset	untyped	-		-
na.action	untyped	-		-
weight	character	-	I, F	-
K	integer	1		\([1, \infty)\)
E	logical	FALSE	TRUE, FALSE	-
W	integer	0		\([0, \infty)\)
X	logical	FALSE	TRUE, FALSE	-
A	character	LinearNNSearch	BallTree, CoverTree, FilteredNeighbourSearch, KDTree, LinearNNSearch	-
output_debug_info	logical	FALSE	TRUE, FALSE	-
do_not_check_capabilities	logical	FALSE	TRUE, FALSE	-
num_decimal_places	integer	2		\([1, \infty)\)
batch_size	integer	100		\([1, \infty)\)
options	untyped	NULL		-

Custom mlr3 parameters

• output_debug_info:

  • original id: output-debug-info

• do_not_check_capabilities:

  • original id: do-not-check-capabilities

• num_decimal_places:

  • original id: num-decimal-places

• batch_size:

  • original id: batch-size

• Reason for change: This learner contains changed ids of the following control arguments since their ids contain irregular pattern

• weight:

  • original id: I and F

• Reason for change: original I and F params are interdependent (I can only be TRUE when F is FALSE and vice versa). The easiest way to encode this is to combine I and F into one factor param.

References

Aha, W D, Kibler, Dennis, Albert, K M (1991). “Instance-based learning algorithms.” Machine learning, 6(1), 37–66.

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

henrifnk

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifIBk

Methods

Public methods

• LearnerClassifIBk$new()

• LearnerClassifIBk$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$encapsulate()
• 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

LearnerClassifIBk$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifIBk$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Define the Learner
learner = mlr3::lrn("classif.IBk")
print(learner)
#> <LearnerClassifIBk:classif.IBk>: Nearest Neighbour
#> * Model: -
#> * Parameters: list()
#> * Packages: mlr3, mlr3extralearners, RWeka
#> * Predict Types:  [response], prob
#> * Feature Types: integer, numeric, factor, ordered
#> * Properties: multiclass, twoclass

# Define a Task
task = mlr3::tsk("sonar")

# Create train and test set
ids = mlr3::partition(task)

# Train the learner on the training ids
learner$train(task, row_ids = ids$train)

print(learner$model)
#> IB1 instance-based classifier
#> using 1 nearest neighbour(s) for classification
#> 


# Make predictions for the test rows
predictions = learner$predict(task, row_ids = ids$test)

# Score the predictions
predictions$score()
#> classif.ce 
#>  0.1449275