shapiq.game_theory.is_empty_value_the_baseline¶

shapiq.game_theory.is_empty_value_the_baseline(index)[source]¶

Check if empty prediction is the baseline.

Checks if the empty value stored in the interaction values is the baseline value. This is only not the case for the Shapley Interaction Index and Banzhaf values.

Parameters:

index (str) – The interaction index.

Return type:

bool

Returns:

True if the empty value is the baseline value, False otherwise.

Examples

>>> is_empty_value_the_baseline("SII")
False
>>> is_empty_value_the_baseline("SV")
True
>>> is_empty_value_the_baseline("k-SII")
True