PermutationSamplingSV¶

Permutation-based Shapley value approximation using PermutationSamplingSV.

from __future__ import annotations

import numpy as np

import shapiq

N_PLAYERS = 8
BUDGET = 200
feature_names = [f"x{i}" for i in range(N_PLAYERS)]

weights = np.array([0.4, 0.3, 0.2, 0.1, 0.05, -0.1, -0.2, -0.3])


def game_fun(coalitions: np.ndarray) -> np.ndarray:
    coalitions = np.atleast_2d(coalitions)
    return (coalitions @ weights) + 0.5 * coalitions[:, 0] * coalitions[:, 1]

Approximate Shapley values¶

approximator = shapiq.PermutationSamplingSV(n=N_PLAYERS, random_state=42)
iv = approximator.approximate(BUDGET, game_fun)
print(iv)
InteractionValues(
    index=SV, max_order=1, min_order=0, estimated=True, estimation_budget=198,
    n_players=8, baseline_value=0.0,
    Top 10 interactions:
        (0,): 0.65
        (1,): 0.5500000000000003
        (2,): 0.2
        (3,): 0.1
        (4,): 0.04999999999999994
        (): 0.0
        (5,): -0.1000000000000001
        (6,): -0.20000000000000012
        (7,): -0.29999999999999993
)

Visualize the result¶

iv.plot_force(feature_names=feature_names)
plot permutation sampling sv

Total running time of the script: (0 minutes 0.208 seconds)