Skip to contents

This is the abstract base class for unsupervised tasks such as cluster tasks in mlr3cluster and mlr3spatial.

See also

Other Task: Task, TaskClassif, TaskRegr, TaskSupervised, mlr_tasks, 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

Super class

mlr3::Task -> TaskUnsupervised

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.

Usage

TaskUnsupervised$new(
  id,
  task_type = "unsupervised",
  backend,
  label = NA_character_,
  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.

label

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

extra_args

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


Method clone()

The objects of this class are cloneable with this method.

Usage

TaskUnsupervised$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

TaskUnsupervised$new("penguins", task_type = "regr", backend = palmerpenguins::penguins)
#> <TaskUnsupervised:penguins> (344 x 8)
#> * Target: -
#> * Properties: -
#> * Features (8):
#>   - int (3): body_mass_g, flipper_length_mm, year
#>   - fct (3): island, sex, species
#>   - dbl (2): bill_depth_mm, bill_length_mm