Skip to contents

Imbalanced Random forest for classification between two classes. Calls randomForestSRC::imbalanced.rfsrc() from from randomForestSRC.

Dictionary

This Learner can be instantiated via lrn():

lrn("classif.imbalanced_rfsrc")

Meta Information

  • Task type: “classif”

  • Predict Types: “response”, “prob”

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

  • Required Packages: mlr3, randomForestSRC

Parameters

IdTypeDefaultLevelsRange
ntreeinteger500\([1, \infty)\)
methodcharacterrfqrfq, brf, standard-
block.sizeinteger10\([1, \infty)\)
fastlogicalFALSETRUE, FALSE-
rationumeric-\([0, 1]\)
mtryinteger-\([1, \infty)\)
mtry.rationumeric-\([0, 1]\)
nodesizeinteger15\([1, \infty)\)
nodedepthinteger-\([1, \infty)\)
splitrulecharacterginigini, auc, entropy-
nsplitinteger10\([0, \infty)\)
importancecharacterFALSEFALSE, TRUE, none, permute, random, anti-
bootstrapcharacterby.rootby.root, by.node, none, by.user-
samptypecharactersworswor, swr-
sampuntyped--
membershiplogicalFALSETRUE, FALSE-
sampsizeuntyped--
sampsize.rationumeric-\([0, 1]\)
na.actioncharacterna.omitna.omit, na.impute-
nimputeinteger1\([1, \infty)\)
ntimeinteger-\([1, \infty)\)
proximitycharacterFALSEFALSE, TRUE, inbag, oob, all-
distancecharacterFALSEFALSE, TRUE, inbag, oob, all-
forest.wtcharacterFALSEFALSE, TRUE, inbag, oob, all-
xvar.wtuntyped--
split.wtuntyped--
forestlogicalTRUETRUE, FALSE-
var.usedcharacterFALSEFALSE, all.trees-
split.depthcharacterFALSEFALSE, all.trees-
seedinteger-\((-\infty, -1]\)
do.tracelogicalFALSETRUE, FALSE-
get.treeuntyped--
outcomecharactertraintrain, test-
ptn.countinteger0\([0, \infty)\)
coresinteger1\([1, \infty)\)
save.memorylogicalFALSETRUE, FALSE-
perf.typecharacter-gmean, misclass, brier, none-
case.depthlogicalFALSETRUE, FALSE-
marginal.xvaruntypedNULL-

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

O’Brien R, Ishwaran H (2019). “A random forests quantile classifier for class imbalanced data.” Pattern Recognition, 90, 232–249. doi:10.1016/j.patcog.2019.01.036 .

Chao C, Leo B (2004). “Using Random Forest to Learn Imbalanced Data.” University of California, Berkeley.

See also

Author

HarutyunyanLiana

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifImbalancedRandomForestSRC

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.


Method importance()

The importance scores are extracted from the slot importance.

Usage

LearnerClassifImbalancedRandomForestSRC$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

LearnerClassifImbalancedRandomForestSRC$selected_features()

Returns

character().


Method oob_error()

OOB error extracted from the model slot err.rate.

Usage

LearnerClassifImbalancedRandomForestSRC$oob_error()

Returns

numeric().


Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifImbalancedRandomForestSRC$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Define the Learner
learner = lrn("classif.imbalanced_rfsrc", importance = "TRUE")
print(learner)
#> 
#> ── <LearnerClassifImbalancedRandomForestSRC> (classif.imbalanced_rfsrc): Imbalan
#> • Model: -
#> • Parameters: importance=TRUE
#> • Packages: mlr3 and randomForestSRC
#> • Predict Types: [response] and prob
#> • Feature Types: logical, integer, numeric, factor, and ordered
#> • Encapsulation: none (fallback: -)
#> • Properties: importance, missings, 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: M=79, R=60
#>                      Number of trees: 3000
#>            Forest terminal node size: 1
#>        Average no. of terminal nodes: 15.7757
#> 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: RFQ
#>                               Family: class
#>                       Splitting rule: auc *random*
#>        Number of random split points: 10
#>                     Imbalanced ratio: 1.3167
#>                    (OOB) Brier score: 0.12239292
#>         (OOB) Normalized Brier score: 0.48957167
#>                            (OOB) AUC: 0.92025316
#>                       (OOB) Log-loss: 0.39385863
#>                         (OOB) PR-AUC: 0.90976031
#>                         (OOB) G-mean: 0.81183233
#>    (OOB) Requested performance error: 0.18816767
#> 
#> Confusion matrix:
#> 
#>           predicted
#>   observed  M  R class.error
#>          M 71  8      0.1013
#>          R 16 44      0.2667
#> 
#>       (OOB) Misclassification rate: 0.1726619
#> 
#> Random-classifier baselines (uniform):
#>    Brier: 0.25   Normalized Brier: 1   Log-loss: 0.69314718
print(learner$importance())
#>           V32           V60           V36           V26           V31 
#>  0.0173364957  0.0173364957  0.0149502188  0.0115159356  0.0115159356 
#>           V45           V50           V11           V14           V16 
#>  0.0115159356  0.0115159356  0.0057374028  0.0057374028  0.0057374028 
#>           V18           V23            V3           V33           V34 
#>  0.0057374028  0.0057374028  0.0057374028  0.0057374028  0.0057374028 
#>           V37           V38           V39           V40           V41 
#>  0.0057374028  0.0057374028  0.0057374028  0.0057374028  0.0057374028 
#>           V42           V55           V56           V59            V1 
#>  0.0057374028  0.0057374028  0.0057374028  0.0057374028  0.0024725255 
#>           V10           V13           V19           V22           V43 
#>  0.0024725255  0.0024725255  0.0024725255  0.0024725255  0.0024725255 
#>           V44           V15           V17           V24           V25 
#>  0.0024725255  0.0000000000  0.0000000000  0.0000000000  0.0000000000 
#>           V30            V5           V57            V6            V7 
#>  0.0000000000  0.0000000000  0.0000000000  0.0000000000  0.0000000000 
#>           V20           V21           V27            V4           V53 
#> -0.0005195727 -0.0005195727 -0.0033713035 -0.0033713035 -0.0033713035 
#>           V54           V58           V35            V9           V52 
#> -0.0033713035 -0.0033713035 -0.0056971389 -0.0056971389 -0.0064709483 
#>            V2           V28           V29           V46            V8 
#> -0.0091735378 -0.0091735378 -0.0091735378 -0.0091735378 -0.0091735378 
#>           V12           V47           V48           V51           V49 
#> -0.0182457013 -0.0182457013 -0.0182457013 -0.0182457013 -0.0240708817 

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

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