Skip to main content

Multi-Agent Reinforcement Learning Environment for the board game Gobblet using PettingZoo.

Project description

gobblet-rl

Multi-Agent Reinforcement Learning Environment for the Gobblet board game board game using PettingZoo.

Gobblet game

Installation

Using pip (recommended)

pip install gobblet-rl

Local

git clone hhttps://github.com/elliottower/gobblet-rl.git
cd gobblet-rl
pip install -e .

Usage

Setting up a basic environment

In a Python shell, run the following:

import pettingzoo
from gobblet gobblet_v0

-rl
env = gobblet_v0.env()

Train a basic agent with Tianshou

In the terminal, run the following:

python gobblet/example_tianshou.py

This will train a DQN model from Tianshou for 50 epochs, and then render the trained agent playing against a random agent in an example match.

Playing a game with a random agent

In the terminal, run the following:

python gobblet/example_random.py --render_mode="human" --agent_type="random"

Command-line arguments

--render_mode="human" will render a 3x3 board only showing the topmost pieces (pieces which are covered by others, or 'gobbled', are hidden):

AGENT: player_1, ACTION: 50, POSITION: 5, PIECE: 6
       |       |       
  -    |   -   |   -   
_______|_______|_______
       |       |       
  -    |   -   |   -   
_______|_______|_______
       |       |       
  +5   |   -6  |   -   
       |       |       

--render_mode="human_full" will render three different 3x3 boards representing the small, medium and large pieces. This gives full information about pieces which are covered or 'gobbled' by other pieces. :

AGENT: player_0, ACTION: 42, POSITION: 6, PIECE: 5
         SMALL                     MED                     LARGE           
       |       |                |       |                |       |       
  -    |   -   |   -       -    |   -   |   -       -    |   -   |   +5  
_______|_______|_______  _______|_______|_______  _______|_______|_______
       |       |                |       |                |       |       
  -    |   -   |   -2      -    |   -   |   -       -    |   -   |   -   
_______|_______|_______  _______|_______|_______  _______|_______|_______
       |       |                |       |                |       |       
  -    |   -   |   -       -    |   -   |   -       -    |   -   |   -6  
       |       |                |       |                |       |       

Testing

Testing can be done via pytest:

git clone https://github.com/elliottower/gobblet-rl.git
cd gobblet-rl
pytest

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

gobblet-rl-1.0.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

gobblet_rl-1.0.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file gobblet-rl-1.0.0.tar.gz.

File metadata

  • Download URL: gobblet-rl-1.0.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for gobblet-rl-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3da7842e581954415955a08b305bade069b0f7118c2bb91f708dc2903656aef5
MD5 3080c29f00bcecc0268d61d2a80c0e2b
BLAKE2b-256 27577ba675ceddf06d3e5300c814e4d2b4a3ceeec43e91747a4876db52f7d5aa

See more details on using hashes here.

File details

Details for the file gobblet_rl-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: gobblet_rl-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for gobblet_rl-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f700e6ba37fdcfc8a2c0ab688a6f21f4e20b4d8b1e9911421ffc2bc24ec7d32
MD5 97d3ded1a8f0149dd1b10d31bda9876f
BLAKE2b-256 61705cfc6d5b49fadcf0fb70478c3e4a515f56bee24ce55f1664ed9bbddc1639

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page