API Reference

Complete API documentation for all modules in the shapley_numba package.

Core Modules

The main computational modules for Shapley values and Harsanyi dividends.

shapley_numba.shapley

Functions for computing Shapley values (exact and Monte Carlo approximation)

shapley_numba.harsanyi

Functions for computing Harsanyi dividends (synergies)

shapley_numba.core

Core game abstractions and interfaces

Utilities

Helper modules for working with cooperative games.

shapley_numba.tools

Set iteration tools and subset enumeration utilities

shapley_numba.common

Common utilities and helper functions

shapley_numba.game_templates

Base templates for implementing custom games

Examples

Pre-built game examples demonstrating the library’s capabilities.

shapley_numba.examples

Collection of example games (Glove Game, Finance examples, etc.)

Full Module Documentation

• shapley_numba package
  • Subpackages
    • shapley_numba.examples package
  • Core Computational Modules
  • shapley_numba.common module
    • subsets()
    • subsets_of_subset()
    • subsets_of_subset_with_base()
    • combs_jit()
    • combs()
    • subsets_of_fixed_size()
    • mask_to_subset()
    • add_subset_size()
  • shapley_numba.core module
    • numba_game()
    • has_jitted_game()
    • numba_game_func()
  • shapley_numba.game_templates module
    • ParameterChangeExplanation
    • TableGame
  • shapley_numba.harsanyi module
    • HarsanyiDividends
  • shapley_numba.harsanyi_naive module
    • harsanyi_dividends()
  • shapley_numba.shapley module
    • shapley()
    • shapley_perm_mc()
  • shapley_numba.tools module
    • dual_game()
    • CoalitionType
    • GameProtocol
    • ShapleyNumbaGameProtocol
    • GameSpecType
  • Module contents
    • Package structure
    • numba_game()
    • GameProtocol
    • ShapleyNumbaGameProtocol