mlr_learners_regr.M5Rules: Regression M5Rules Learner

In mlr-org/mlr3extralearners: Extra Learners For mlr3

Regression M5Rules Learner

Description

Algorithm for inducing decision lists from model trees. Calls RWeka::M5Rules() from RWeka.

Dictionary

This Learner can be instantiated via lrn():

lrn("regr.M5Rules")

Meta Information

• Task type: “regr”

• Predict Types: “response”

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

• Required Packages: mlr3, mlr3extralearners, RWeka

Parameters

Id	Type	Default	Levels	Range
subset	untyped	-		-
na.action	untyped	-		-
N	logical	FALSE	TRUE, FALSE	-
U	logical	FALSE	TRUE, FALSE	-
R	logical	FALSE	TRUE, FALSE	-
M	integer	4		(-\infty, \infty)
output_debug_info	logical	FALSE	TRUE, FALSE	-
do_not_check_capabilities	logical	FALSE	TRUE, FALSE	-
num_decimal_places	integer	2		[1, \infty)
batch_size	integer	100		[1, \infty)
options	untyped	NULL		-

Custom mlr3 parameters

• output_debug_info:

  • original id: output-debug-info

• do_not_check_capabilities:

  • original id: do-not-check-capabilities

• num_decimal_places:

  • original id: num-decimal-places

• batch_size:

  • original id: batch-size

• Reason for change: This learner contains changed ids of the following control arguments since their ids contain irregular pattern

Super classes

mlr3::Learner -> mlr3::LearnerRegr -> LearnerRegrM5Rules

Methods

Public methods

• LearnerRegrM5Rules$new()

• LearnerRegrM5Rules$clone()

Inherited methods

• mlr3::Learner$base_learner()
• 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

LearnerRegrM5Rules$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerRegrM5Rules$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

henrifnk

References

Holmes, Geoffrey, Hall, Mark, Prank, Eibe (1999). “Generating rule sets from model trees.” In Australasian joint conference on artificial intelligence, 1–12. Springer.

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.

Examples

# Define the Learner
learner = mlr3::lrn("regr.M5Rules")
print(learner)

# Define a Task
task = mlr3::tsk("mtcars")

# 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)


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

# Score the predictions
predictions$score()

mlr-org/mlr3extralearners documentation built on Nov. 11, 2024, 11:11 a.m.