Jumanji

<p align="center"> <a href="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/img/jumanji_logo.png"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/img/jumanji_logo.png" alt="Jumanji logo" width="50%"/> </a> </p>

Environments | Installation | Quickstart | Training | Citation | Docs

<div class="collage"> <div class="row" align="center"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/bin_pack.gif" alt="BinPack" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/cleaner.gif" alt="Cleaner" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/connector.gif" alt="Connector" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/cvrp.gif" alt="CVRP" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/flat_pack.gif" alt="FlatPack" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/game_2048.gif" alt="Game2048" width="16%"> </div> <div class="row" align="center"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/graph_coloring.gif" alt="GraphColoring" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/job_shop.gif" alt="JobShop" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/knapsack.gif" alt="Knapsack" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/maze.gif" alt="Maze" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/minesweeper.gif" alt="Minesweeper" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/mmst.gif" alt="MMST" width="16%"> </div> <div class="row" align="center"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/multi_cvrp.gif" alt="MultiCVRP" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/pac_man.gif" alt="PacMan" width="12.9%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/robot_warehouse.gif" alt="RobotWarehouse" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/rubiks_cube.gif" alt="RubiksCube" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/sliding_tile_puzzle.gif" alt="SlidingTilePuzzle" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/snake.gif" alt="Snake" width="16%"> </div> <div class="row" align="center"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/sokoban.gif" alt="RobotWarehouse" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/sudoku.gif" alt="Sudoku" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/tetris.gif" alt="Tetris" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/tsp.gif" alt="Tetris" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/lbf.gif" alt="Level-Based Foraging" width="16%"> <img src="https://raw.githubusercontent.com/instadeepai/jumanji/main/docs/env_anim/search_and_rescue.gif" alt="Search and Rescue" width="16%"> </div> </div>

Jumanji @ ICLR 2024

Jumanji has been accepted at ICLR 2024, check out our research paper.

Welcome to the Jungle! 🌴

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 InstaDeep, 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 or just star 🌟 to stay up to date with the latest developments!

Goals 🚀

1. Provide a simple, well-tested API for JAX-based environments.
2. Make research in RL more accessible.
3. Facilitate the research on RL for problems in the industry and help close the gap between research and industrial applications.
4. Provide environments whose difficulty can be scaled to be arbitrarily hard.

Overview 🦜

• 🥑 Environment API: core abstractions for JAX-based environments.
• 🕹️ Environment Suite: a collection of RL environments ranging from simple games to NP-hard combinatorial problems.
• 🍬 Wrappers: easily connect to your favourite RL frameworks and libraries such as Acme, Stable Baselines3, RLlib, Gymnasium and DeepMind-Env through our dm_env and gym wrappers.
• 🎓 Examples: guides to facilitate Jumanji's adoption and highlight the added value of JAX-based environments.
• 🏎️ Training: example agents that can be used as inspiration for the agents one may implement in their research.

<h2 name="environments" id="environments">Environments 🌍</h2>

Jumanji provides a diverse range of environments ranging from simple games to NP-hard combinatorial problems.

| Environment | Category | Registered Version(s) | Source | Description | |------------------------------------------|----------|------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------| | 🔢 Game2048 | Logic | Game2048-v1 | code | doc | | 🎨 GraphColoring | Logic | GraphColoring-v1 | code | doc | | 💣 Minesweeper | Logic | Minesweeper-v0 | code | doc | | 🎲 RubiksCube | Logic | RubiksCube-v0<br/>RubiksCube-partly-scrambled-v0 | code | doc | | 🔀 SlidingTilePuzzle | Logic | SlidingTilePuzzle-v0 | code | doc | | ✏️ Sudoku | Logic | Sudoku-v0 <br/>Sudoku-very-easy-v0| code | doc | | 📦 BinPack (3D BinPacking Problem) | Packing | BinPack-v1 | code | doc | | 🧩 FlatPack (2D Grid Filling Problem) | Packing | FlatPack-v0 | code | doc | | 🏭 JobShop (Job Shop Scheduling Problem) | Packing | JobShop-v0 | [code](https://github.com/instadeepai/jumanji/tree/main/jumanji/environments/packing/j