modelDown.Rmd

---
title: "The modelDown R package"
date: "`r format(Sys.time(), '%d-%m-%Y')`"
output:
  html_document:
    toc: true
    toc_float: true
---

  
This report aims to present the capabilities of the package `modelDown`.

The document is a part of the paper "Landscape of R packages for eXplainable Machine Learning", S. Maksymiuk, A. Gosiewska, and P. Biecek. 
(https://arxiv.org/abs/2009.13248). It contains a real life use-case with a hand of [titanic_imputed](https://modeloriented.github.io/DALEX/reference/titanic.html) data set described in Section *Example gallery for XAI packages* of the article.

We did our best to show the entire range of the implemented explanations. Please note that the examples may be incomplete. If you think something is missing, feel free to make a pull request at the GitHub repository [MI2DataLab/XAI-tools](https://github.com/MI2DataLab/XAI-tools).

The list of use-cases for all packages included in the article is [here](http://xai-tools.drwhy.ai/). 

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, message = FALSE, warning = FALSE)
```

Load [`titanic_imputed`](https://modeloriented.github.io/DALEX/reference/titanic.html) data set.

```{r}
data(titanic_imputed, package = "DALEX")

head(titanic_imputed)
```


```{r}
library(DALEX)
library(modelDown)

set.seed(123)
```

Fit a random forest and logistic regression to the titanic imputed data.

```{r}
rf_model <- ranger::ranger(survived~., data = titanic_imputed, classification = TRUE, probability = TRUE)
glm_model <- glm(survived~., data = titanic_imputed)
```


# Report

```{r}
explainer_rf <- DALEX::explain(rf_model,
                        data = titanic_imputed[, -8], y = titanic_imputed[, 8], verbose = FALSE)
modelDown(explainer_rf, output_folder = "modelDown")
```

modelDown for models comparison.


```{r}
explainer_rf <- DALEX::explain(rf_model,
                        data = titanic_imputed[, -8], y = titanic_imputed[, 8], verbose = FALSE)
explainer_glm <- DALEX::explain(glm_model,
                        data = titanic_imputed[, -8], y = titanic_imputed[, 8], verbose = FALSE)
modelDown(explainer_rf, explainer_glm, output_folder = "modelDown_2_models")

```


The generated modelDown reports are is avialible at: [https://mi2datalab.github.io/IML-tools/modelDown/index.html](https://mi2datalab.github.io/IML-tools/modelDown/index.html) and [https://mi2datalab.github.io/IML-tools/modelDown_2_model/index.html](https://mi2datalab.github.io/IML-tools/modelDown_2_model/index.html)

modelDown provides various explanation methods listed below as headers.



# Model parts

## Variable importance 

# Model profile

## PDP

## ALE

# Model diagnostics

## Cumulative distribution of residuals

## Boxplot of residuals



# Session info

```{r}
sessionInfo()
```