Package: iBreakDown 2.1.2

Przemyslaw Biecek

iBreakDown: Model Agnostic Instance Level Variable Attributions

Model agnostic tool for decomposition of predictions from black boxes. Supports additive attributions and attributions with interactions. The Break Down Table shows contributions of every variable to a final prediction. The Break Down Plot presents variable contributions in a concise graphical way. This package works for classification and regression models. It is an extension of the 'breakDown' package (Staniak and Biecek 2018) <doi:10.32614/RJ-2018-072>, with new and faster strategies for orderings. It supports interactions in explanations and has interactive visuals (implemented with 'D3.js' library). The methodology behind is described in the 'iBreakDown' article (Gosiewska and Biecek 2019) <arxiv:1903.11420> This package is a part of the 'DrWhy.AI' universe (Biecek 2018) <arxiv:1806.08915>.

Authors:Przemyslaw Biecek [aut, cre], Alicja Gosiewska [aut], Hubert Baniecki [aut], Adam Izdebski [aut], Dariusz Komosinski [ctb]

iBreakDown_2.1.2.tar.gz
iBreakDown_2.1.2.zip(r-4.7)iBreakDown_2.1.2.zip(r-4.6)iBreakDown_2.1.2.zip(r-4.5)
iBreakDown_2.1.2.tgz(r-4.6-any)iBreakDown_2.1.2.tgz(r-4.5-any)
iBreakDown_2.1.2.tar.gz(r-4.7-any)iBreakDown_2.1.2.tar.gz(r-4.6-any)
iBreakDown_2.1.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
iBreakDown/json (API)

# Install 'iBreakDown' in R:
install.packages('iBreakDown', repos = c('https://modeloriented.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/modeloriented/ibreakdown/issues

Pkgdown/docs site:https://modeloriented.github.io

On CRAN:

Conda:

breakdownimlinterpretabilityshapleyxai

10.20 score 84 stars 20 packages 71 scripts 5.5k downloads 1 mentions 7 exports 17 dependencies

Last updated from:d4f6289f9d. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK256
source / vignettesOK228
linux-release-x86_64OK241
macos-release-arm64OK266
macos-oldrel-arm64OK229
windows-develOK195
windows-releaseOK169
windows-oldrelOK198
wasm-releaseOK116

Exports:break_downbreak_down_uncertaintydescribelocal_attributionslocal_interactionsplotD3shap

Dependencies:clicpp11farverggplot2gluegtableisobandlabelinglifecycleR6RColorBrewerrlangS7scalesvctrsviridisLitewithr

Explanations in natural language
Introduction | iBreakDown Package | Describing an explanation | Parameters of describe() function | Adjusting nonsignificance treshold | Adjusting label of the explanation | Short descriptions | Displaying values | Displaying numbers | Distribution details | SHAP | Combining all the parameters

Last update: 2022-02-06
Started: 2019-07-30

General introduction: iBreakDown plots for Sinking of the RMS Titanic
Data for Titanic survival | Model for Titanic survival | Explainer for Titanic survival | Break Down plot with D3 | Calculate variable attributions | Plot attributions with ggplot2 | Plot attributions with D3 | Calculate uncertainty for variable attributions | Show only top features | Force OX axis to be from 0 to 1

Last update: 2020-07-19
Started: 2019-03-15

Readme and manuals

Help Manual

Help pageTopics
Model Agnostic Sequential Variable Attributionsbreak_down break_down.default break_down.explainer
Explanation Level Uncertainty of Sequential Variable Attributionbreak_down_uncertainty break_down_uncertainty.default break_down_uncertainty.explainer shap
Generates Textual Explanations for Predictive Modelsdescribe describe.break_down describe.break_down_uncertainty
Model Agnostic Sequential Variable attributionslocal_attributions local_attributions.default local_attributions.explainer
Model Agnostic Sequential Variable Attributions with Interactionslocal_interactions local_interactions.default local_interactions.explainer
Plot Generic for Break Down Objectsplot.break_down
Plot Generic for Break Down Uncertainty Objectsplot.break_down_uncertainty
Plot Break Down Objects in D3 with r2d3 package.plotD3 plotD3.break_down
Plot Shap (Break Down Uncertainty) Objects in D3 with r2d3 package.plotD3.shap
Print Generic for Break Down Objectsprint.break_down
Print Generic for Break Down Objectsprint.break_down_description
Print Generic for Break Down Uncertainty Objectsprint.break_down_uncertainty