From c7fbd77d63b1fb2f380a678bac43af67199655a4 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sat, 30 Nov 2024 15:11:07 +0100 Subject: [PATCH] Adapt docu on h2o --- DESCRIPTION | 2 +- NEWS.md | 10 ++++++++++ R/shapviz.R | 2 +- README.md | 2 +- man/shapviz.Rd | 2 +- packaging.R | 2 +- 6 files changed, 15 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b26978e..429c5b3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: shapviz Title: SHAP Visualizations -Version: 0.9.6 +Version: 0.9.7 Authors@R: c( person("Michael", "Mayer", , "mayermichael79@gmail.com", role = c("aut", "cre")), person("Adrian", "Stando", , "adrian.j.stando@gmail.com", role = "ctb") diff --git a/NEWS.md b/NEWS.md index 7561a4f..d8fe2ab 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,13 @@ +# shapviz 0.9.7 + +### Documentation + +- H2O random forests (regression and binary classification) are now supported as well (fast TreeSHAP) [#163](https://github.com/ModelOriented/shapviz/pull/163). + +### Compatibility + +- Adapt for upcoming {shapr} version, thanks @martinju for the fix [#162](https://github.com/ModelOriented/shapviz/pull/162). + # shapviz 0.9.6 ### Documentation diff --git a/R/shapviz.R b/R/shapviz.R index e2646ae..822c5a2 100644 --- a/R/shapviz.R +++ b/R/shapviz.R @@ -5,7 +5,7 @@ #' from a fitted model of type #' - XGBoost, #' - LightGBM, or -#' - H2O (tree-based regression or binary classification model). +#' - H2O (tree-based models). #' #' Furthermore, [shapviz()] can digest the results of #' - `fastshap::explain()`, diff --git a/README.md b/README.md index 9b340e0..3e9ac10 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ SHAP and feature values are stored in a "shapviz" object that is built from: -1. Models that know how to calculate SHAP values: XGBoost, LightGBM, H2O (boosted trees). +1. Models that know how to calculate SHAP values: XGBoost, LightGBM, H2O (tree-based models). 2. SHAP crunchers like {fastshap}, {kernelshap}, {treeshap}, {fastr}, and {DALEX}. 3. SHAP matrix and corresponding feature values. diff --git a/man/shapviz.Rd b/man/shapviz.Rd index 510cb76..5d9dd64 100644 --- a/man/shapviz.Rd +++ b/man/shapviz.Rd @@ -115,7 +115,7 @@ from a fitted model of type \itemize{ \item XGBoost, \item LightGBM, or -\item H2O (tree-based regression or binary classification model). +\item H2O (tree-based models). } Furthermore, \code{\link[=shapviz]{shapviz()}} can digest the results of diff --git a/packaging.R b/packaging.R index b9b7a1d..352d96c 100644 --- a/packaging.R +++ b/packaging.R @@ -15,7 +15,7 @@ library(usethis) use_description( fields = list( Title = "SHAP Visualizations", - Version = "0.9.6", + Version = "0.9.7", Description = "Visualizations for SHAP (SHapley Additive exPlanations), such as waterfall plots, force plots, various types of importance plots, dependence plots, and interaction plots.