Skip to main content

RL environments for poker games

Project description

PokeRL

PyPI version PyPI license Build Status

pokerl is a poker Reinforcement Learning (RL) environment.

Currently the only game supported is No Limit Texas Hold'em.

Installation

You can download and install the latest version from PyPI:

agent@pokerl:~$ pip install pokerl

Usage

A game is created by creating a new instance of the pokerl.Game class:

from pokerl import Game
game = Game()

The constructor accepts various parameters, such as the number of players and the initial credits:

game = Game(num_players=4, start_credits=100)
game.reset() # Init game state

At each step, there is an active player and an active state, which captures the state of the game as seen by the active player. The active player performs actions by passing a valid action value to game.step(action):

from pokerl.enums import PokerMoves
game.step(PokerMoves.CALL)
game.step(PokerMoves.FOLD)
game.step(PokerMoves.ALL_IN)

The type of action must be int or np.integer

The Game.active_state property is an object of type Game.StateView that has various informations that can be used by the agent to make informed decisions. The state also has a list of valid_actions, which is a one-hot encoded array of valid actions:

# Choose random action
valids = game.active_state.valid_actions
action = np.random.choice(len(valids), p=valids / np.sum(valids))
game.step(action)

If an invalid action is passed to game.step (e.g. if you try to call a bet but you don't have enough credit) a ValueError is raised.

game.step also returns a 3-element tuple indicating whether the game is over, the hand is over and/or the round of bets is over:

done, _, _ = game.step(action)
if done: print('game is over')

After each hand, the net profit of each player is saved in game.payoffs.

For more info see the Wiki page.

Environments

If you are familiar with OpenAI Gym, the racerl.envs module has an environment that exposes an API similar to that of gym.Env. The PokerGameEnv simulates an entire game and returns a non-zero reward after each hand, depending on the player's payoffs and bets. To use the PokerGameEnv create a new instance by passing a list of opponents:

from pokerl import Game
from pokerl.envs import PokerGameEnv

def random_agent(state: Game.StateView) -> int:

	actions = state.valid_action_indices
	return np.random.choice(list(actions))

env = PokerGameEnv([random_agent, random_agent, random_agent], num_players=4)

An opponent must be a callable object which receives the game state, as seen by the agent, and returns a valid action.

The usual methods env.reset() and env.step(action) can be used to reset the state and perform actions on the environment:

# Evaluate one episode

R = []
state = env.reset()
done = False
while not done:
	action = predict(state)
	state, rwd, done, _ = env.step(action)
	R.append(rwd)

print('score', np.sum(R))

The reward is the sum of the payoffs.

Network

The network branch is an experimental branch where it is possible to play online games. Many functionalities are also available in the main branch.

To create a server, create a new instance of the pokerl.network.PokerGameServer class:

from pokerl.network import PokerGameServer
server = PokerGameServer(num_players=3)

The constructor accepts the same parameters of Game. To start the server and play a game, use server.setup(host, port) followed by server.run():

server.setup('localhost', 25560)
#server.setup() Listen on default host and port
server.run()

A client is an instance of pokerl.network.PokerGameClient. The contructor accepts a callable object agent, which represent the agent policy and ideally is a subclass of pokerl.agents.PokerAgent:

from pokerl.agents import RandomAgent
client = PokerGameClient(agent=RandomAgent)

To connect to a server, use client.connect(host, port):

client.connect('localhost', 25560)
client.connect() # Use default host and port

Once all the players have connected, the game will begin.

At the moment, the log of the game is only accessible to the server. Clients may print their active state to follow the progress of the game.

Contributors

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

pokerl-0.0.6.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

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

pokerl-0.0.6-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file pokerl-0.0.6.tar.gz.

File metadata

  • Download URL: pokerl-0.0.6.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for pokerl-0.0.6.tar.gz
Algorithm Hash digest
SHA256 674011dd96725ba308c5460077edb0b9c217734bd5d8cdf22abee2a735eea5df
MD5 b3e3260988b69b6b88e11bdc2f744439
BLAKE2b-256 7e2421e936eb783dd7c781aac73bbc11fab220f639c2bf883b37fb8d5cae38b5

See more details on using hashes here.

File details

Details for the file pokerl-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: pokerl-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for pokerl-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 27674cda2cc7006cec77c94f21df85ab3a67a54389294a2fded3066917722a74
MD5 5874710a285d5c034a85df9825bbf6eb
BLAKE2b-256 aee8f20511551ad06303965441346ae522d5c8ba04b27f90dad59f6ea9dfc6ca

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