Need help with imodels?
Click the β€œchat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

148 Stars 14 Forks MIT License 205 Commits 0 Opened issues


Interpretable ML package πŸ” for concise, transparent, and accurate predictive modeling (sklearn-compatible).

Services available


Need anything else?

Contributors list

# 44,559
121 commits
# 245,178
1 commit

Interpretable machine-learning models (imodels) πŸ”

Python package for concise, transparent, and accurate predictive modeling. All sklearn-compatible and easily customizable.

docs β€’ imodels overview β€’ demo notebooks

imodels overview

Implementations of different popular interpretable models can be easily used and installed:

from imodels import BayesianRuleListClassifier, GreedyRuleListClassifier, SkopeRulesClassifier
from imodels import SLIMRegressor, RuleFitRegressor

model = BayesianRuleListClassifier() # initialize a model, y_train) # fit model preds = model.predict(X_test) # discrete predictions: shape is (n_test, 1) preds_proba = model.predict_proba(X_test) # predicted probabilities: shape is (n_test, n_classes) print(model) # print the rule-based model

if X1 > 5: then 80.5% risk

else if X2 > 5: then 40% risk

else: 10% risk

Install with

pip install imodels
(see here for help). Contains the following models:

| Model | Reference | Description | | :-------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | Rulefit rule set | πŸ—‚οΈ, πŸ”—, πŸ“„ | Extracts rules from a decision tree then builds a sparse linear model with them | | Skope rule set | πŸ—‚οΈ, πŸ”— | Extracts rules from gradient-boosted trees, deduplicates them, then forms a linear combination of them based on their OOB precision | | Boosted rule set | πŸ—‚οΈ, πŸ”—, πŸ“„ | Uses Adaboost to sequentially learn a set of rules | | Bayesian rule list | πŸ—‚οΈ, πŸ”—, πŸ“„ | Learns a compact rule list by sampling rule lists (rather than using a greedy heuristic) | | Greedy rule list | πŸ—‚οΈ, πŸ”— | Uses CART to learn a list (only a single path), rather than a decision tree | | OneR rule list | πŸ—‚οΈ, πŸ“„ | Learns rule list restricted to only one feature | | Optimal rule tree | πŸ—‚οΈ, πŸ”—, πŸ“„ | (In progress) Learns succinct trees using global optimization rather than greedy heuristics | | Iterative random forest | πŸ—‚οΈ, πŸ”—, πŸ“„ | (In progress) Repeatedly fit random forest, giving features with high importance a higher chance of being selected. | | Sparse integer linear model | πŸ—‚οΈ, πŸ“„ | Forces coefficients to be integers | | Rule sets | βŒ› | (Coming soon) Many popular rule sets including SLIPPER, Lightweight Rule Induction, MLRules |

Docs πŸ—‚οΈ, Reference code implementation πŸ”—, Research paper πŸ“„

More models coming soon!

The final form of the above models takes one of the following forms, which aim to be simultaneously simple to understand and highly predictive:

| Rule set | Rule list | Rule tree | Algebraic models | | :----------------------------------------------------------: | :-----------------------------------------------------: | :-----------------------------------------------------: | :----------------------------------------------------------: | | | | | |

Different models and algorithms vary not only in their final form but also in different choices made during modeling. In particular, many models differ in the 3 steps given by the table below.

ex. RuleFit and SkopeRules RuleFit and SkopeRules differ only in the way they prune rules: RuleFit uses a linear model whereas SkopeRules heuristically deduplicates rules sharing overlap.
ex. Bayesian rule lists and greedy rule lists Bayesian rule lists and greedy rule lists differ in how they select rules; bayesian rule lists perform a global optimization over possible rule lists while Greedy rule lists pick splits sequentially to maximize a given criterion.
ex. FPSkope and SkopeRules FPSkope and SkopeRules differ only in the way they generate candidate rules: FPSkope uses FPgrowth whereas SkopeRules extracts rules from decision trees.

See the docs for individual models for futher descriptions.

| Rule candidate generation | Rule selection | Rule pruning / combination | | :----------------------------------------------------------: | :--------------------------------------------------------: | :-------------------------------------------------------: | | | | |

The code here contains many useful and customizable functions for rule-based learning in the util folder. This includes functions / classes for rule deduplication, rule screening, and converting between trees, rulesets, and neural networks.

Demo notebooks

Demos are contained in the notebooks folder.

  • imodels_demo.ipynb, demos the imodels package. It shows how to fit, predict, and visualize with different interpretable models
  • this notebook shows an example of using
    for deriving a clinical decision rule
  • we also include some demos of posthoc analysis, which occurs after fitting models
    • posthoc.ipynb - shows different simple analyses to interpret a trained model
    • uncertainty.ipynb - basic code to get uncertainty estimates for a model

Support for different tasks

Different models support different machine-learning tasks. Current support for different models is given below:

| Model | Binary classification | Multi-class classification | Regression | | :-------------------------- | :-------------------: | :------------------------: | :--------: | | Rulefit rule set | βœ”οΈ | | βœ”οΈ | | Skope rule set | βœ”οΈ | | | | Boosted rule set | βœ”οΈ | | | | Bayesian rule list | βœ”οΈ | | | | Greedy rule list | βœ”οΈ | | | | OneR rule list | βœ”οΈ | | | | Optimal rule tree | | | | | Iterative random forest | | | | | Sparse integer linear model | | | βœ”οΈ |


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.