mlr3fselect (version 0.12.0)

FSelectInstanceSingleCrit: Class for Single Criterion Feature Selection

Description

The FSelectInstanceSingleCrit specifies a feature selection problem for FSelectors. The function fsi() creates a FSelectInstanceSingleCrit and the function fselect() creates an instance internally.

The instance contains an ObjectiveFSelect object that encodes the black box objective function a FSelector has to optimize. The instance allows the basic operations of querying the objective at design points ($eval_batch()). This operation is usually done by the FSelector. Evaluations of feature subsets are performed in batches by calling mlr3::benchmark() internally. The evaluated feature subsets are stored in the Archive ($archive). Before a batch is evaluated, the bbotk::Terminator is queried for the remaining budget. If the available budget is exhausted, an exception is raised, and no further evaluations can be performed from this point on. The FSelector is also supposed to store its final result, consisting of a selected feature subset and associated estimated performance values, by calling the method instance$assign_result().

Default Measures

If no measure is passed, the default measure is used. The default measure depends on the task type.

Task	Default Measure	Package
"classif"	"classif.ce"	mlr3
"regr"	"regr.mse"	mlr3
"surv"	"surv.cindex"	mlr3proba
"dens"	"dens.logloss"	mlr3proba
"classif_st"	"classif.ce"	mlr3spatial
"regr_st"	"regr.mse"	mlr3spatial
"clust"	"clust.dunn"	mlr3cluster

Resources

There are several sections about feature selection in the mlr3book.

• Getting started with wrapper feature selection.

• Do a sequential forward selection Palmer Penguins data set.

The gallery features a collection of case studies and demos about optimization.

• Utilize the built-in feature importance of models with Recursive Feature Elimination.

• Run a feature selection with Shadow Variable Search.

• Feature Selection on the Titanic data set.

Analysis

For analyzing the feature selection results, it is recommended to pass the archive to as.data.table(). The returned data table is joined with the benchmark result which adds the mlr3::ResampleResult for each feature set.

The archive provides various getters (e.g. $learners()) to ease the access. All getters extract by position (i) or unique hash (uhash). For a complete list of all getters see the methods section.

The benchmark result ($benchmark_result) allows to score the feature sets again on a different measure. Alternatively, measures can be supplied to as.data.table().

Super classes

bbotk::OptimInstance -> bbotk::OptimInstanceSingleCrit -> FSelectInstanceSingleCrit

Active bindings

result_feature_set

(character())
Feature set for task subsetting.

Methods

Public methods

• FSelectInstanceSingleCrit$new()

• FSelectInstanceSingleCrit$assign_result()

• FSelectInstanceSingleCrit$print()

• FSelectInstanceSingleCrit$clone()

Inherited methods

• bbotk::OptimInstance$clear()
• bbotk::OptimInstance$eval_batch()
• bbotk::OptimInstance$format()
• bbotk::OptimInstance$objective_function()

---

Method new()

Creates a new instance of this R6 class.

Usage

FSelectInstanceSingleCrit$new(
  task,
  learner,
  resampling,
  measure,
  terminator,
  store_benchmark_result = TRUE,
  store_models = FALSE,
  check_values = FALSE,
  callbacks = list(),
  ties_method = "least_features"
)

Arguments

task

(mlr3::Task)
Task to operate on.

learner

(mlr3::Learner)
Learner to optimize the feature subset for.

resampling

(mlr3::Resampling)
Resampling that is used to evaluated the performance of the feature subsets. Uninstantiated resamplings are instantiated during construction so that all feature subsets are evaluated on the same data splits. Already instantiated resamplings are kept unchanged.

measure

(mlr3::Measure)
Measure to optimize. If NULL, default measure is used.

terminator

(Terminator)
Stop criterion of the feature selection.

store_benchmark_result

(logical(1))
Store benchmark result in archive?

store_models

(logical(1)). Store models in benchmark result?

check_values

(logical(1))
Check the parameters before the evaluation and the results for validity?

callbacks

(list of CallbackFSelect)
List of callbacks.

ties_method

(character(1))
The method to break ties when selecting sets while optimizing and when selecting the best set. Can be "least_features" or "random". The option "least_features" (default) selects the feature set with the least features. If there are multiple best feature sets with the same number of features, one is selected randomly. The random method returns a random feature set from the best feature sets. Ignored if multiple measures are used.

---

Method assign_result()

The FSelector writes the best found feature subset and estimated performance value here. For internal use.

Usage

FSelectInstanceSingleCrit$assign_result(xdt, y)

Arguments

xdt

(data.table::data.table())
x values as data.table. Each row is one point. Contains the value in the search space of the FSelectInstanceMultiCrit object. Can contain additional columns for extra information.

y

(numeric(1))
Optimal outcome.

---

Method print()

Printer.

Usage

FSelectInstanceSingleCrit$print(...)

Arguments

...

(ignored).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FSelectInstanceSingleCrit$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Feature selection on Palmer Penguins data set
# \donttest{

task = tsk("penguins")
learner = lrn("classif.rpart")

# Construct feature selection instance
instance = fsi(
  task = task,
  learner = learner,
  resampling = rsmp("cv", folds = 3),
  measures = msr("classif.ce"),
  terminator = trm("evals", n_evals = 4)
)

# Choose optimization algorithm
fselector = fs("random_search", batch_size = 2)

# Run feature selection
fselector$optimize(instance)

# Subset task to optimal feature set
task$select(instance$result_feature_set)

# Train the learner with optimal feature set on the full data set
learner$train(task)

# Inspect all evaluated sets
as.data.table(instance$archive)
# }