Merge pull request #177 from ModelOriented/fix-seed

Random seed should be set before background selection

Author: mayer79

NEWS.md

@@ -4,6 +4,12 @@
 
 - More pre-calculations for exact part of the methods ([#175](https://github.com/ModelOriented/kernelshap/pull/175)).
 
+### Bug fixes
+
+- Setting the random seed in `kernelshap()` or `permshap()` would not respect the random selection of the background dataset.
+ ([#177](https://github.com/ModelOriented/kernelshap/pull/177)).
+
+
 # kernelshap 0.9.0
 
 ### Bug fix

R/kernelshap.R

@@ -205,16 +205,17 @@ kernelshap.default <- function(
     p == 1L || exact || hybrid_degree %in% 0:(p / 2),
     "m must be even" = trunc(m / 2) == m / 2
   )
+
+  if (!is.null(seed)) {
+    set.seed(seed)
+  }
+
   prep_bg <- prepare_bg(X = X, bg_X = bg_X, bg_n = bg_n, bg_w = bg_w, verbose = verbose)
   bg_X <- prep_bg$bg_X
   bg_w <- prep_bg$bg_w
   bg_n <- nrow(bg_X)
   n <- nrow(X)
 
-  if (!is.null(seed)) {
-    set.seed(seed)
-  }
-
   # Calculate v1 and v0
   bg_preds <- align_pred(pred_fun(object, bg_X, ...))
   v0 <- wcolMeans(bg_preds, bg_w) # Average pred of bg data: 1 x K

R/permshap.R

@@ -124,17 +124,17 @@ permshap.default <- function(
     message(txt)
   }
 
+  if (!is.null(seed)) {
+    set.seed(seed)
+  }
+
   basic_checks(X = X, feature_names = feature_names, pred_fun = pred_fun)
   prep_bg <- prepare_bg(X = X, bg_X = bg_X, bg_n = bg_n, bg_w = bg_w, verbose = verbose)
   bg_X <- prep_bg$bg_X
   bg_w <- prep_bg$bg_w
   bg_n <- nrow(bg_X)
   n <- nrow(X)
 
-  if (!is.null(seed)) {
-    set.seed(seed)
-  }
-
   # Baseline and predictions on explanation data
   bg_preds <- align_pred(pred_fun(object, bg_X, ...))
   v0 <- wcolMeans(bg_preds, w = bg_w) # Average pred of bg data: 1 x K