From 90fca897b09c27330a2eb15e4250486daaa6f665 Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:22:06 +0100 Subject: [PATCH 1/7] docs: sort by alphabetic order --- mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5adc18f9e..928da794b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -37,11 +37,11 @@ nav: - Maze: environments/maze.md - MMST: environments/mmst.md - MultiCVRP: environments/multi_cvrp.md + - PacMan: environments/pac_man.md - RobotWarehouse: environments/robot_warehouse.md + - Sokoban: environments/sokoban.md - Snake: environments/snake.md - TSP: environments/tsp.md - - Sokoban: environments/sokoban.md - - PacMan: environments/pac_man.md - User Guides: - Advanced Usage: guides/advanced_usage.md - Registration: guides/registration.md @@ -70,11 +70,11 @@ nav: - Maze: api/environments/maze.md - MMST: api/environments/mmst.md - MultiCVRP: api/environments/multi_cvrp.md + - PacMan: api/environments/pac_man.md - RobotWarehouse: api/environments/robot_warehouse.md + - Sokoban: api/environments/sokoban.md - Snake: api/environments/snake.md - TSP: api/environments/tsp.md - - Sokoban: api/environments/sokoban.md - - PacMan: api/environments/pac_man.md - Wrappers: api/wrappers.md - Types: api/types.md From 54619123767c94c8aeed50b8c2d6db22bc5db26a Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:22:14 +0100 Subject: [PATCH 2/7] fix: train requirement --- requirements/requirements-train.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements/requirements-train.txt b/requirements/requirements-train.txt index 087ca0369..890d0f983 100644 --- a/requirements/requirements-train.txt +++ b/requirements/requirements-train.txt @@ -1,4 +1,4 @@ -dm-haiku==0.0.9 +dm-haiku hydra-core==1.3 neptune-client==0.16.15 optax>=0.1.4 From ee917db3fe5205a377bd91797fd8194083bbfa5f Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:22:45 +0100 Subject: [PATCH 3/7] docs: add missing gifs --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 28fbd5b4c..7a7e00a30 100644 --- a/README.md +++ b/README.md @@ -26,28 +26,30 @@ Cleaner Connector CVRP + FlatPack Game2048 - GraphColoring
+ GraphColoring JobShop Knapsack Maze Minesweeper MMST - MultiCVRP
+ MultiCVRP + PacMan RobotWarehouse RubiksCube + SlidingTilePuzzle Snake - Sudoku - Tetris - Tetris
- RobotWarehouse RobotWarehouse + Sudoku + Tetris + Tetris
From f42304ca19e1ad514ce4f67f693af89d4f82aac9 Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:25:23 +0100 Subject: [PATCH 4/7] docs: paper --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7a7e00a30..0a1c957a6 100644 --- a/README.md +++ b/README.md @@ -53,14 +53,17 @@ +## Jumanji @ ICLR 2024 + +Jumanji has been accepted at [ICLR 2024](https://iclr.cc/), check out our [research paper](https://arxiv.org/abs/2306.09884). ## Welcome to the Jungle! 🌴 -Jumanji is a diverse suite of scalable reinforcement learning environments written in JAX. +Jumanji is a diverse suite of scalable reinforcement learning environments written in JAX. It now features 22 environments! Jumanji is helping pioneer a new wave of hardware-accelerated research and development in the field of RL. Jumanji's high-speed environments enable faster iteration and large-scale -experimentation while simultaneously reducing complexity. Originating in the Research Team at +experimentation while simultaneously reducing complexity. Originating in the research team at [InstaDeep](https://www.instadeep.com/), Jumanji is now developed jointly with the open-source community. To join us in these efforts, reach out, raise issues and read our [contribution guidelines](https://github.com/instadeepai/jumanji/blob/main/CONTRIBUTING.md) or just @@ -231,17 +234,10 @@ details on how to submit pull requests, our Contributor License Agreement, and c If you use Jumanji in your work, please cite the library using: ``` -@misc{bonnet2023jumanji, - title={Jumanji: a Diverse Suite of Scalable Reinforcement Learning Environments in JAX}, - author={ - Clément Bonnet and Daniel Luo and Donal Byrne and Shikha Surana and Vincent Coyette and - Paul Duckworth and Laurence I. Midgley and Tristan Kalloniatis and Sasha Abramowitz and - Cemlyn N. Waters and Andries P. Smit and Nathan Grinsztajn and Ulrich A. Mbou Sob and - Omayma Mahjoub and Elshadai Tegegn and Mohamed A. Mimouni and Raphael Boige and - Ruan de Kock and Daniel Furelos-Blanco and Victor Le and Arnu Pretorius and - Alexandre Laterre - }, - year={2023}, +@misc{bonnet2024jumanji, + title={Jumanji: a Diverse Suite of Scalable Reinforcement Learning Environments in JAX}, + author={Clément Bonnet and Daniel Luo and Donal Byrne and Shikha Surana and Sasha Abramowitz and Paul Duckworth and Vincent Coyette and Laurence I. Midgley and Elshadai Tegegn and Tristan Kalloniatis and Omayma Mahjoub and Matthew Macfarlane and Andries P. Smit and Nathan Grinsztajn and Raphael Boige and Cemlyn N. Waters and Mohamed A. Mimouni and Ulrich A. Mbou Sob and Ruan de Kock and Siddarth Singh and Daniel Furelos-Blanco and Victor Le and Arnu Pretorius and Alexandre Laterre}, + year={2024}, eprint={2306.09884}, url={https://arxiv.org/abs/2306.09884}, archivePrefix={arXiv}, From b803b5729b28cfad6d51c3f6baaba6a4f9e395ad Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:25:45 +0100 Subject: [PATCH 5/7] docs: fix pac_man --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a1c957a6..a309d8964 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ problems. | 🐍 Snake | Routing | `Snake-v1` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/snake/) | [doc](https://instadeepai.github.io/jumanji/environments/snake/) | | 📬 TSP (Travelling Salesman Problem) | Routing | `TSP-v1` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/tsp/) | [doc](https://instadeepai.github.io/jumanji/environments/tsp/) | | Multi Minimum Spanning Tree Problem | Routing | `MMST-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/mmst) | [doc](https://instadeepai.github.io/jumanji/environments/mmst/) | -| ᗧ•••ᗣ•• PacMan | Routing | `PacMan-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/pacman/) | [doc](https://instadeepai.github.io/jumanji/environments/pacman/) +| ᗧ•••ᗣ•• PacMan | Routing | `PacMan-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/pac_man/) | [doc](https://instadeepai.github.io/jumanji/environments/pac_man/) | 👾 Sokoban | Routing | `Sokoban-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/routing/sokoban/) | [doc](https://instadeepai.github.io/jumanji/environments/sokoban/) |

