Skip to content

vlongle/Imperfecto

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Imperfect Information Games

A Python module of imperfect information games and learning algorithms.

GitHub last commit GitHub issues GitHub pull requests GitHub tweet

AboutInstallationBackgroundFeaturesGetting StartedDocumentationReferencesLicense

About

Imperfecto is a Python module of heavily commented implementations of algorithms and games with imperfect information such as Rock-Paper-Scissor and Poker. See Features for a list of games and algorithms we provide. See Installation for instruction on how to install this module, and Getting Started on usage and how to customize our module for your own game. For a complete documentation, see Documentation.

Installation

Clone this repo and install it as a module.

$ git clone https://github.com/vlongle/Imperfecto.git
$ cd imperfecto
$ pip3 install -e .

Try to import the module to check if the installation has been successful.

$ python3
>> import imperfecto

Background

Imperfect Information Games

Games such as Chess are known as "perfect information" games as there is no private information to each player. Every player can observe each other's moves, and the game state (i.e., the chess board).

However, games such as Poker are "imperfect-information" as each player has their own private card. Games with simultaneously moves such as rock-paper-scissor can also be modeled as imperfect information as each player doesn't know the opponent's move ahead of time.

Games with imperfect information are typically modeled as extensive-form game (EFG). EFG models sequential games with a game tree. Players take turn making moves until a termination node is reached, where the payoff is revealed. Players make decision at each decision node. However, the players do not know exactly which node they are in. Instead, they only know that they're in a set of nodes known as an information set. An information set represents all the possible worlds that are consistent with what the player knows.

Features

Games Progress
Rock-paper-scissor ✔️
Asymmetric Rock-paper-scissor ✔️
Bar-crowding Game ✔️
Prisoner's Dilemma ✔️
Kuhn Poker ✔️
Leduc Poker
Texas Hold' Em
Algorithm Progress
Regret Matching ✔️
Counterfactual Regret Minimization (CFR) ✔️
Monte Carlo CFR
Deep CFR
Bandit
Opponent modeling

Getting Started

Look at all the demos that we have in imperfecto/demos folder, and try any of them. For example, run (from the repo's root folder)

$ python3 imperfecto/demos/regret_matching_demo.py --help

to print out the available options for that demo file. Pick your desired options and run a demo file. For example,

$ python3 imperfecto/demos/regret_matching_demo.py --game PrisonerDilemmaGame
--train_regret_matching

Writing Your Own Games!

Normal-form Games

Add a new game by writing an ACTION_ENUM class that defines the possible action that is available to each player. Then, write a Game class that inherits from our NormalFormGame. You will need to implement the get_payoffs function.

from enum import intenum
from typing import sequence

from imperfecto.games.game import normalformgame
from imperfecto.utils import lessverboseenum


class MY_CUSTOM_ACTION(lessVerboseEnum, IntEnum):
    ...

class MyCustomNormalFormGame(NormalFormGame):
    actions = MY_CUSTOM_ACTION 
    n_players = ...
    def get_payoffs(self, history: Sequence[MY_CUSTOM_ACTION]) -> Sequence[float]:
        ...

See imperfecto/games/prisoner_dilemma.py for an example. You can then use your custom game with the functions available in imperfecto/demos/regret_matching_demo.py. For example,

...
from imperfecto.demos import to_train_regret_matching

Game = MyCustomNormalFormGame
to_train_regret_matching(Game)

TODOs

Documentation

Please see https://vlongle.github.io/Imperfecto/ for full documentation.

References

Image Credit

License

MIT License @ Long Le 2022.