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)\)
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	-
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	-
marginal.xvar	untyped	NULL		-

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()
• mlr3::LearnerClassif$predict_newdata_fast()

---

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.

Note: Due to a known issue in randomForestSRC, enabling var.used = "all.trees" causes prediction to fail. Therefore, this setting should be used exclusively for feature selection purposes and not when prediction is required.

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 = 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, selected_features,
#> twoclass, and weights
#> • Other settings: use_weights = 'use'

# 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)
#>                          Sample size: 139
#>            Frequency of class labels: 72, 67
#>                      Number of trees: 500
#>            Forest terminal node size: 1
#>        Average no. of terminal nodes: 16.652
#> 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.0746
#>                    (OOB) Brier score: 0.13610636
#>         (OOB) Normalized Brier score: 0.54442543
#>                            (OOB) AUC: 0.91283167
#>                       (OOB) Log-loss: 0.43410875
#>                         (OOB) PR-AUC: 0.91708224
#>                         (OOB) G-mean: 0.81114746
#>    (OOB) Requested performance error: 0.17266187, 0.04166667, 0.31343284
#> 
#> Confusion matrix:
#> 
#>           predicted
#>   observed  M  R class.error
#>          M 69  3      0.0417
#>          R 21 46      0.3134
#> 
#>       (OOB) Misclassification rate: 0.1726619
print(learner$importance())
#>           V12           V11           V52           V48            V9 
#>  0.0965359733  0.0641123921  0.0298177446  0.0283268129  0.0240863439 
#>           V13            V4           V16           V49           V36 
#>  0.0224325138  0.0219555661  0.0206520897  0.0192571445  0.0192111129 
#>           V20           V30           V40           V39           V37 
#>  0.0186637358  0.0179292519  0.0170529309  0.0160542073  0.0152966730 
#>           V18           V21           V32           V27           V10 
#>  0.0148841311  0.0142276411  0.0139252756  0.0138623014  0.0135173002 
#>            V5           V47           V51           V17           V43 
#>  0.0126518018  0.0125362398  0.0119870888  0.0119075559  0.0115194882 
#>            V8           V19           V15           V45           V42 
#>  0.0110393943  0.0101749029  0.0095887215  0.0093138479  0.0090468045 
#>           V46           V56           V31            V6           V29 
#>  0.0081438812  0.0078994405  0.0078910717  0.0078510393  0.0072519107 
#>           V28            V2           V38           V41           V58 
#>  0.0069625038  0.0068575512  0.0068425960  0.0066690422  0.0065327957 
#>           V33           V54           V53           V24           V26 
#>  0.0061212902  0.0060946518  0.0059773130  0.0058075069  0.0055266438 
#>           V22           V25            V1           V59           V23 
#>  0.0054737590  0.0053720845  0.0050979310  0.0050951942  0.0049627276 
#>            V7           V44           V60           V35           V55 
#>  0.0046387827  0.0043557136  0.0040308315  0.0039280832  0.0037673825 
#>           V14           V34            V3           V50           V57 
#>  0.0036326936  0.0028946734  0.0018885533  0.0018852978 -0.0005628113 

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

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