Learn R
mlr3 (version 0.1.4)

predict.Learner: Predict Method for Learners

Description

Extends the generic stats::predict() with a method for Learner. Note that this function is intended as glue code to be used in third party packages. We recommend to work with the Learner directly, i.e. calling learner$predict() or learner$predict_newdata() directly.

Performs the following steps:

  • Sets additional hyperparameters passed to this function.

  • Creates a Prediction object by calling learner$predict_newdata().

  • Returns (subset of) Prediction.

Usage

# S3 method for Learner
predict(object, newdata, predict_type = NULL, ...)

Arguments

object

:: Learner Any Learner.

newdata

:: data.frame() New data to predict on.

predict_type

:: character(1) The predict type to return. Set to <Prediction> to retrieve the complete Prediction object. If set to NULL (default), the first predict type for the respective class of the Learner as stored in mlr_reflections is used.

...

:: any Hyperparameters to pass down to the Learner.

Examples

Run this code
# NOT RUN {
task = tsk("spam")

learner = lrn("classif.rpart", predict_type = "prob")
learner$train(task)
predict(learner, task$data(1:3), predict_type = "response")
predict(learner, task$data(1:3), predict_type = "prob")
predict(learner, task$data(1:3), predict_type = "<Prediction>")
# }

Run the code above in your browser using DataCamp Workspace