A python module for analyzing sparse and empirical games
Project description
Game Analysis
[](https://travis-ci.org/egtaonline/gameanalysis) [](https://coveralls.io/github/egtaonline/gameanalysis?branch=master) [](http://gameanalysis.readthedocs.io/en/latest/?badge=latest)
This is a collection of python libraries and scripts that manipulate empirical game data.
Usage Setup
This package is hosted on pypi. Install it with pip install gameanalysis.
The entry point from the command line is ga. ga –help will document all available options.
The entry point for python is gameanalysis. See the documentation for what is available from the python interface.
Developing
After cloning this repository, the included Makefile includes all the relevant actions to facilitate development. Typing make without targets will print out the various actions to help development. Type make setup to configure a virtual environment for development.
Requirements
Python 3 & venv
BLAS/LAPACK
A fortran compiler
Testing
All of the tests can be run with make test. If you want more fine grained control, you can run make test file=<file> to execute tests for a single file in game analysis e.g. make test file=rsgame. Additionally, make coverage and make coverage file=<file> will run all of the tests and output a report on the coverage.
Games
There are three game types: BaseGame, Game, and SampleGame.
BaseGame contains several functions that are valid for games without payoff data, and has the general structure that arbitrary game-like objects should inherit from.
Game is a potentially sparse mapping from role symmetric profiles to payoffs. It provides methods to quickly calculate mixture deviation gains, necessary for computing nash equilibria.
SampleGame retains payoff data for every observation. This allows it to resample the payoff data for every individual profile.
Profiles
Internally this library uses arrays to store game profiles, and doesn’t care about the names attached to a role or strategy, only their index. For consistence of lexicographic tie-breaking, roles and strategies are indexed in lexicographic order when serializing a named game into an internal array representation.
Style Guidelines
Generally follow PEP8 standard.
Single quotes
Lowercase underscore for method names
Camelcase classes
Unless obvious or necessary, try to only import modules not specific functions or classes from a module.
Put a docstring for every public function and class. The first line should be short summary followed by a more detailed description perhaps detailing information about parameters or return values.
flake8
Running make check will search for some of these. make format will try to fix some in place.
To Do
Some functions in dominance could probably be more efficient.
Using array set operations would allow for convenient array operations like, “are all of these profiles present”, however, it requires sorting of large void types which is very expensive, less so than just hashing the data. Maybe with pandas? Or maybe numpy will implement these more efficiently in c.
It may be possible to be excessively clever, where we subclass ndarray with our own “profile-esqe” class. This class will necessarily retain a reference to the game it refers to, but is otherwise an ndarray. It could have to_json and str representations, where internally it would check the dimension and dtype to determine if this is one or several and a mixture profile or subgame. This seems really cool, but may be more clever than helpful.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gameanalysis-4.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f6abba5caf812d1d9605f836c1db9a1c8a9775777073863da58814345a18c0fa |
|
| MD5 | 34a534eaa566ba5603ff1334516ae5ba |
|
| BLAKE2b-256 | ba7aaa0f5377f61d9caf7f107cc1277a4860546645365bd5e597dc6156a17e7a |
](https://travis-ci.org/egtaonline/gameanalysis){kind=link}
](https://coveralls.io/github/egtaonline/gameanalysis){kind=link}