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

Add minigrid docs #165

Merged
merged 3 commits into from
Nov 14, 2023
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
20 changes: 20 additions & 0 deletions docs/datasets/minigrid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
firstpage:
lastpage:
---

# MiniGrid

Dataset generated from the [MiniGrid-FourRooms environment](https://minigrid.farama.org/environments/minigrid/FourRoomsEnv/). The objective of the agent is to reach a goal position in a gridworld.
We regenerate the dataset of [D4RL](https://github.com/Farama-Foundation/D4RL/wiki/Tasks#minigrid-fourrooms) for full reproducibility, using a random policy and an expert policy that navigates straight to the goal.


```{toctree}
:hidden:
minigrid/random.md
minigrid/expert.md
```

## References

[1] Fu, Justin, et al. ‘D4RL: Datasets for Deep Data-Driven Reinforcement Learning’. CoRR, vol. abs/2004.07219, 2020, https://arxiv.org/abs/2004.07219.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ sphinx_github_changelog
myst-parser
google-cloud-storage==2.5.0
gymnasium-robotics>=1.2.1
minigrid>=2.2.0
git+https://github.com/sphinx-gallery/sphinx-gallery.git@4006662c8c1984453a247dc6d3df6260e5b00f4b#egg=sphinx_gallery
git+https://github.com/Farama-Foundation/Celshast#egg=furo
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ testing = [
"nbmake",
"gymnasium-robotics>=1.2.3",
"imageio>=2.14.1",
"minigrid>=2.2.0",
]

[project.urls]
Expand Down