Data

Tools

Indexes

Applications

Experiments

Open Source Science

modelDown

modelDown: automated website generator with interpretable documentation for predictive machine learning models - Published in JOSS (2019)

https://github.com/ModelOriented/modelDown

Science Score: 33.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    2 of 11 committers (18.2%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (21.6%) to scientific vocabulary

Keywords from Contributors

interpretability interactive
Last synced: 10 months ago · JSON representation

Repository

modelDown generates a website with HTML summaries for predictive models

Basic Info
Statistics
  • Stars: 120
  • Watchers: 8
  • Forks: 14
  • Open Issues: 7
  • Releases: 0
Created about 8 years ago · Last pushed about 4 years ago

https://github.com/ModelOriented/modelDown/blob/master/ 

# modelDown

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/modelDown)](https://cran.r-project.org/package=modelDown)
[![DOI](http://joss.theoj.org/papers/10.21105/joss.01444/status.svg)](https://doi.org/10.21105/joss.01444)
[![R build status](https://github.com/ModelOriented/modelDown/workflows/R-CMD-check/badge.svg)](https://github.com/ModelOriented/modelDown/actions)
[![Codecov test coverage](https://codecov.io/gh/ModelOriented/modelDown/branch/master/graph/badge.svg)](https://codecov.io/gh/ModelOriented/modelDown?branch=master)



`modelDown` generates a website with HTML summaries for predictive models.
Is uses [DALEX](https://github.com/ModelOriented/DALEX) explainers to compute and plot summaries of how given models behave.  We can see how well models behave (Model Performance, Auditor), how much each variable contributes to predictions (Variable Response) and which variables are the most important for a given model (Variable Importance). We can also compare Concept Drift for pairs of models (Drifter). Additionally, data available on the website can be easily recreated in current R session (using the `archivist` package).

`pkgdown` documentation: https://ModelOriented.github.io/modelDown/

An example website for regression models: https://mi2datalab.github.io/modelDown_example/

## Getting started

Do you want to start right now ? Check out our [getting started](https://ModelOriented.github.io/modelDown/getting-started) guide.

Or just simply install it like below:

Stable version: `devtools::install_github("ModelOriented/modelDown")`

And if you want to get the latest changes:

Development version: `devtools::install_github("ModelOriented/modelDown@dev")`

## Contributing

If you spot a bug or you have a feature proposal feel free to create an issue in this repository. We are also open to contributions in a form of pull requests. Just follow steps below:

1. Open a new issue (specify an issue type as a label - a bug or an enhancement).

Additionally you can:

2. Start a new branch from the `dev` branch. It should be named `bugfix/XX-short-description` or `feature/XX-short-description` where `XX` is an issue number.
3. Create commits with descriptive messages starting with `#XX`.
4. Create a pull request of the created branch to the `dev` branch.
5. Wait for a review from one of the `modelDown` maintainers.

Help us build better software!

## Index page




Index page presents basic information about data provided in explainers. You can also see types of all explainers given as parameters. Additionally, summary statistics are available for numerical variables. For categorical variables, tables with frequencies of factor levels are presented.

## Auditor




Module shows plots generated by `auditor` package. 

## Drifter

Results of `drifter` package are displayed in this tab. In order to see the comparison charts, you have to provide pair of explainers as parameters (for example: `list(explainer_glm_old, explainer_glm_new)`).

## Model Performance




Module shows result of function `model_performance`. 

## Variable Importance




Output of function `variable_importance` is presented in form of a plot as well as a table.

## Variable Response




For each variable, plot is created by using function `variable_response`. Plots can be easily navigated using links on the left side. One can provide names of variables to include in the module with argument `vr.vars` (if argument is not used, plots for all variables of first explainer are generated).

## Loading data in R

In each tab you can find links with R commands. If you execute them, you can load relevant objects into current R session (`archivist` package is necessary). By default data is stored and loaded from local repository. If you wish to store data on GitHub repository, please provide argument `remote_repository_path`. After generating modelDown website, `repository` folder must be placed under this path.

## Acknowledgments 

Work on this package is financially supported by Warsaw University of Technology, Faculty of Mathematics and Information Science.

Owner

  • Name: Model Oriented
  • Login: ModelOriented
  • Kind: organization
  • Location: MI2DataLab @ Warsaw University of Technology

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 188
  • Total Committers: 11
  • Avg Commits per committer: 17.091
  • Development Distribution Score (DDS): 0.729
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
kromash k****o@g****m 51
Mateusz m****k@g****m 40
Magda Tatarynowicz m****z@g****m 39
Przemysław Biecek p****k@g****m 24
kromash k****o@s****m 11
Magda Tatarynowicz t****m@s****l 7
kozaka93 a****k@g****m 5
Kamil Romaszko 3****h 5
hbaniecki h****i@g****m 3
Daniel S. Katz d****z@i****g 2
Darío Hereñú m****a@g****m 1
Committer Domains (Top 20 + Academic)
ieee.org: 1 student.mini.pw.edu.pl: 1 sotrender.com: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 51
  • Total pull requests: 37
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 days
  • Total issue authors: 12
  • Total pull request authors: 8
  • Average comments per issue: 1.27
  • Average comments per pull request: 0.73
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • pbiecek (21)
  • magda-tatarynowicz (19)
  • mstaniak (2)
  • agosiewska (1)
  • monikachudek (1)
  • cregouby (1)
  • AdrianAntico (1)
  • wulixin (1)
  • michkam89 (1)
  • leungi (1)
  • kromash (1)
  • hbaniecki (1)
Pull Request Authors
  • magda-tatarynowicz (11)
  • Matiszak (10)
  • kromash (10)
  • danielskatz (2)
  • michkam89 (1)
  • kant (1)
  • pbiecek (1)
  • DataStrategist (1)
Top Labels
Issue Labels
documentation (6) style (4) enhancement (3) archivist (3) bug (2) auditor (2) drifter (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 207 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: modelDown

Make Static HTML Website for Predictive Models

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 207 Last month
Rankings
Stargazers count: 3.4%
Forks count: 4.6%
Average: 23.2%
Dependent repos count: 23.9%
Dependent packages count: 28.7%
Downloads: 55.2%
Maintainers (1)
kamil.romaszko@gmail.com
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.4.0 depends
  • DALEX >= 1.0 imports
  • DT >= 0.4 imports
  • archivist >= 2.1.0 imports
  • auditor >= 0.3.0 imports
  • breakDown >= 0.1.6 imports
  • devtools >= 2.0.1 imports
  • drifter >= 0.2.1 imports
  • ggplot2 >= 3.1.0 imports
  • kableExtra >= 0.9.0 imports
  • psych >= 1.8.4 imports
  • svglite >= 1.2.1 imports
  • whisker >= 0.3 imports
  • covr * suggests
  • ranger * suggests
  • testthat * suggests
  • useful * suggests