Regression Conditional Random Forest Learner

Calls partykit::cforest from package partykit.

Dictionary

This Learner can be instantiated via the dictionary mlr_learners or with the associated sugar function lrn():

mlr_learners$get("regr.cforest")
lrn("regr.cforest")

Meta Information

• Task type: “regr”

• Predict Types: “response”

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

• Required Packages: mlr3extralearners, partykit, sandwich, coin

Parameters

Id	Type	Default	Levels	Range
ntree	integer	500		\([1, \infty)\)
replace	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
fraction	numeric	0.632		\([0, 1]\)
mtry	integer	-		\([0, \infty)\)
mtryratio	numeric	-		\([0, 1]\)
applyfun	list	-		\((-\infty, \infty)\)
cores	integer	NULL		\((-\infty, \infty)\)
trace	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
offset	list	-		\((-\infty, \infty)\)
cluster	list	-		\((-\infty, \infty)\)
scores	list	-		\((-\infty, \infty)\)
teststat	character	quadratic	quadratic, maximum	\((-\infty, \infty)\)
splitstat	character	quadratic	quadratic, maximum	\((-\infty, \infty)\)
splittest	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
testtype	character	Univariate	Bonferroni, MonteCarlo, Univariate, Teststatistic	\((-\infty, \infty)\)
nmax	list	-		\((-\infty, \infty)\)
pargs	list	-		\((-\infty, \infty)\)
alpha	numeric	0.05		\([0, 1]\)
mincriterion	numeric	0		\([0, 1]\)
logmincriterion	numeric	0		\((-\infty, \infty)\)
minsplit	integer	20		\([1, \infty)\)
minbucket	integer	7		\([1, \infty)\)
minprob	numeric	0.01		\([0, 1]\)
stump	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
lookahead	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
MIA	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
maxvar	integer	-		\([1, \infty)\)
nresample	integer	9999		\([1, \infty)\)
tol	numeric	1.490116e-08		\([0, \infty)\)
maxsurrogate	integer	0		\([0, \infty)\)
numsurrogate	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
maxdepth	integer	Inf		\([0, \infty)\)
multiway	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
splittry	integer	2		\([0, \infty)\)
intersplit	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
majority	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
caseweights	logical	TRUE	TRUE, FALSE	\((-\infty, \infty)\)
saveinfo	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
update	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
splitflavour	character	ctree	ctree, exhaustive	\((-\infty, \infty)\)
OOB	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
simplify	logical	TRUE	TRUE, FALSE	\((-\infty, \infty)\)
scale	logical	TRUE	TRUE, FALSE	\((-\infty, \infty)\)
nperm	integer	1		\([0, \infty)\)
risk	character	loglik	loglik, misclassification	\((-\infty, \infty)\)
conditional	logical	FALSE	TRUE, FALSE	\((-\infty, \infty)\)
threshold	numeric	0.2		\((-\infty, \infty)\)

Custom mlr3 defaults

• mtry:

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

References

`r format_bib(c("hothorn_2015", "hothorn_2006"))

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

sumny

Super classes

mlr3::Learner -> mlr3::LearnerRegr -> LearnerRegrCForest

Methods

Public methods

• LearnerRegrCForest$new()

• LearnerRegrCForest$oob_error()

• LearnerRegrCForest$clone()

Inherited methods

• mlr3::Learner$base_learner()

• 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

LearnerRegrCForest$new()

---

Method oob_error()

The out-of-bag error, calculated using the OOB predictions from partykit.

Usage

LearnerRegrCForest$oob_error()

Returns

numeric(1).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerRegrCForest$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (requireNamespace("partykit", quietly = TRUE) && requireNamespace("sandwich", quietly = TRUE) && requireNamespace("coin", quietly = TRUE)) {
  learner = mlr3::lrn("regr.cforest")
  print(learner)

  # available parameters:
  learner$param_set$ids()
}
#> <LearnerRegrCForest:regr.cforest>
#> * Model: -
#> * Parameters: teststat=quadratic, testtype=Univariate, mincriterion=0,
#>   saveinfo=FALSE
#> * Packages: mlr3, mlr3extralearners, partykit, sandwich, coin
#> * Predict Type: response
#> * Feature types: integer, numeric, factor, ordered
#> * Properties: oob_error, weights
#>  [1] "ntree"           "replace"         "fraction"        "mtry"           
#>  [5] "mtryratio"       "applyfun"        "cores"           "trace"          
#>  [9] "offset"          "cluster"         "scores"          "teststat"       
#> [13] "splitstat"       "splittest"       "testtype"        "nmax"           
#> [17] "pargs"           "alpha"           "mincriterion"    "logmincriterion"
#> [21] "minsplit"        "minbucket"       "minprob"         "stump"          
#> [25] "lookahead"       "MIA"             "maxvar"          "nresample"      
#> [29] "tol"             "maxsurrogate"    "numsurrogate"    "maxdepth"       
#> [33] "multiway"        "splittry"        "intersplit"      "majority"       
#> [37] "caseweights"     "saveinfo"        "update"          "splitflavour"   
#> [41] "OOB"             "simplify"        "scale"           "nperm"          
#> [45] "risk"            "conditional"     "threshold"