dials: ranger_parameters – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

ranger_parameters

Parameters for possible engine parameters for ranger

Description

These parameters are auxiliary to random forest models that use the "ranger" engine. They correspond to tuning parameters that would be specified using set_engine("ranger", ...).

Usage

regularization_factor(range = c(0, 1), trans = NULL)

regularize_depth(values = c(TRUE, FALSE))

significance_threshold(range = c(-10, 0), trans = log10_trans())

lower_quantile(range = c(0, 1), trans = NULL)

splitting_rule(values = ranger_split_rules)

ranger_class_rules

ranger_reg_rules

ranger_split_rules

num_random_splits(range = c(1L, 15L), trans = NULL)

Arguments

`range`	A two-element vector holding the defaults for the smallest and largest possible values, respectively.
`trans`	A `trans` object from the `scales` package, such as `scales::log10_trans()` or `scales::reciprocal_trans()`. If not provided, the default is used which matches the units used in `range`. If no transformation, `NULL`.
`values`	For `splitting_rule()`, a character string of possible values. See `ranger_split_rules`, `ranger_class_rules`, and `ranger_reg_rules` for appropriate values. For `regularize_depth()`, either `TRUE` or `FALSE`.

Format

An object of class character of length 4.

An object of class character of length 3.

An object of class character of length 7.

Details

To use these, check ?ranger::ranger to see how they are used. Some are conditional on others. For example, significance_threshold(), num_random_splits(), and others are only used when splitting_rule = "extratrees".

Examples

regularization_factor()
regularize_depth()

dials

Tools for Creating Tuning Parameter Values

v0.0.10

MIT + file LICENSE

Authors

Max Kuhn [aut], Hannah Frick [aut, cre], RStudio [cph]

Initial release