Classification Random Forest Learner

Random forest for classification. Calls randomForest::randomForest() from randomForest.

Dictionary

This Learner can be instantiated via lrn():

lrn("classif.randomForest")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

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

• Required Packages: mlr3, mlr3extralearners, randomForest

Parameters

Id	Type	Default	Levels	Range
ntree	integer	500		\([1, \infty)\)
mtry	integer	-		\([1, \infty)\)
replace	logical	TRUE	TRUE, FALSE	-
classwt	untyped	NULL		-
cutoff	untyped	-		-
strata	untyped	-		-
sampsize	untyped	-		-
nodesize	integer	1		\([1, \infty)\)
maxnodes	integer	-		\([1, \infty)\)
importance	character	FALSE	accuracy, gini, none	-
localImp	logical	FALSE	TRUE, FALSE	-
proximity	logical	FALSE	TRUE, FALSE	-
oob.prox	logical	-	TRUE, FALSE	-
norm.votes	logical	TRUE	TRUE, FALSE	-
do.trace	logical	FALSE	TRUE, FALSE	-
keep.forest	logical	TRUE	TRUE, FALSE	-
keep.inbag	logical	FALSE	TRUE, FALSE	-
predict.all	logical	FALSE	TRUE, FALSE	-
nodes	logical	FALSE	TRUE, FALSE	-

References

Breiman, Leo (2001). “Random Forests.” Machine Learning, 45(1), 5–32. ISSN 1573-0565. doi:10.1023/A:1010933404324 .

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/chapters/chapter2/data_and_basic_modeling.html#sec-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

pat-s

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifRandomForest

Methods

Public methods

• LearnerClassifRandomForest$new()

• LearnerClassifRandomForest$importance()

• LearnerClassifRandomForest$oob_error()

• LearnerClassifRandomForest$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$reset()
• mlr3::Learner$selected_features()
• mlr3::Learner$train()
• mlr3::LearnerClassif$predict_newdata_fast()

---

LearnerClassifRandomForest$new()

Creates a new instance of this R6 class.

Usage

LearnerClassifRandomForest$new()

---

LearnerClassifRandomForest$importance()

The importance scores are extracted from the slot importance. Parameter 'importance' must be set to either "accuracy" or "gini".

Usage

LearnerClassifRandomForest$importance()

Returns

Named numeric().

---

LearnerClassifRandomForest$oob_error()

OOB errors are extracted from the model slot err.rate.

Usage

LearnerClassifRandomForest$oob_error()

Returns

numeric(1).

---

LearnerClassifRandomForest$clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifRandomForest$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Define the Learner
learner = lrn("classif.randomForest", importance = "accuracy")
print(learner)
#> 
#> ── <LearnerClassifRandomForest> (classif.randomForest): Random Forest ──────────
#> • Model: -
#> • Parameters: importance=accuracy
#> • Packages: mlr3, mlr3extralearners, and randomForest
#> • Predict Types: [response] and prob
#> • Feature Types: logical, integer, numeric, factor, and ordered
#> • Encapsulation: none (fallback: -)
#> • Properties: importance, multiclass, oob_error, twoclass, and weights
#> • Other settings: use_weights = 'use', predict_raw = 'FALSE'

# Define a Task
task = tsk("sonar")
# Create train and test set
ids = partition(task)

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

print(learner$model)
#> 
#> Call:
#>  randomForest(formula = formula, data = data, classwt = classwt,      cutoff = cutoff, importance = TRUE) 
#>                Type of random forest: classification
#>                      Number of trees: 500
#> No. of variables tried at each split: 7
#> 
#>         OOB estimate of  error rate: 17.27%
#> Confusion matrix:
#>    M  R class.error
#> M 72  6  0.07692308
#> R 18 43  0.29508197
print(learner$importance())
#>           V12           V11           V10           V52           V49 
#>  2.483939e-02  2.330297e-02  1.208399e-02  1.176255e-02  1.154297e-02 
#>           V47           V48           V36            V9           V35 
#>  9.805197e-03  9.009340e-03  8.705282e-03  8.467826e-03  6.769216e-03 
#>           V44            V4           V45           V21           V13 
#>  5.891781e-03  5.349940e-03  5.230018e-03  5.092689e-03  5.030632e-03 
#>           V28           V20            V5           V43           V46 
#>  4.827397e-03  4.761023e-03  4.708340e-03  4.702607e-03  4.440538e-03 
#>           V39           V17            V1           V16           V27 
#>  4.233288e-03  3.805489e-03  3.614843e-03  3.131444e-03  2.989463e-03 
#>           V23           V31           V15           V37           V51 
#>  2.956417e-03  2.862992e-03  2.752219e-03  2.308453e-03  2.195998e-03 
#>           V34           V18           V26           V22           V29 
#>  1.965878e-03  1.866376e-03  1.815904e-03  1.795570e-03  1.785779e-03 
#>           V19           V14           V54            V2           V25 
#>  1.601034e-03  1.569078e-03  1.568981e-03  1.466183e-03  1.347290e-03 
#>           V58           V50            V8           V59           V40 
#>  1.340363e-03  1.282452e-03  1.259098e-03  1.168226e-03  1.053277e-03 
#>           V33           V42           V32           V55           V41 
#>  9.481781e-04  9.194522e-04  7.155958e-04  6.283584e-04  5.306588e-04 
#>            V3           V38           V24           V30           V53 
#>  5.253142e-04  5.098978e-04  4.371428e-04  2.927018e-04  2.220501e-04 
#>           V60           V56            V6           V57            V7 
#>  1.436533e-04  1.046148e-04  1.988476e-05 -5.125196e-04 -9.941417e-04 

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

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