@@ -12,19 +12,44 @@ badge](https://plantedml.r-universe.dev/glex/badges/version)](https://plantedml.
1212status] ( https://www.r-pkg.org/badges/version/glex )] ( https://CRAN.R-project.org/package=glex )
1313<!-- badges: end -->
1414
15- Global explanations for tree-based models by decomposing regression or
16- classification functions into the sum of main components and interaction
17- components of arbitrary order. Calculates exact interventional SHAP
18- values and q-interaction interventional SHAP (q being the highest order
19- of interaction present in the model) for tree-based models such as
20- XGBoost.
15+ # Overview
16+
17+ ` glex ` implements ** global, functional decompositions** of tree-based
18+ regression and classification models that decomposes them into ** main
19+ effects** and ** interaction effects** of arbitrary order. In particular,
20+ it can
21+
22+ - compute ** exact interventional SHAP values** (and more generally,
23+ * q-interaction interventional SHAP* , where * q* is the maximal
24+ interaction order present in the model),
25+ - extract ** partial-dependence-functions** (e.g., one dimensional
26+ partial dependence plots),
27+ - produce ** variable‐importance scores** for each main term and
28+ interaction term (of any order), and
29+ - supports ** de-biasing** by removing components that include protected
30+ features.
31+
32+ Under the hood, ` glex ` relies on fast algorithms to compute all required
33+ partial dependence functions exactly.
34+
35+ For a detailed description of the methodology, see:
2136
2237See the accompanying paper for more details and exact definitions:
2338“Unifying local and global model explanations by functional
2439decomposition of low dimensional structures”
2540([ arxiv] ( https://arxiv.org/abs/2208.06151 ) ,
2641[ PMLR] ( https://proceedings.mlr.press/v206/hiabu23a.html ) ).
2742
43+ > ** Hiabu, Meyer & Wright (2023).**
44+ > * Unifying local and global model explanations by functional
45+ > decomposition of low dimensional structures.*
46+ > [ arXiv] ( https://arxiv.org/abs/2208.06151 ) • [ AISTATS 2023
47+ > Proceedings] ( https://proceedings.mlr.press/v206/hiabu23a.html )
48+
49+ > ** Liu, Steensgaard, Wright, Pfister, Hiabu (2023).**
50+ > * Fast Estimation of Partial Dependence Functions using Trees.*
51+ > [ arXiv] ( https://arxiv.org/abs/2410.13448 )
52+
2853## Installation
2954
3055You can install the development version of glex from
@@ -41,6 +66,17 @@ or from [r-universe](https://plantedml.r-universe.dev/packages) with
4166install.packages(" glex" , repos = " https://plantedml.r-universe.dev" )
4267```
4368
69+ # Supported Models
70+
71+ Currently, ` glex ` supports:
72+
73+ - ** XGBoost** (via the ` xgboost ` package).
74+
75+ - ** Random Planted Forest** (via the ` randomPlantedForest ` package).
76+
77+ More tree‐based frameworks may be added in future releases. If you have
78+ a suggestion, please open an issue on our GitHub repository.
79+
4480## What’s Included
4581
4682Currently ` glex ` works with
0 commit comments