Improve README - Githubissues

slds-lmu / iml-shiny-summary

Shiny Dashboard showing an interpretation summary for any model

MIT License

3 stars 2 forks source link

Improve README #1

Open christophM opened 4 years ago

christophM commented 4 years ago

Please add following to the readme:

A short description of what the shiny app does
A description how to run the shiny app

QWERTZ11 commented 4 years ago

done

christophM commented 4 years ago

Please also add the following two things:

one line of R code to the README how to run
an example of R code how to produce an .RDS model object with iml . for example you can use

library(iml) library(mlr) Loading required package: ParamHelpers lrn = makeLearner("regr.rpart") tsk = bh.task dat = getTaskData(bh.task) mod = train(lrn, tsk) pred = Predictor$new(mod, dat) saveRDS(pred, file = "mod.RDS")

christophM commented 4 years ago

Please add a screenshot of the app.

Also a sentence in the beginning: The app shows the partial dependence plots and permutation feature important for any machine learning model. It can also explain individual predictions with Shapley Values.