mlr_learners_classif.kstar: Classification KStar Learner

mlr_learners_classif.kstarR Documentation

Classification KStar Learner

Description

Instance-based classifier which differs from other instance-based learners in that it uses an entropy-based distance function. Calls RWeka::make_Weka_classifier() from RWeka.

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

Dictionary

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

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

Meta Information

  • Task type: “classif”

  • Predict Types: “response”, “prob”

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

  • Required Packages: mlr3, RWeka

Parameters

Id Type Default Levels Range
subset untyped - -
na.action untyped - -
B integer 20 (-\infty, \infty)
E logical - TRUE, FALSE -
M character a a, d, m, n -
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 -

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifKStar

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of this R6 class.

Usage
LearnerClassifKStar$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
LearnerClassifKStar$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

damirpolat

References

Cleary JG, Trigg LE (1995). “K*: An Instance-based Learner Using an Entropic Distance Measure.” In 12th International Conference on Machine Learning, 108-114.

See Also

Examples

learner = mlr3::lrn("classif.kstar")
print(learner)

# available parameters:
learner$param_set$ids()

mlr-org/mlr3extralearners documentation built on April 13, 2024, 5:25 a.m.