shapley_numba.examples package

Submodules

shapley_numba.examples.finance module

Games and computations related to finance.

class shapley_numba.examples.finance.BlackScholesCallGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

A game representing the Black-Scholes call option price.

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of BlackScholesCallGame

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

shapley_numba.examples.games module

Examples of jit-compiled games in shapley-numba.

class shapley_numba.examples.games.GloveGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

A game representing the value of glove market.

The value of a coalition is the minimum of the number of left gloves and right gloves it possesses.

num_left_gloves

The number of left gloves available in the game.

Type:

int

__init__(*args, **kwargs)

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

jitted_class = None

original_class

alias of GloveGame

class shapley_numba.examples.games.CoalitionGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

A game representing a political coalition.

Game is “won” if a coalition achieves majority

__init__(*args, **kwargs)

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

jitted_class = None

original_class

alias of CoalitionGame

class shapley_numba.examples.games.WikipediaExample(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

Game taken from shapley value wikipedia page.

Players are represented by their index: 0 - “you” 1 - “Emma” 2 - Liam

__init__(*args, **kwargs)

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

jitted_class = None

original_class

alias of WikipediaExample

class shapley_numba.examples.games.AirPortGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

Airport game.

Classic game, where length requirements are translated to cost assignments, via Shapley values. See https://en.wikipedia.org/wiki/Airport_problem for more details.

__init__(*args, **kwargs)

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

jitted_class = None

original_class

alias of AirPortGame

Module contents

Examples for cooperative games.

class shapley_numba.examples.WikipediaExample(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

Game taken from shapley value wikipedia page.

Players are represented by their index: 0 - “you” 1 - “Emma” 2 - Liam

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of WikipediaExample

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

game: GameProtocol

jitted_game: GameProtocol | Exception

class shapley_numba.examples.GloveGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

A game representing the value of glove market.

The value of a coalition is the minimum of the number of left gloves and right gloves it possesses.

num_left_gloves

The number of left gloves available in the game.

Type:

int

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of GloveGame

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

game: GameProtocol

jitted_game: GameProtocol | Exception

class shapley_numba.examples.CoalitionGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

A game representing a political coalition.

Game is “won” if a coalition achieves majority

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of CoalitionGame

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

game: GameProtocol

jitted_game: GameProtocol | Exception

class shapley_numba.examples.AirPortGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

Airport game.

Classic game, where length requirements are translated to cost assignments, via Shapley values. See https://en.wikipedia.org/wiki/Airport_problem for more details.

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of AirPortGame

value(subset)

Return value of the game.

Just a convenience method to hide actual class.

game: GameProtocol

jitted_game: GameProtocol | Exception

class shapley_numba.examples.UnanimityGame(*args, **kwargs)

Bases: ShapleyNumbaGameProtocol

Unanimity game class.

Unanimity game is the simplest game where if coalition contains a veto set it wins and if the coalition does not contain the whole veto set it loses.

__init__(*args, **kwargs)

jitted_class = None

original_class

alias of UnanimityGame

value(subset)

Return value of the game.

Just a convenience method to hide actual class.