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

In 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, n_coalitions)

Arguments

regression.surrogate_n_comb

Positive integer. Specifies the number of unique coalitions to apply to each training observation. The default is the number of sampled coalitions in the present iteration. Any integer between 1 and the default is allowed. Larger values requires more memory, but may improve the surrogate model. If the user sets a value lower than the maximum, we sample this amount of unique coalitions separately for each training observations. That is, on average, all coalitions should be equally trained.

n_coalitions

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

Author(s)

Lars Henry Berge Olsen

shapr documentation built on April 4, 2025, 12:18 a.m.