Skip to main content

A package for computing semivalues.

Project description

This package offers tools for computing semivalues, with the Shapley value being the most prominent example. The functionality extends to computational tools for graph-based games.

Broad Functionality:

  • Computing the Shapley/Banzhaf value exact or approximately
  • Computing decomposition matrices

Detailed Functionality:

  • Computing the Shapley/Banzhaf value (exact and approximately)
  • Computing the Shapley/Banzhaf value decomposition by size (exact and approximately) (n x n matrix where each entry is aggregated over the respective subset size)
  • Computing the Shapley value of a player to another player (exact and approximately) (Hausken, Kjell, and Matthias Mohr. "The value of a player in n-person games." Social Choice and Welfare 18 (2001): 465-483.)

For the approximation methods of the Shapley value we refer to https://arxiv.org/pdf/1306.4265

How To Use

You need to have a utility function mapping an arbitrary set of players to a real number. Players names should be {0, ..., n-1}, i.e. the utility function should return values for all subsets of {0, ..., n-1}. We will use the example introduced here

def utility_game_function(S):
    GAME_VALUES = {
        frozenset(): 0,
        frozenset({0}): 180,
        frozenset({1}): 0,
        frozenset({2}): 0,
        frozenset({1, 2}): 0,
        frozenset({0, 1}): 360,
        frozenset({0, 2}): 540,
        frozenset({0, 1, 2}): 540,
    }

    def game_utility(coalition: set) -> int:
        return GAME_VALUES.get(frozenset(coalition), 0)

    return game_utility(S)


num_players = 3

from semivalues import shapley, banzhaf

# (n-vector)
shapley.exact(utility_game_function=utility_game_function, num_players=num_players)
shapley.strata_sampling(utility_game_function=utility_game_function, num_players=num_players, num_samples=100000)

banzhaf.exact(utility_game_function=utility_game_function, num_players=num_players)
banzhaf.sampling(utility_game_function=utility_game_function, num_players=num_players, num_samples=100000)

from semivalues.decompositions.by_size import shapley as shapley_by_size
from semivalues.decompositions.by_size import banzhaf as banzhaf_by_size

# (n x n matrix)
shapley_by_size.exact(utility_game_function=utility_game_function, num_players=num_players)
shapley_by_size.strata_sampling(utility_game_function=utility_game_function, num_players=num_players, num_samples=100000)

from semivalues.decompositions.by_size import banzhaf, shapley

# (n x n matrix)
banzhaf_by_size.exact(utility_game_function=utility_game_function, num_players=num_players)
banzhaf_by_size.monte_carlo_sampling(utility_game_function=utility_game_function, num_players=num_players, num_samples=100000)

from semivalues.decompositions.player_to_player import shapley as shapley_player_to_player

# (n x n matrix)
shapley_player_to_player.exact(utility_game_function=utility_game_function, num_players=num_players)
shapley_player_to_player.monte_carlo_sampling(utility_game_function=utility_game_function, num_players=num_players,
                                      num_samples=100000)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

semivalues-0.0.16.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

semivalues-0.0.16-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file semivalues-0.0.16.tar.gz.

File metadata

  • Download URL: semivalues-0.0.16.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for semivalues-0.0.16.tar.gz
Algorithm Hash digest
SHA256 1648621c9a147655706f608a5de0c81d8f91f6e71d69e0c0d932c3a5d99844b1
MD5 ecabf092018b2b779c995e45821aaf8d
BLAKE2b-256 ccacfc298804a1d04120b0a3d4db7b534c7224d3847df5c1653e717f1cfa33e4

See more details on using hashes here.

File details

Details for the file semivalues-0.0.16-py3-none-any.whl.

File metadata

  • Download URL: semivalues-0.0.16-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.4

File hashes

Hashes for semivalues-0.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 12d6d4973fca2d3224678ccf86f9f10f6abe4e99019ee013ea45971a5e1b3dd9
MD5 030f742916959c38869e09207c209417
BLAKE2b-256 f97c96e9865275a8711f009777a56d720dbefff90446004f2fd8bb76a57ba0b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page