michaelfeil/skyjo_rl

Multi-Agent Reinforcement Learning Environment for the card game SkyJo, compatible with PettingZoo and RLLIB

skyjo_rl

Multi-Agent Reinforcement Learning Environment for the card game SkyJo, compatible with PettingZoo and RLLIB

Read the docs

Project Organization

Github Repository

├── LICENSE
├── Makefile                <- Makefile with commands like `make data` or `make train`
├── README.md               <- The top-level README for developers using this project.
│
├── docs                    <- Docs HTMLs, see Sphinx [docs](https:/michaelfeil.github.io/skyjo_rl)
│
├── models                  <- Trained and serialized models, model predictions, or model summaries
│
├── notebooks               <- Jupyter notebooks. 
├── requirements.txt                        <- requirements for the rlskyjo
├── requirements_dev.txt                    <- requirements for developers
├── rlskyjo                                    
│   ├── environment
│   │   ├── skyjo_env.py
│   │   └── vanilla_env_example.py
│   ├── game
│   │   ├── sample_game.py
│   │   └── skyjo.py
│   ├── models
│   │   ├── action_mask_model.py
│   │   ├── random_admissible_policy.py
│   │   └── train_model_simple_rllib.py
│   └── utils.py
├── setup.py                                <- makes project pip installable (pip install -e .) so skyjo_rl can be imported
├── test_environment.py
├── tests                                   <- Unittests
└── tox.ini                                 <- tox file with settings for running tox; see tox.readthedocs.io

---

PYPI Install

conda create --name skyjo python=3.8 pip
conda activate skyjo
pip install rlskyjo

---

Developer Install

git clone https://github.com/michaelfeil/skyjo_rl.git
conda create --name skyjo python=3.8 pip
conda activate skyjo
pip install -r requirements.txt
pip install -r requirements_dev.txt
pip install -e .
pre-commit install
coverage run -m --source=./rlskyjo pytest tests

Tutorials

Vanilla SkyJo PettingZoo Env example

SkyJo game example

Train PPO MultiAgent with SkyJo PettingZoo Env, Pytorch and RLLib

skyjo_rl's Issues

Feature request: update PettingZoo version

Hi, would it be possible to update this repo to use the most recent version of PettingZoo? This project is listed in PettingZoo's third-party-environments, but we only want to include environments which work with the current version.

If you need any help working out issues due to different versions feel free to ask, there were some breaking changes in version 1.2, so it requires a bit of code changes to adapt. The previous API returned done in the step() function, whereas the new one returns truncated and terminated (matching gymnasium). There is a migration guide for gymnasium explaining the changes further, the steps should be basically the same (we're working on making resources for updating old PettingZoo repositories as well): https://gymnasium.farama.org/content/migration-guide/