https://github.com/ModelOriented/ingredients

Effects and Importances of Model Ingredients
https://github.com/ModelOriented/ingredients

Last synced: 2 months ago
JSON representation

Effects and Importances of Model Ingredients

• Host: GitHub
• URL: https://github.com/ModelOriented/ingredients
• Owner: ModelOriented
• License: gpl-3.0
• Created: 2019-01-04T23:25:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-15T21:16:09.000Z (about 2 years ago)
• Last Synced: 2024-05-01T19:36:29.752Z (about 1 year ago)
• Language: R
• Homepage: https://modeloriented.github.io/ingredients/
• Size: 218 MB
• Stars: 37
• Watchers: 8
• Forks: 18
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Model Ingredients 

[![R build status](https://github.com/ModelOriented/ingredients/workflows/R-CMD-check/badge.svg)](https://github.com/ModelOriented/ingredients/actions?query=workflow%3AR-CMD-check)

[![Coverage Status](https://img.shields.io/codecov/c/github/ModelOriented/ingredients/master.svg)](https://codecov.io/github/ModelOriented/ingredients?branch=master)

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ingredients)](https://cran.r-project.org/package=ingredients)

[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/ingredients?color=orange)](http://cranlogs.r-pkg.org/badges/grand-total/ingredients)

## Overview

The `ingredients` package is a collection of tools for assessment of feature importance and feature effects. It is imported and used to compute model explanations in multiple packages e.g. [`DALEX`](https://github.com/ModelOriented/DALEX), [`modelStudio`](https://github.com/ModelOriented/modelStudio), [`arenar`](https://github.com/ModelOriented/ArenaR).

The philosophy behind `ingredients` explanations is described in the [Explanatory Model Analysis: Explore, Explain, and Examine Predictive Models](https://pbiecek.github.io/ema/) e-book. The `ingredients` package is a part of [DrWhy.AI](http://DrWhy.AI) universe. 

Key functions: 

* `feature_importance()` for assessment of global level feature importance, 

* `ceteris_paribus()` for calculation of the Ceteris Paribus / What-If Profiles (read more at https://ema.drwhy.ai/ceterisParibus.html),

* `partial_dependence()` for Partial Dependence Plots,

* `conditional_dependence()` for Conditional Dependence Plots also called M Plots,

* `accumulated_dependence()` for Accumulated Local Effects Plots,

* `aggregate_profiles()` and `cluster_profiles()` for aggregation of Ceteris Paribus Profiles,

* `calculate_oscillations()` for calculation of the Ceteris Paribus Oscillations (read more at https://ema.drwhy.ai/ceterisParibusOscillations.html),

* `ceteris_paribus_2d()` for Ceteris Paribus 2D Profiles,

* generic `print()` and `plot()` for better usability of selected explanations,

* generic `plotD3()` for interactive, D3 based explanations,

* generic `describe()` for explanations in natural language.

## Installation

```r

# the easiest way to get ingredients is to install it from CRAN:

install.packages("ingredients")

# Or the the development version from GitHub:

# install.packages("devtools")

devtools::install_github("ModelOriented/ingredients")

```

## Interactive plots with D3

`feature_importance()`, `ceteris_paribus()` and `aggregated_profiles()` also work with **D3**:

[see an example](https://modeloriented.github.io/ingredients/ceterisParibusDemo.html).

![plotD3](man/figures/demo.gif)

## Acknowledgments

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