mlr3fairness (version 0.4.0)

mlr_learners_classif.fairfgrrm: Classification Fair Generalized Ridge Regression Learner

Description

Calls fairml::fgrrm from package fairml.

Dictionary

This mlr3::Learner can be instantiated via the dictionary mlr3::mlr_learners or with the associated sugar function mlr3::lrn():

mlr_learners$get("classif.fairfgrrm")
lrn("classif.fairfgrrm")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

• Feature Types: “integer”, “numeric”, “factor”, “ordered”

• Required Packages: mlr3, fairml

Parameters

Id	Type	Default	Levels	Range
lambda	numeric	0		\([0, \infty)\)
definition	character	sp-komiyama	sp-komiyama, eo-komiyama	-
save.auxiliary	logical	FALSE	TRUE, FALSE	-
unfairness	numeric	-		\([0, 1]\)
family	character	binomial	gaussian, binomial	-
intersect	logical	TRUE	TRUE, FALSE	-

Author

pfistfl

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifFairfgrrm

Methods

Public methods

• LearnerClassifFairfgrrm$new()

• LearnerClassifFairfgrrm$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$configure()
• mlr3::Learner$encapsulate()
• mlr3::Learner$format()
• mlr3::Learner$help()
• mlr3::Learner$predict()
• mlr3::Learner$predict_newdata()
• mlr3::Learner$print()
• mlr3::Learner$reset()
• mlr3::Learner$selected_features()
• mlr3::Learner$train()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClassifFairfgrrm$new()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifFairfgrrm$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Fair generalized ridge regression model implemented via package fairml. The 'unfairness' parameter is set to 0.05 as a default.

References

Scutari M, Panero F, Proissl M (2021). “Achieving Fairness with a Simple Ridge Penalty.” arXiv preprint arXiv:2105.13817.

See Also

Dictionary of Learners: mlr3::mlr_learners

Other fairness_learners: mlr_learners_classif.fairzlrm, mlr_learners_regr.fairfrrm, mlr_learners_regr.fairnclm, mlr_learners_regr.fairzlm

Examples

if (FALSE) { # rlang::is_installed("fairml")
library("mlr3")
# stop example failing with warning if package not installed
learner = suppressWarnings(mlr3::lrn("classif.fairfgrrm"))
print(learner)

# available parameters:
learner$param_set$ids()
}