From 9da22371233c84cd03076db8b5af07797a90db3b Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Tue, 26 Dec 2023 08:09:18 +0100 Subject: [PATCH] Update docu --- man/kernelshap.Rd | 22 ---------------------- man/permshap.Rd | 16 ---------------- 2 files changed, 38 deletions(-) diff --git a/man/kernelshap.Rd b/man/kernelshap.Rd index adbd6bc..d2b0a27 100644 --- a/man/kernelshap.Rd +++ b/man/kernelshap.Rd @@ -4,7 +4,6 @@ \alias{kernelshap} \alias{kernelshap.default} \alias{kernelshap.ranger} -\alias{kernelshap.Learner} \title{Kernel SHAP} \usage{ kernelshap(object, ...) @@ -46,25 +45,6 @@ kernelshap(object, ...) verbose = TRUE, ... ) - -\method{kernelshap}{Learner}( - object, - X, - bg_X, - pred_fun = NULL, - feature_names = colnames(X), - bg_w = NULL, - exact = length(feature_names) <= 8L, - hybrid_degree = 1L + length(feature_names) \%in\% 4:16, - paired_sampling = TRUE, - m = 2L * length(feature_names) * (1L + 3L * (hybrid_degree == 0L)), - tol = 0.005, - max_iter = 100L, - parallel = FALSE, - parallel_args = NULL, - verbose = TRUE, - ... -) } \arguments{ \item{object}{Fitted model object.} @@ -238,8 +218,6 @@ For similar reasons, degree 2 hybrids should not use \eqn{p} much larger than 40 \item \code{kernelshap(ranger)}: Kernel SHAP method for "ranger" models, see Readme for an example. -\item \code{kernelshap(Learner)}: Kernel SHAP method for "mlr3" models, see Readme for an example. - }} \examples{ # MODEL ONE: Linear regression diff --git a/man/permshap.Rd b/man/permshap.Rd index f3648c8..567a321 100644 --- a/man/permshap.Rd +++ b/man/permshap.Rd @@ -4,7 +4,6 @@ \alias{permshap} \alias{permshap.default} \alias{permshap.ranger} -\alias{permshap.Learner} \title{Permutation SHAP} \usage{ permshap(object, ...) @@ -34,19 +33,6 @@ permshap(object, ...) verbose = TRUE, ... ) - -\method{permshap}{Learner}( - object, - X, - bg_X, - pred_fun = NULL, - feature_names = colnames(X), - bg_w = NULL, - parallel = FALSE, - parallel_args = NULL, - verbose = TRUE, - ... -) } \arguments{ \item{object}{Fitted model object.} @@ -111,8 +97,6 @@ see Strumbelj and Kononenko. The function works for up to 14 features. \item \code{permshap(ranger)}: Permutation SHAP method for "ranger" models, see Readme for an example. -\item \code{permshap(Learner)}: Permutation SHAP method for "mlr3" models, see Readme for an example. - }} \examples{ # MODEL ONE: Linear regression