Skip to main content

Shapley-Numba - computations on cooperative games using Numba. Author and compute cooperative games with ease. Package provides: - Shapley Values - Harsanyi Dividends (a.k.a. synergies)

Project description

Shapley Numba

Pipeline Status Coverage PyPI version Python Version License: MIT-0 Documentation Code style: ruff MyPy pre-commit Maintenance

Numba-based computations for cooperative games.

Installation

pip:

pip install shapley-numba

uv

uv add shapley-numba

Dependencies

shapley-numba package depends only on numba and numpy.

Features

  • Fast exact Shapley calculation.
  • Shapley Monte Carlo approximation.
  • Harsanyi Dividends (synergies) computation.
  • Set iteration tools.
  • Game authoring tools and game templates.

Quickstart

See tutorial notebook for quick start.

Usage

This package is intended to compute quantities associated with cooperative games. Currently we want to implement two functions:

  1. Shapley values
  2. Harsanyi dividends, also called synergies.

This package also provides tools to author and modify cooperative games, such as game templates.

A game is a class that implements value method. The value method should accept a numpy array of zeros and ones indicating membership of each element in the subset.

The intended use of the package is for games where each computation of value is relatively cheap. This allows to speed up such computations using numba.

For optimal performance, the game should be written so that it can be compiled using numba.experimental.jitclass compiler. That way, numba compiled functions can be applied. Otherwise, a python fallback will be applied.

The basic usage is as follows:

from shapley_numba.shapley import shapley
from shapley_numba.examples import GloveGame
glove_game = GloveGame(num_left_gloves=1)
shapley(glove_game, num_players=3)

See documentation for detailed reference.

Credits

Dimitry Offengenden participated in development of this code and contributed several game examples.

This code was developed with assistance from Google Gemini Code Assist (version 2.52.0).

This code was developed with assistance from Claude Code.

Alternatives

  • SHAP applies Shapley values to machine learning models but can be used in conjunction with any game.

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

shapley_numba-0.1.3.tar.gz (216.1 kB view details)

Uploaded Source

Built Distribution

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

shapley_numba-0.1.3-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file shapley_numba-0.1.3.tar.gz.

File metadata

  • Download URL: shapley_numba-0.1.3.tar.gz
  • Upload date:
  • Size: 216.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for shapley_numba-0.1.3.tar.gz
Algorithm Hash digest
SHA256 83eb4a31632b57ace750e845591206d392ae9f4f0d4c810cf7675ac6da4ea137
MD5 e2ecd04e83456426cd7a42079b8a0298
BLAKE2b-256 b85472c8fee53d3326c034b9917adfa04bef318f02a6b3b32fd6aeb46a2d5fab

See more details on using hashes here.

File details

Details for the file shapley_numba-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: shapley_numba-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for shapley_numba-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 507bc4a0a35a977cbd5ad566f18681cf49fc503a140a4e540c99c135ea67cbf1
MD5 3b66f785aee2bbb92f1fa2d830e0073d
BLAKE2b-256 bae2d47d92acdcf490e2b96ed55c87ad132ce40793c973ff7ec6f729641cf678

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