Skip to contents

Adaptive best-subset selection for regression. Calls abess::abess() from abess.

Dictionary

This Learner can be instantiated via lrn():

lrn("regr.abess")

Meta Information

  • Task type: “regr”

  • Predict Types: “response”

  • Feature Types: “integer”, “numeric”

  • Required Packages: mlr3, abess

Parameters

IdTypeDefaultLevelsRange
familycharactergaussiangaussian, mgaussian, poisson, gamma-
tune.pathcharactersequencesequence, gsection-
tune.typecharactergicgic, aic, bic, ebic, cv-
normalizeintegerNULL\((-\infty, \infty)\)
support.sizeuntypedNULL-
c.maxinteger2\([1, \infty)\)
gs.rangeuntypedNULL-
lambdanumeric0\([0, \infty)\)
always.includeuntypedNULL-
group.indexuntypedNULL-
init.active.setuntypedNULL-
splicing.typeinteger2\([1, 2]\)
max.splicing.iterinteger20\([1, \infty)\)
screening.numintegerNULL\([0, \infty)\)
important.searchintegerNULL\([0, \infty)\)
warm.startlogicalTRUETRUE, FALSE-
nfoldsinteger5\((-\infty, \infty)\)
foldiduntypedNULL-
cov.updatelogicalFALSETRUE, FALSE-
newtoncharacterexactexact, approx-
newton.threshnumeric1e-06\([0, \infty)\)
max.newton.iterintegerNULL\([1, \infty)\)
early.stoplogicalFALSETRUE, FALSE-
ic.scalenumeric1\([0, \infty)\)
num.threadsinteger0\([0, \infty)\)
seedinteger1\((-\infty, \infty)\)

Initial parameter values

  • num.threads: This parameter is initialized to 1 (default is 0) to avoid conflicts with the mlr3 parallelization.

  • family: Depends on the task type, if the parameter family is NULL, it is set to "binomial" for binary classification tasks and to "multinomial" for multiclass classification problems.

See also

Author

abess-team

Super classes

mlr3::Learner -> mlr3::LearnerRegr -> LearnerRegrAbess

Methods

Inherited methods


Method new()

Creates a new instance of this R6 class.

Usage


Method selected_features()

Extract the name of selected features from the model by abess::extract().

Usage

LearnerRegrAbess$selected_features()

Returns

The names of selected features


Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerRegrAbess$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Define the Learner
learner = mlr3::lrn("regr.abess")
print(learner)
#> <LearnerRegrAbess:regr.abess>: Fast Best Subset Selection for Regression
#> * Model: -
#> * Parameters: num.threads=1
#> * Packages: mlr3, abess
#> * Predict Types:  [response]
#> * Feature Types: integer, numeric
#> * Properties: selected_features, weights

# Define a Task
task = mlr3::tsk("mtcars")

# Create train and test set
ids = mlr3::partition(task)

# Train the learner on the training ids
learner$train(task, row_ids = ids$train)

print(learner$model)
#> Call:
#> abess.default(x = task$data(cols = task$feature_names), y = as.matrix(task$data(cols = task$target_names)), 
#>     num.threads = 1L)
#> 
#>   support.size       dev      GIC
#> 1            0 14.039002 55.47863
#> 2            1  4.021386 31.78773
#> 3            2  3.194659 29.51823
#> 4            3  2.678836 28.38374
#> 5            4  2.207066 26.87922
#> 6            5  1.832617 25.53849
#> 7            6  1.670315 26.15467
#> 8            7  1.610751 27.95570
#> 9            8  1.595663 30.32163


# Make predictions for the test rows
predictions = learner$predict(task, row_ids = ids$test)

# Score the predictions
predictions$score()
#> regr.mse 
#> 13.89787