Classification Random Forest SRC Learner

Random forest for classification. Calls randomForestSRC::rfsrc() from randomForestSRC.

Dictionary

This Learner can be instantiated via lrn():

lrn("classif.rfsrc")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

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

• Required Packages: mlr3, mlr3extralearners, randomForestSRC

Parameters

Id	Type	Default	Levels	Range
ntree	integer	500		\([1, \infty)\)
mtry	integer	-		\([1, \infty)\)
mtry.ratio	numeric	-		\([0, 1]\)
nodesize	integer	15		\([1, \infty)\)
nodedepth	integer	-		\([1, \infty)\)
splitrule	character	gini	gini, auc, entropy	-
nsplit	integer	10		\([0, \infty)\)
importance	character	FALSE	FALSE, TRUE, none, permute, random, anti	-
block.size	integer	10		\([1, \infty)\)
bootstrap	character	by.root	by.root, by.node, none, by.user	-
samptype	character	swor	swor, swr	-
samp	untyped	-		-
membership	logical	FALSE	TRUE, FALSE	-
sampsize	untyped	-		-
sampsize.ratio	numeric	-		\([0, 1]\)
na.action	character	na.omit	na.omit, na.impute	-
nimpute	integer	1		\([1, \infty)\)
ntime	integer	-		\([1, \infty)\)
cause	integer	-		\([1, \infty)\)
proximity	character	FALSE	FALSE, TRUE, inbag, oob, all	-
distance	character	FALSE	FALSE, TRUE, inbag, oob, all	-
forest.wt	character	FALSE	FALSE, TRUE, inbag, oob, all	-
xvar.wt	untyped	-		-
split.wt	untyped	-		-
forest	logical	TRUE	TRUE, FALSE	-
var.used	character	FALSE	FALSE, all.trees, by.tree	-
split.depth	character	FALSE	FALSE, all.trees, by.tree	-
seed	integer	-		\((-\infty, -1]\)
do.trace	logical	FALSE	TRUE, FALSE	-
statistics	logical	FALSE	TRUE, FALSE	-
get.tree	untyped	-		-
outcome	character	train	train, test	-
ptn.count	integer	0		\([0, \infty)\)
cores	integer	1		\([1, \infty)\)
save.memory	logical	FALSE	TRUE, FALSE	-
perf.type	character	-	gmean, misclass, brier, none	-
case.depth	logical	FALSE	TRUE, FALSE	-

Custom mlr3 parameters

• mtry: This hyperparameter can alternatively be set via the added hyperparameter mtry.ratio as mtry = max(ceiling(mtry.ratio * n_features), 1). Note that mtry and mtry.ratio are mutually exclusive.

• sampsize: This hyperparameter can alternatively be set via the added hyperparameter sampsize.ratio as sampsize = max(ceiling(sampsize.ratio * n_obs), 1). Note that sampsize and sampsize.ratio are mutually exclusive.

• cores: This value is set as the option rf.cores during training and is set to 1 by default.

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/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

RaphaelS1

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifRandomForestSRC

Methods

Public methods

• LearnerClassifRandomForestSRC$new()

• LearnerClassifRandomForestSRC$importance()

• LearnerClassifRandomForestSRC$selected_features()

• LearnerClassifRandomForestSRC$oob_error()

• LearnerClassifRandomForestSRC$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$train()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClassifRandomForestSRC$new()

---

Method importance()

The importance scores are extracted from the model slot importance, returned for 'all'.

Usage

LearnerClassifRandomForestSRC$importance()

Returns

Named numeric().

---

Method selected_features()

Selected features are extracted from the model slot var.used.

Usage

LearnerClassifRandomForestSRC$selected_features()

Returns

character().

---

Method oob_error()

OOB error extracted from the model slot err.rate.

Usage

LearnerClassifRandomForestSRC$oob_error()

Returns

numeric().

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifRandomForestSRC$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

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

# 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)
#>                          Sample size: 139
#>            Frequency of class labels: 71, 68
#>                      Number of trees: 500
#>            Forest terminal node size: 1
#>        Average no. of terminal nodes: 17.378
#> No. of variables tried at each split: 8
#>               Total no. of variables: 60
#>        Resampling used to grow trees: swor
#>     Resample size used to grow trees: 88
#>                             Analysis: RF-C
#>                               Family: class
#>                       Splitting rule: gini *random*
#>        Number of random split points: 10
#>                     Imbalanced ratio: 1.0441
#>                    (OOB) Brier score: 0.14077044
#>         (OOB) Normalized Brier score: 0.56308175
#>                            (OOB) AUC: 0.91197183
#>                       (OOB) Log-loss: 0.44492997
#>                         (OOB) PR-AUC: 0.91882899
#>                         (OOB) G-mean: 0.84471651
#>    (OOB) Requested performance error: 0.15107914, 0.08450704, 0.22058824
#> 
#> Confusion matrix:
#> 
#>           predicted
#>   observed  M  R class.error
#>          M 65  6      0.0845
#>          R 15 53      0.2206
#> 
#>       (OOB) Misclassification rate: 0.1510791
print(learner$importance())
#>           V11           V12           V21           V49           V36 
#>  0.0658441140  0.0536224530  0.0306047546  0.0292171400  0.0250809033 
#>           V48           V52            V9            V5           V17 
#>  0.0248664440  0.0237508427  0.0227242488  0.0212137454  0.0183397196 
#>           V37           V20           V45           V13           V23 
#>  0.0177327988  0.0176541374  0.0158261166  0.0155631689  0.0154107935 
#>           V27           V10           V47            V4           V15 
#>  0.0148297002  0.0147100984  0.0143661845  0.0138919289  0.0138692034 
#>           V30           V51           V44           V39           V16 
#>  0.0132140191  0.0126448122  0.0125178925  0.0114821325  0.0101823632 
#>            V6           V43           V42           V22           V59 
#>  0.0094974330  0.0092954300  0.0091809356  0.0088764991  0.0076996871 
#>            V1           V41           V31           V25           V28 
#>  0.0074530008  0.0073835419  0.0072664804  0.0072530896  0.0068211734 
#>           V55           V40           V18           V57           V56 
#>  0.0062397069  0.0059943184  0.0058160559  0.0057854052  0.0056794650 
#>           V19           V26           V32            V3            V8 
#>  0.0056671162  0.0054099525  0.0052236676  0.0050790018  0.0049286661 
#>           V33           V14           V46           V24           V53 
#>  0.0046205600  0.0046083001  0.0045053359  0.0039387940  0.0039223230 
#>            V2           V35           V29           V58            V7 
#>  0.0038864646  0.0037458611  0.0028675325  0.0027739737  0.0027526127 
#>           V34           V50           V38           V60           V54 
#>  0.0018715804  0.0018641122  0.0017145060  0.0002866583 -0.0002557960 

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

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