Package: lorax 0.1.0.9000
Max Kuhn
lorax: Speak for the Trees
Extracts decision rules from tree- and rule-based models fitted in 'R'. Rules are expressed as logical predicates that identify paths to terminal nodes, making model behavior more transparent and interpretable. Provides conversion methods to 'partykit' party objects for a wide range of model types. The 'partykit' infrastructure is described in Hothorn and Zeileis (2015) <https://jmlr.org/papers/v16/hothorn15a.html>.
Authors:
lorax_0.1.0.9000.tar.gz
lorax_0.1.0.9000.zip(r-4.7-any)lorax_0.1.0.9000.zip(r-4.6-any)lorax_0.1.0.9000.zip(r-4.5-any)
lorax_0.1.0.9000.tgz(r-4.6-any)lorax_0.1.0.9000.tgz(r-4.5-any)
lorax_0.1.0.9000.tar.gz(r-4.7-any)lorax_0.1.0.9000.tar.gz(r-4.6-any)
lorax_0.1.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
lorax/json (API)
| # Install 'lorax' in R: |
| install.packages('lorax', repos = c('https://tidymodels.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/tidymodels/lorax/issues
Pkgdown/docs site:https://lorax.tidymodels.org
Last updated from:01b7875dad. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel | OK | 188 | ||
| source / vignettes | OK | 472 | ||
| linux-release | OK | 199 | ||
| macos-release | OK | 152 | ||
| macos-oldrel | OK | 151 | ||
| windows-devel | OK | 163 | ||
| windows-release | OK | 182 | ||
| windows-oldrel | OK | 206 | ||
| wasm-release | OK | 129 |
Exports:active_predictorsas.partycombine_rule_elementsextract_rulesnum_ensemble_membersobliq_split_to_exprrect_split_to_exprrule_textvar_imp
Dependencies:clidplyrFormulagenericsgluehardhatinumlatticelibcoinlifecyclemagrittrMatrixmvtnormpartykitpillarpkgconfigpurrrR6rlangrpartsandwichsparsevctrsstrucchangesurvivaltibbletidyselectutf8vctrswithrzoo
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Extract the active features from a tree | active_predictors active_predictors.bagger active_predictors.bart active_predictors.C5.0 active_predictors.catboost.Model active_predictors.cforest active_predictors.cubist active_predictors.grf active_predictors.lgb.Booster active_predictors.ObliqueForest active_predictors.party active_predictors.randomForest active_predictors.ranger active_predictors.rpart active_predictors.xgb.Booster |
| Convert a bagged tree to a party object | as.party.bagger |
| Convert BART model to party object | as.party.bart |
| Convert C5.0 model to party object | as.party.C5.0 |
| Convert catboost model to party object | as.party.catboost.Model |
| Convert grf model to party object | as.party.grf |
| Convert lgb.Booster model to party object | as.party.lgb.Booster |
| Convert randomForest model to party object | as.party.randomForest |
| Convert ranger model to party object | as.party.ranger |
| Convert xgb.Booster model to party object | as.party.xgb.Booster |
| Combine multiple R expressions into a single composite expression | combine_rule_elements |
| Extract rules from a BART model | extract_rules.bart |
| Extract an expression that defines a path to a terminal node | extract_rules extract_rules.bagger extract_rules.C5.0 extract_rules.cforest extract_rules.grf extract_rules.randomForest extract_rules.ranger |
| Extract rules from a catboost model | extract_rules.catboost.Model |
| Extract rules from a Cubist model | extract_rules.cubist |
| Extract rules from an lgb.Booster model | extract_rules.lgb.Booster |
| Extract rules from an ObliqueForest model | extract_rules.ObliqueForest |
| Extract rules from a party object | extract_rules.party |
| Extract rules from an rpart model | extract_rules.rpart |
| Extract rules from an xgb.Booster model | extract_rules.xgb.Booster |
| Count the number of members in an ensemble | num_ensemble_members num_ensemble_members.bagger num_ensemble_members.bart num_ensemble_members.C5.0 num_ensemble_members.catboost.Model num_ensemble_members.cforest num_ensemble_members.cubist num_ensemble_members.grf num_ensemble_members.lgb.Booster num_ensemble_members.ObliqueForest num_ensemble_members.randomForest num_ensemble_members.ranger num_ensemble_members.xgb.Booster |
| Convert an oblique split to an R expression | obliq_split_to_expr |
| Convert a rectangular split to an R expression | rect_split_to_expr |
| Convert a rule expression to a readable text format | rule_text |
| Methods for tidymodels objects | active_predictors.model_fit active_predictors.workflow as.party.model_fit as.party.workflow extract_rules.model_fit extract_rules.workflow num_ensemble_members.model_fit num_ensemble_members.workflow tidymodels-methods var_imp.model_fit var_imp.workflow |
| Tree Importance Scores | lorax_var_imp var_imp.catboost.Model var_imp.cforest var_imp.grf var_imp.lgb.Booster var_imp.ObliqueForest var_imp.party var_imp.randomForest var_imp.ranger var_imp.rpart var_imp.xgb.Booster |