TaskSupervised: Supervised Task

Description Super class Methods See Also Examples

Description

This is the abstract base class for task objects like TaskClassif and TaskRegr. It extends Task with methods to handle a target columns. Supervised tasks for probabilistic regression (including survival analysis) can be found in mlr3proba.

Super class

mlr3::Task -> TaskSupervised

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of this R6 class.

Usage
TaskSupervised$new(id, task_type, backend, target, extra_args = list())
Arguments
id

(character(1))
Identifier for the new instance.

task_type

(character(1))
Type of task, e.g. "regr" or "classif". Must be an element of mlr_reflections$task_types$type.

backend

(DataBackend)
Either a DataBackend, or any object which is convertible to a DataBackend with as_data_backend(). E.g., a data.frame() will be converted to a DataBackendDataTable.

target

(character(1))
Name of the target column.

extra_args

(named list())
Named list of constructor arguments, required for converting task types via convert_task().


Method truth()

True response for specified row_ids. Format depends on the task type. Defaults to all rows with role "use".

Usage
TaskSupervised$truth(rows = NULL)
Arguments
rows

integer()
Row indices.


Method clone()

The objects of this class are cloneable with this method.

Usage
TaskSupervised$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

Other Task: TaskClassif, TaskRegr, TaskUnsupervised, Task, mlr_tasks_boston_housing, mlr_tasks_breast_cancer, mlr_tasks_german_credit, mlr_tasks_iris, mlr_tasks_mtcars, mlr_tasks_penguins, mlr_tasks_pima, mlr_tasks_sonar, mlr_tasks_spam, mlr_tasks_wine, mlr_tasks_zoo, mlr_tasks

Examples

1
2
TaskSupervised$new("penguins", task_type = "classif", backend = palmerpenguins::penguins,
  target = "species")

mlr3 documentation built on Aug. 6, 2021, 1:07 a.m.