funnel_measure: Caluculate difference in performance in models across...

View source: R/funnel_measure.R

funnel_measureR Documentation

Caluculate difference in performance in models across different categories


Function funnel_measure allows users to compare two models based on their explainers. It partitions dataset on which models were built and creates categories according to quantiles of columns in parition data. nbins parameter determines number of quantiles. For each category difference in provided measure is being calculated. Positive value of that difference means that Champion model has better performance in specified category, while negative value means that one of the Challengers was better. Function allows to compare multiple Challengers at once.


  measure_function = NULL,
  nbins = 5,
  partition_data = champion$data,
  cutoff = 0.01,
  cutoff_name = "Other",
  factor_conversion_threshold = 7,
  show_info = TRUE,
  categories = NULL



- explainer of champion model.


- explainer of challenger model or list of explainers.


- measure function that calculates performance of model based on true observation and prediction. Order of parameters is important and should be (y, y_hat). The measure calculated by the function should have the property that lower score value indicates better model. If NULL, RMSE will be used for regression, one minus auc for classification and crossentropy for multiclass classification.


- Number of quantiles (partition points) for numeric columns. In case when more than one quantile have the same value, there will be less partition points.


- Data by which test dataset will be partitioned for computation. Can be either data.frame or character vector. When second is passed, it has to indicate names of columns that will be extracted from test data. By default full test data. If data.frame, number of rows has to be equal to number of rows in test data.


- Threshold for categorical data. Entries less frequent than specified value will be merged into one category.


- Name for new category that arised after merging entries less frequent than cutoff


- Numeric columns with lower number of unique values than value of this parameter will be treated as factors


- Logical value indicating if progress bar should be shown.


- a named list of variable names that will be plotted in a different colour. By default it is partitioned on Explanatory, External and Target.


An object of the class funnel_measure

It is a named list containing following fields:

  • data data.frame that consists of columns:

    • Variable Variable according to which partitions were made

    • Measure Difference in measures. Positive value indicates that champion was better, while negative that challenger.

    • Label String that defines subset of Variable values (partition rule).

    • Challenger Label of challenger explainer that was used in Measure

    • Category a category of the variable passed to function

  • models_info data.frame containing information about models used in analysis


task <- mlr::makeRegrTask(
  id = "R",
  data = apartments,
  target = "m2.price"
learner_lm <- mlr::makeLearner(
model_lm <- mlr::train(learner_lm, task)
explainer_lm <- explain_mlr(model_lm, apartmentsTest, apartmentsTest$m2.price, label = "LM")

learner_rf <- mlr::makeLearner(
model_rf <- mlr::train(learner_rf, task)
explainer_rf <- explain_mlr(model_rf, apartmentsTest, apartmentsTest$m2.price, label = "RF")

learner_gbm <- mlr::makeLearner(
model_gbm <- mlr::train(learner_gbm, task)
explainer_gbm <- explain_mlr(model_gbm, apartmentsTest, apartmentsTest$m2.price, label = "GBM")

plot_data <- funnel_measure(explainer_lm, list(explainer_rf, explainer_gbm),
                            nbins = 5, measure_function = DALEX::loss_root_mean_square)

DALEXtra documentation built on June 14, 2022, 9:07 a.m.