Skip to content

sebrauschert/kappaRule

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kappaRule: A parallel implementation of the RuleFit algorithm by Friedman and Popescue

Background

With the field of machine learning and artificial intelligence moving fast and creating a vast amount of great but un-interpretable models and solutions, the need for interpret-ability is on the rise.

The RuleFit algorithm by Friedman and Popescue is an elegant proposal to combine any tree ensemble based model and penalised regression models.

The basic idea is, that tree based models create rules - think the paths along the branches of the tree are "if - else" statements, with cut-off values. This conditions can either be met - TRUE - or not - FALSE - and can hence be re-coded into a range of binary rule variables.

Those rule variables, together with the original features of the data set, are then fed into a penalised regression model (L1 or L2), where the model selects the variables allowing for the best prediction.

In the end, we are left with a list of interpretable rules.

The number of rules, however, can still be large, which is a hindrance to interpretability. If we are left with 100 rules, what does this actually mean?

Solution

With kappaRule, we force a pre-selection of rules for the model. The number can be set by the user, but defaults to 10 rules at maximum. What does this mean? The performance of every rule gets evaluated against the ground truth, before being added to the penalised regression model.

This forces only the best rules to stay in the model and increases the calculation speed of the penalised regression.

Forcing only a small, highly performant rules to stay in the model, makes the interpretability easier

Benchmark against pre and xrf

Coming soon (what does this mean for performance?)

Installation

devtools::install_github("Hobbeist/kappaRule")

How to

As an example, we use the PimaIndianDiabetes dataset from the mlbench package.

Get the mlbench package

install.packages("mlbench")
library(mlbench)
data("PimaIndianDiabetes")

library(rsample)
library(tidyverse)
library(kappaRule)

Prepare the data

# Re-coding the outcome variable
diabetes <- PimaIndianDiabetes %>%
         mutate(diabetes = as.factor(ifelse(diabetes %in% "neg", 0, 1)))


# Train and Test set
set.seed(456)
split <- initial_split(diabetes)
train <- training(split)
test  <- testing(split)

Run the ruleFit model

rf_results <- 
  ruleFit(data = train,
          y = "diabetes",
          ntree = 2000,
          max.depth = 3,
          rule.filter = 10,
          rule.extract.cores = parallel::detectCores(),
          kappa.cores = parallel::detectCores()
  )

ruleFit results object

=========================================


  _____       _      ______ _ _
 |  __ \     | |    |  ____(_) |
 | |__) |   _| | ___| |__   _| |_
 |  _  / | | | |/ _ \  __| | | __|
 | | \ \ |_| | |  __/ |    | | |_
 |_|  \_\__,_|_|\___|_|    |_|\__|



========== Final RuleFit model ==========

  Number of rules : 5 
  Top Rule : rule_1240 
  Prediction finished after : 5.650231 mins 

=========================================

Top predictors with performance:

    features        coefs                                         rules
1  rule_1240  0.571078463  pedigree >= 0.211 & age < 59.5 & age >= 24.5
2  rule_9001  0.509554892 mass >= 26.7 & age >= 28.5 & pedigree < 1.178
3   pedigree  0.359358593                                          <NA>
4  rule_2543  0.266639832   insulin < 210 & age >= 26.5 & mass >= 26.35
5  rule_9354  0.263752536    age < 59.5 & pregnant < 13.5 & age >= 28.5
6  rule_1825  0.123884775      age >= 32.5 & age >= 29.5 & mass >= 26.3
7       mass  0.051551334                                          <NA>
8    glucose  0.031630574                                          <NA>
9   pressure -0.009338871                                          <NA>
10  pregnant  0.008273054                                          <NA>

=========================================

Model call: 
kappaRule(data = train, y = "diabetes", ntree = 2000, max.depth = 3, 
    rule.filter = 10, rule.extract.cores = 64, kappa.cores = 64)

Predict

predict.ruleFit(test_data = test, 
                model = rf_results,
                predict = "class")

Results:

[1] 0 1 0 0 0 0 1 1 1 0 0 1 0 0 0 0 0 0 0 0 1 0 1 0 0 0 1 0 0 1 0 0 0 0 0 0 0 1 0 0 1 0 1 1 0 1 0 0 1 1 1 1 1 0 0 1 0 1 0 0 0 0 0 0 0 1 1 1 0
 [70] 1 1 1 0 1 0 0 0 1 0 0 1 0 0 0 0 0 0 1 0 1 1 0 0 1 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 1 1 1 0 0 0 0 0 0 1 0 0 0 0 1 0 1 0 1 0 0 1 0 0 0 1 1
[139] 0 1 1 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 1 0 0 0 1 0 1 0 0 1 1 0 1 1 1 0 0 1 1 0 0 0 0 0 1 1 0 0 0 1 1 1 0 0 0 0
Levels: 0 1

Evaluate

kappaRule_metrics(test_data = test, 
                  model = rf_results)

Output:

# A tibble: 13 x 3
   Measure              Train_Metrics Test_Metrics
   <chr>                        <dbl>        <dbl>
 1 accuracy                     0.780        0.766
 2 kappa                        0.467        0.490
 3 sensitivity                  0.783        0.802
 4 specificity                  0.769        0.697
 5 pos_pred_value               0.921        0.835
 6 neg_pred_value               0.508        0.648
 7 precision                    0.921        0.835
 8 recall                       0.783        0.802
 9 f1                           0.846        0.818
10 prevalence                   0.774        0.656
11 detection_rate               0.606        0.526
12 detection_prevalence         0.658        0.630
13 balanced_accuracy            0.776        0.749

LICENSE

The contents of this repository are distributed under the MIT license. See below for details:

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages