Skip to contents

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

IdTypeDefaultLevelsRange
ntreeinteger500\([1, \infty)\)
mtryinteger-\([1, \infty)\)
replacelogicalTRUETRUE, FALSE-
classwtuntypedNULL-
cutoffuntyped--
stratauntyped--
sampsizeuntyped--
nodesizeinteger1\([1, \infty)\)
maxnodesinteger-\([1, \infty)\)
importancecharacterFALSEaccuracy, gini, none-
localImplogicalFALSETRUE, FALSE-
proximitylogicalFALSETRUE, FALSE-
oob.proxlogical-TRUE, FALSE-
norm.voteslogicalTRUETRUE, FALSE-
do.tracelogicalFALSETRUE, FALSE-
keep.forestlogicalTRUETRUE, FALSE-
keep.inbaglogicalFALSETRUE, FALSE-
predict.alllogicalFALSETRUE, FALSE-
nodeslogicalFALSETRUE, FALSE-

References

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

See also

Author

pat-s

Super classes

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

Methods

Inherited methods


LearnerClassifRandomForest$new()

Creates a new instance of this R6 class.


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.99%
#> Confusion matrix:
#>    M  R class.error
#> M 65  9   0.1216216
#> R 16 49   0.2461538
print(learner$importance())
#>           V12           V11           V47           V36           V48 
#>  2.587204e-02  2.536092e-02  1.301657e-02  1.205714e-02  1.046630e-02 
#>           V13            V9           V28           V49           V37 
#>  9.430078e-03  9.405898e-03  9.374018e-03  8.961302e-03  8.397726e-03 
#>           V10           V45           V39           V21           V27 
#>  7.865181e-03  6.605073e-03  5.316424e-03  3.984096e-03  3.888121e-03 
#>           V46            V5           V31           V20           V17 
#>  3.714764e-03  3.098973e-03  2.617396e-03  2.486372e-03  2.368765e-03 
#>           V29           V44           V51           V16           V18 
#>  2.277839e-03  2.251188e-03  2.197738e-03  2.192421e-03  2.145277e-03 
#>           V43           V15           V41           V24            V6 
#>  2.066253e-03  2.023247e-03  1.927625e-03  1.766679e-03  1.722975e-03 
#>           V53           V52           V59           V32           V25 
#>  1.600611e-03  1.523496e-03  1.394138e-03  1.385065e-03  1.320566e-03 
#>           V50           V40            V2            V8           V14 
#>  1.297594e-03  1.264738e-03  1.192408e-03  1.156248e-03  1.103152e-03 
#>           V23            V1            V4           V26           V34 
#>  1.065788e-03  1.045746e-03  8.905676e-04  8.296583e-04  6.784467e-04 
#>           V33           V54           V55           V35           V42 
#>  6.509248e-04  6.268855e-04  5.143583e-04  4.620317e-04  4.620160e-04 
#>            V7           V38           V22           V60           V30 
#>  4.465639e-04  3.293855e-04  2.782255e-04  1.927262e-04  7.476168e-05 
#>           V19           V56            V3           V57           V58 
#>  8.915480e-06 -2.602289e-04 -2.654698e-04 -3.057732e-04 -1.355580e-03 

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

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