Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Mateusz Staniak committed Jun 4, 2018
1 parent 5a864fc commit 7450874
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
1 change: 0 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,5 @@ Imports: mlr,
data.table,
forestmodel,
lubridate,
ggplot2,
shiny,
MASS
3 changes: 2 additions & 1 deletion R/explore.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
#' @param size Number of observations is a simulated dataset.
#' @param method If "live", new observations will be created by changing one value
#' per observation. If "lime", new observation will be created by permuting all
#' columns of data.
#' columns of data. If "normal", numerical features will be sampled from multivariate
#' normal distribution specified by ... arguments mu and Sigma.
#' @param fixed_variables names or numeric indexes of columns which will not be changed
#' while sampling.
#' @param ... Mean and covariance matrix for normal sampling method.
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# live: Local Interpretable (Model-agnostic) Visual Explanations

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/live)](https://cran.r-project.org/package=live)
[![Downloads](http://cranlogs.r-pkg.org/badges/live)](http://cran.rstudio.com/package=live)
[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/live?color=orange)](http://cranlogs.r-pkg.org/badges/grand-total/live)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/live)](https://CRAN.R-project.org/package=live)
[![Downloads](http://cranlogs.r-pkg.org/badges/live)](https://CRAN.R-project.org/package=live)
[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/live?color=orange)](https://cranlogs.r-pkg.org/badges/grand-total/live)
[![Build Status](https://travis-ci.org/MI2DataLab/live.svg?branch=master)](https://travis-ci.org/MI2DataLab/live)
[![Coverage Status](https://img.shields.io/codecov/c/github/MI2DataLab/live/master.svg)](https://codecov.io/github/MI2DataLab/live?branch=master)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=The%20live%20package%20will%20help%20you%20explain%20your%20model%27s%20predictions%20by%20fitting%20a%20simpler%20model%20locally%20and%20visualizing%20it.%20Find%20out%20more%20at%0Ahttps://github.com/MI2DataLab/live%0A&hashtags=rstats,interpretableML,machinelearning,xAI)
Expand All @@ -26,8 +26,6 @@ devtools::install_github("MI2DataLab/live")

Features coming up next:

* more methods of sampling,

* better support for comparing explanations for different models / different instances,

* improved Shiny application (see `live_shiny` function in development version).
Expand Down
3 changes: 2 additions & 1 deletion man/sample_locally2.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7450874

Please sign in to comment.