regression.check_sur_n_comb: Check the 'regression.surrogate_n_comb' parameter

In NorskRegnesentral/shapr: Prediction Explanation with Dependence-Aware Shapley Values

Check the regression.surrogate_n_comb parameter

Description

Check that regression.surrogate_n_comb is either NULL or a valid integer.

Usage

regression.check_sur_n_comb(regression.surrogate_n_comb, used_n_combinations)

Arguments

regression.surrogate_n_comb

Integer (default is internal$parameters$used_n_combinations) specifying the number of unique combinations/coalitions to apply to each training observation. Maximum allowed value is "internal$parameters$used_n_combinations - 2". By default, we use all coalitions, but this can take a lot of memory in larger dimensions. Note that by "all", we mean all coalitions chosen by shapr to be used. This will be all 2^{n_{\text{features}}} coalitions (minus empty and grand coalition) if shapr is in the exact mode. If the user sets a lower value than internal$parameters$used_n_combinations, then we sample this amount of unique coalitions separately for each training observations. That is, on average, all coalitions should be equally trained.

used_n_combinations

Integer. The number of used combinations (including the empty and grand coalitions).

Author(s)

Lars Henry Berge Olsen

NorskRegnesentral/shapr documentation built on April 19, 2024, 1:19 p.m.