Skip to content

Commit bfa9243

Browse files
committed
update readme
1 parent 2d15ce6 commit bfa9243

File tree

2 files changed

+47
-46
lines changed

2 files changed

+47
-46
lines changed

DESCRIPTION

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
1-
Package: modelStudio
2-
Title: Interactive Studio for Explanatory Model Analysis
3-
Version: 3.0.0.9000
4-
Authors@R:
5-
c(person("Hubert", "Baniecki", role = c("aut", "cre"),
6-
email = "[email protected]",
7-
comment = c(ORCID = "0000-0001-6661-5364")),
8-
person("Przemyslaw", "Biecek", role = c("aut"),
9-
comment = c(ORCID = "0000-0001-8423-1823")),
10-
person("Piotr", "Piatyszek", role = c("ctb")))
11-
Description: Automate the explanatory analysis of machine learning predictive models.
12-
Generate advanced interactive model explanations in the form of a serverless HTML
13-
site with only one line of code. This tool is model-agnostic, therefore compatible
14-
with most of the black-box predictive models and frameworks. The main function
15-
computes various (instance and model-level) explanations and produces
16-
a customisable dashboard, which consists of multiple panels for plots with their
17-
short descriptions. Easily save the dashboard and share it with others. Tools
18-
for Explanatory Model Analysis unite with tools for Exploratory Data Analysis
19-
to give a broad overview of the model behavior.
20-
Depends: R (>= 3.6)
21-
License: GPL-3
22-
Encoding: UTF-8
23-
RoxygenNote: 7.1.1
24-
Imports:
25-
DALEX (>= 2.2.1),
26-
ingredients (>= 2.2.0),
27-
iBreakDown (>= 2.0.1),
28-
r2d3,
29-
jsonlite,
30-
progress,
31-
digest
32-
Suggests:
33-
parallelMap,
34-
ranger,
35-
xgboost,
36-
knitr,
37-
rmarkdown,
38-
testthat,
39-
spelling
40-
VignetteBuilder: knitr
41-
URL: https://modelstudio.drwhy.ai, https://github.com/ModelOriented/modelStudio
42-
BugReports: https://github.com/ModelOriented/modelStudio/issues
43-
Language: en-US
44-
LazyData: true
1+
Package: modelStudio
2+
Title: Interactive Studio for Explanatory Model Analysis
3+
Version: 3.0.0.9000
4+
Authors@R:
5+
c(person("Hubert", "Baniecki", role = c("aut", "cre"),
6+
email = "[email protected]",
7+
comment = c(ORCID = "0000-0001-6661-5364")),
8+
person("Przemyslaw", "Biecek", role = c("aut"),
9+
comment = c(ORCID = "0000-0001-8423-1823")),
10+
person("Piotr", "Piatyszek", role = c("ctb")))
11+
Description: Automate the explanatory analysis of machine learning predictive
12+
models. Generate advanced interactive model explanations in the form of
13+
a serverless HTML site with only one line of code. This tool is
14+
model-agnostic, therefore compatible with most of the black-box predictive
15+
models and frameworks. The main function computes various (instance and
16+
model-level) explanations and produces a customisable dashboard, which
17+
consists of multiple panels for plots with their short descriptions. It is
18+
possible to easily save the dashboard and share it with others. Tools for
19+
Explanatory Model Analysis unite with tools for Exploratory Data Analysis
20+
to give a broad overview of the model behavior.
21+
Depends: R (>= 3.6)
22+
License: GPL-3
23+
Encoding: UTF-8
24+
RoxygenNote: 7.1.2
25+
Imports:
26+
DALEX (>= 2.2.1),
27+
ingredients (>= 2.2.0),
28+
iBreakDown (>= 2.0.1),
29+
r2d3,
30+
jsonlite,
31+
progress,
32+
digest
33+
Suggests:
34+
parallelMap,
35+
ranger,
36+
xgboost,
37+
knitr,
38+
rmarkdown,
39+
testthat,
40+
spelling
41+
VignetteBuilder: knitr
42+
URL: https://modelstudio.drwhy.ai, https://github.com/ModelOriented/modelStudio
43+
BugReports: https://github.com/ModelOriented/modelStudio/issues
44+
Language: en-US
45+
LazyData: true

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Interactive Studio for Explanatory Model Analysis <img src="man/figures/logo.gif" align="right" width="150"/>
1+
# Interactive Studio for Explanatory Model Analysis <img src="man/figures/logo.gif" align="right" width="143px"/>
22

33
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/modelStudio)](https://cran.r-project.org/package=modelStudio)
44
[![R build status](https://github.com/ModelOriented/modelStudio/workflows/R-CMD-check/badge.svg)](https://github.com/ModelOriented/modelStudio/actions?query=workflow%3AR-CMD-check)
@@ -10,7 +10,7 @@
1010

1111
The `modelStudio` package **automates the explanatory analysis of machine learning predictive models**. It generates advanced interactive model explanations in the form of a **serverless HTML site** with only one line of code. This tool is model-agnostic, therefore compatible with most of the black-box predictive models and frameworks (e.g.&nbsp;`mlr/mlr3`, `xgboost`, `caret`, `h2o`, `parsnip`, `tidymodels`, `scikit-learn`, `lightgbm`, `keras/tensorflow`).
1212

13-
The main `modelStudio()` function computes various (instance and model-level) explanations and produces a&nbsp;**customisable dashboard**, which consists of multiple panels for plots with their short descriptions. Easily&nbsp;**save**&nbsp; the dashboard and&nbsp;**share** it with others. Tools for [Explanatory Model Analysis](https://ema.drwhy.ai/) unite with tools for Exploratory Data Analysis to give a broad overview of the model behavior.
13+
The main `modelStudio()` function computes various (instance and model-level) explanations and produces a&nbsp;**customisable dashboard**, which consists of multiple panels for plots with their short descriptions. It is possible to easily **save** the dashboard and&nbsp;**share** it with others. Tools for [Explanatory Model Analysis](https://ema.drwhy.ai/) unite with tools for Exploratory Data Analysis to give a broad overview of the model behavior.
1414

1515
<p align="center"><b>
1616
<a href="https://rai-covid.drwhy.ai">explain COVID-19<a> &emsp;

0 commit comments

Comments
 (0)