MeasureClust: Cluster Measure

In mlr-org/mlr3cluster: Cluster Extension for 'mlr3'

Cluster Measure

Description

This measure specializes mlr3::Measure for cluster analysis:

• task_type is set to "clust".

• Possible values for predict_type are "partition" and "prob".

Predefined measures can be found in the mlr3misc::Dictionary mlr3::mlr_measures.

Super class

mlr3::Measure -> MeasureClust

Methods

Public methods

• MeasureClust$new()

Inherited methods

• mlr3::Measure$aggregate()
• mlr3::Measure$format()
• mlr3::Measure$help()
• mlr3::Measure$print()
• mlr3::Measure$score()

---

Method new()

Creates a new instance of this R6 class.

Usage

MeasureClust$new(
  id,
  range,
  minimize = NA,
  aggregator = NULL,
  properties = character(),
  predict_type = "partition",
  task_properties = character(),
  packages = character(),
  label = NA_character_,
  man = NA_character_
)

Arguments

id

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

range

(numeric(2))
Feasible range for this measure as c(lower_bound, upper_bound). Both bounds may be infinite.

minimize

(logical(1))
Set to TRUE if good predictions correspond to small values, and to FALSE if good predictions correspond to large values. If set to NA (default), tuning this measure is not possible.

aggregator

(⁠function(x)⁠)
Function to aggregate individual performance scores x where x is a numeric vector. If NULL, defaults to mean().

properties

(character())
Properties of the measure. Must be a subset of mlr_reflections$measure_properties. Supported by mlr3:

• "requires_task" (requires the complete mlr3::Task),

• "requires_learner" (requires the trained mlr3::Learner),

• "requires_train_set" (requires the training indices from the mlr3::Resampling), and

• "na_score" (the measure is expected to occasionally return NA or NaN).

predict_type

(character(1))
Required predict type of the mlr3::Learner. Possible values are stored in mlr_reflections$learner_predict_types.

task_properties

(character())
Required task properties, see mlr3::Task.

packages

(character())
Set of required packages. A warning is signaled by the constructor if at least one of the packages is not installed, but loaded (not attached) later on-demand via requireNamespace().

label

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

man

(character(1))
String in the format ⁠[pkg]::[topic]⁠ pointing to a manual page for this object. The referenced help package can be opened via method ⁠$help()⁠.

See Also

Example cluster measures: clust.dunn

mlr-org/mlr3cluster documentation built on Dec. 24, 2024, 3:19 a.m.