Installation 🎬

@@ -126,7 +126,7 @@ problems. You can install the latest release of Jumanji from PyPI: ```bash -pip install jumanji +pip install -U jumanji ``` Alternatively, you can install the latest development version directly from GitHub: From 9caef0d29b808fd1ee5f612b8941bb0a2d5088c0 Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 11:25:58 +0100 Subject: [PATCH 6/7] docs: add sliding tile puzzle --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a309d8964..f4b3785c9 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,7 @@ problems. | 🎨 GraphColoring | Logic | `GraphColoring-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/logic/graph_coloring/) | [doc](https://instadeepai.github.io/jumanji/environments/graph_coloring/) | | 💣 Minesweeper | Logic | `Minesweeper-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/logic/minesweeper/) | [doc](https://instadeepai.github.io/jumanji/environments/minesweeper/) | | 🎲 RubiksCube | Logic | `RubiksCube-v0`
`RubiksCube-partly-scrambled-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/logic/rubiks_cube/) | [doc](https://instadeepai.github.io/jumanji/environments/rubiks_cube/) | +| 🔀 SlidingTilePuzzle | Logic | `SlidingTilePuzzle-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/logic/sliding_tile_puzzle/) | [doc](https://instadeepai.github.io/jumanji/environments/sliding_tile_puzzle/) | | ✏️ Sudoku | Logic | `Sudoku-v0`
`Sudoku-very-easy-v0`| [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/logic/sudoku/) | [doc](https://instadeepai.github.io/jumanji/environments/sudoku/) | | 📦 BinPack (3D BinPacking Problem) | Packing | `BinPack-v1` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/packing/bin_pack/) | [doc](https://instadeepai.github.io/jumanji/environments/bin_pack/) | | 🧩 FlatPack (2D Grid Filling Problem) | Packing | `FlatPack-v0` | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/packing/flat_pack/) | [doc](https://instadeepai.github.io/jumanji/environments/flat_pack/) | From eb6f9b5d0772d15eeaeead4b60bdca69a9348991 Mon Sep 17 00:00:00 2001 From: Clement Bonnet Date: Tue, 19 Mar 2024 12:03:01 +0100 Subject: [PATCH 7/7] fix: linter --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f4b3785c9..81306968c 100644 --- a/README.md +++ b/README.md @@ -236,7 +236,7 @@ If you use Jumanji in your work, please cite the library using: ``` @misc{bonnet2024jumanji, - title={Jumanji: a Diverse Suite of Scalable Reinforcement Learning Environments in JAX}, + title={Jumanji: a Diverse Suite of Scalable Reinforcement Learning Environments in JAX}, author={Clément Bonnet and Daniel Luo and Donal Byrne and Shikha Surana and Sasha Abramowitz and Paul Duckworth and Vincent Coyette and Laurence I. Midgley and Elshadai Tegegn and Tristan Kalloniatis and Omayma Mahjoub and Matthew Macfarlane and Andries P. Smit and Nathan Grinsztajn and Raphael Boige and Cemlyn N. Waters and Mohamed A. Mimouni and Ulrich A. Mbou Sob and Ruan de Kock and Siddarth Singh and Daniel Furelos-Blanco and Victor Le and Arnu Pretorius and Alexandre Laterre}, year={2024}, eprint={2306.09884},