Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update online doc with new environments #158

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 27 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,33 @@
| [**Docs**](https://instadeepai.github.io/jumanji)
---

<p float="left" align="center">
<img src="docs/env_anim/connector.gif" alt="Connector" width="30%" />
<img src="docs/env_anim/snake.gif" alt="Snake" width="30%" />
<img src="docs/env_anim/cleaner.gif" alt="Cleaner" width="30%" />
<img src="docs/env_anim/job_shop.gif" alt="JobShop" width="30%" />
<img src="docs/env_anim/bin_pack.gif" alt="BinPack" width="30%" />
<img src="docs/env_anim/cvrp.gif" alt="CVRP" width="30%" />
<img src="docs/env_anim/multi_cvrp.gif" alt="MultiCVRP" width="30%" />
<img src="docs/env_anim/rubiks_cube.gif" alt="RubiksCube" width="30%" />
<img src="docs/env_anim/graph_coloring.gif" alt="GraphColoring" width="30%" />
<img src="docs/env_anim/game_2048.gif" alt="Game2048" width="30%" />
<img src="docs/env_anim/minesweeper.gif" alt="Minesweeper" width="30%" />
<img src="docs/env_anim/tetris.gif" alt="Tetris" width="30%" />
<img src="docs/env_anim/mmst.gif" alt="MMST" width="30%" />
<img src="docs/env_anim/sudoku.gif" alt="Sudoku" width="30%" />
</p>
<div class="collage">
<div class="row" align="center">
<img src="docs/env_anim/bin_pack.gif" alt="BinPack" width="16%">
<img src="docs/env_anim/cleaner.gif" alt="Cleaner" width="16%">
<img src="docs/env_anim/connector.gif" alt="Connector" width="16%">
<img src="docs/env_anim/cvrp.gif" alt="CVRP" width="16%">
<img src="docs/env_anim/game_2048.gif" alt="Game2048" width="16%">
<img src="docs/env_anim/graph_coloring.gif" alt="GraphColoring" width="16%">
</div>
<div class="row" align="center">
<img src="docs/env_anim/job_shop.gif" alt="JobShop" width="16%">
<img src="docs/env_anim/knapsack.gif" alt="Knapsack" width="16%">
<img src="docs/env_anim/maze.gif" alt="Maze" width="16%">
<img src="docs/env_anim/minesweeper.gif" alt="Minesweeper" width="16%">
<img src="docs/env_anim/mmst.gif" alt="MMST" width="16%">
<img src="docs/env_anim/multi_cvrp.gif" alt="MultiCVRP" width="16%">
</div>
<div class="row" align="center">
<img src="docs/env_anim/robot_warehouse.gif" alt="RobotWarehouse" width="16%">
<img src="docs/env_anim/rubiks_cube.gif" alt="RubiksCube" width="16%">
<img src="docs/env_anim/snake.gif" alt="Snake" width="16%">
<img src="docs/env_anim/sudoku.gif" alt="Sudoku" width="16%">
<img src="docs/env_anim/tetris.gif" alt="Tetris" width="16%">
<img src="docs/env_anim/tsp.gif" alt="Tetris" width="16%">
</div>
</div>


## Welcome to the Jungle! 🌴

Expand Down
1 change: 1 addition & 0 deletions docs/api/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- discount_spec
- unwrapped
- render
- animate
- close
- __enter__
- __exit__
Binary file modified docs/env_anim/robot_warehouse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/env_anim/tetris.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/env_img/robot_warehouse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/env_img/tetris.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 19 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: Jumanji
site_description: Documentation
site_author: InstaDeep Research
site_url: https://instadeep.github.io/jumanji/
site_url: https://instadeepai.github.io/jumanji/
site_dir: public
strict: false # TODO: Don't allow warning during the build process.

Expand All @@ -18,18 +18,24 @@ nav:
- Home: index.md
- Environments:
- Logic:
- RubiksCube: environments/rubiks_cube.md
- Minesweeper: environments/minesweeper.md
- Game2048: environments/game_2048.md
- GraphColoring: environments/graph_coloring.md
- Minesweeper: environments/minesweeper.md
- RubiksCube: environments/rubiks_cube.md
- Sudoku: environments/sudoku.md
- Packing:
- BinPack: environments/bin_pack.md
- Knapsack: environments/knapsack.md
- JobShop: environments/job_shop.md
- Knapsack: environments/knapsack.md
- Tetris: environments/tetris.md
- Routing:
- Cleaner: environments/cleaner.md
- Connector: environments/connector.md
- CVRP: environments/cvrp.md
- Maze: environments/maze.md
- MMST: environments/mmst.md
- MultiCVRP: environments/multi_cvrp.md
- RobotWarehouse: environments/robot_warehouse.md
- Snake: environments/snake.md
- TSP: environments/tsp.md
- User Guides:
Expand All @@ -41,18 +47,24 @@ nav:
- Environments:
- Base: api/env.md
- Logic:
- RubiksCube: api/environments/rubiks_cube.md
- Minesweeper: api/environments/minesweeper.md
- Game2048: api/environments/game_2048.md
- GraphColoring: api/environments/graph_coloring.md
- Minesweeper: api/environments/minesweeper.md
- RubiksCube: api/environments/rubiks_cube.md
- Sudoku: api/environments/sudoku.md
- Packing:
- BinPack: api/environments/bin_pack.md
- Knapsack: api/environments/knapsack.md
- JobShop: api/environments/job_shop.md
- Knapsack: api/environments/knapsack.md
- Tetris: api/environments/tetris.md
- Routing:
- Cleaner: api/environments/cleaner.md
- Connector: api/environments/connector.md
- CVRP: api/environments/cvrp.md
- Maze: api/environments/maze.md
- MMST: api/environments/mmst.md
- MultiCVRP: api/environments/multi_cvrp.md
- RobotWarehouse: api/environments/robot_warehouse.md
- Snake: api/environments/snake.md
- TSP: api/environments/tsp.md
- Wrappers: api/wrappers.md
Expand Down