Skip to content
📍 📈 📝 Interactive Studio with Explanations for ML Predictive Models
R JavaScript CSS
Branch: master
Clone or download
Latest commit f11c15f Sep 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R spell check Aug 30, 2019
docs updated website Sep 11, 2019
images update cheatsheet Aug 30, 2019
inst/d3js dime v0.1.5 Aug 21, 2019
man added logo Sep 11, 2019
pkgdown/favicon updated website Sep 11, 2019
tests fix tests for CRAN Sep 4, 2019
vignettes spell check Aug 30, 2019
.Rbuildignore update DESC Sep 1, 2019
.gitattributes short_description Aug 5, 2019
.gitignore update DESC Sep 1, 2019
.travis.yml update documentation Aug 27, 2019
DESCRIPTION fix tests for CRAN Sep 4, 2019
NAMESPACE updated README and DESCRIPTION for #20 Aug 24, 2019
NEWS.md fix tests for CRAN Sep 4, 2019
README.md added logo Sep 11, 2019
_pkgdown.yml build site Jul 16, 2019
codecov.yml potential travis fix Jul 28, 2019
modelStudio.Rproj clean dime Aug 30, 2019

README.md

Interactive Studio with Explanations for ML Predictive Models

Project Status: Active – The project has reached a stable, usable state and is being actively developed. CRAN_Status_Badge Build Status Coverage Status

Overview

The modelStudio package automates explanation of machine learning predictive models. This package generates advanced interactive and animated model explanations in the form of serverless HTML site.

It combines R with D3.js to produce plots and descriptions for local and global explanations. The whole is greater than the sum of its parts, so it also supports EDA (Exploratory Data Analysis) on top of that. modelStudio is a fast and condensed way to get all the answers without much effort. Break down your model and look into its ingredients with only a few lines of code.

See a demoRead the vignette: modelStudio - perks and features

The modelStudio package is a part of the DrWhy.AI universe.

Installation

# Install from CRAN: 
install.packages("modelStudio")

# Install the development version from GitHub:
devtools::install_github("ModelOriented/modelStudio")

Demo

This package bases on DALEX explainers created with DALEX::explain().

library("modelStudio")
library("DALEX")

Create a model:

titanic_small <- titanic_imputed[, c(1,2,3,6,7,9)]
titanic_small$survived <- titanic_small$survived == "yes"

model_titanic_glm <- glm(survived ~ gender + age + fare + class + sibsp,
                         data = titanic_small, family = "binomial")

Wrap it into an explainer:

explain_titanic_glm <- explain(model_titanic_glm,
                               data = titanic_small[,-6],
                               y = titanic_small[,6],
                               label = "glm")

Pick some data points:

new_observations <- titanic_small[1:4,]
rownames(new_observations) <- c("Lucas", "James", "Thomas", "Nancy")

Make a studio for the model:

modelStudio(explain_titanic_glm, new_observations)

More examples here.


Save

You can save modelStudio using controls on the top of the RStudio Viewer or with r2d3::save_d3_html() and r2d3::save_d3_png().


Cheat Sheet

CheatSheet


Acknowledgments

Work on this package was financially supported by the 'NCN Opus grant 2016/21/B/ST6/02176'.

You can’t perform that action at this time.