vaeac_get_mask_generator_name: Function that determines which mask generator to use

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

Function that determines which mask generator to use

Description

Function that determines which mask generator to use

Usage

vaeac_get_mask_generator_name(
  mask_gen_coalitions,
  mask_gen_coalitions_prob,
  masking_ratio,
  verbose
)

Arguments

mask_gen_coalitions	Matrix (default is NULL). Matrix containing the coalitions that the vaeac model will be trained on, see specified_masks_mask_generator(). This parameter is used internally in shapr when we only consider a subset of coalitions/combinations, i.e., when n_combinations < 2^{n_{\text{features}}}, and for group Shapley, i.e., when group is specified in explain().
mask_gen_coalitions_prob	Numeric array (default is NULL). Array of length equal to the height of mask_gen_coalitions containing the probabilities of sampling the corresponding coalitions in mask_gen_coalitions.
masking_ratio	Numeric (default is 0.5). Probability of masking a feature in the mcar_mask_generator() (MCAR = Missing Completely At Random). The MCAR masking scheme ensures that vaeac model can do arbitrary conditioning as all coalitions will be trained. masking_ratio will be overruled if mask_gen_coalitions is specified.
verbose	Boolean. An integer specifying the level of verbosity. Use 0 (default) for no verbosity, 1 for low verbose, and 2 for high verbose.

Value

The function does not return anything.

Author(s)

Lars Henry Berge Olsen

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