Update Minigrid with pre-commit, fix ci, and clean up (#465)

.github/ISSUE_TEMPLATE/bug.md

@@ -24,4 +24,4 @@ Add any other context about the problem here.
 
 ### Checklist
 
-- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/MiniGrid/issues) in the repo (**required**)
+- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/MiniGrid/issues) in the repo (**required**)

.github/ISSUE_TEMPLATE/proposal.md

@@ -6,7 +6,7 @@ title: "[Proposal] Proposal title"
 
 
 
-### Proposal 
+### Proposal
 
 A clear and concise description of the proposal.
 

.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Look for GitHub Actions workflows in the `root` directory
+    directory: "/"
+    # Check the for updates once a week
+    schedule:
+      interval: "weekly"

.github/docker/py-old.Dockerfile

@@ -0,0 +1,16 @@
+# A Dockerfile that sets up a full Gym install with test dependencies
+ARG PYTHON_VERSION
+FROM python:$PYTHON_VERSION
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+
+RUN apt-get -y update \
+    && apt-get install --no-install-recommends -y \
+    xvfb
+
+COPY ../.. /usr/local/minigrid/
+WORKDIR /usr/local/minigrid/
+
+RUN pip install .[wfc,testing] gymnasium==0.29.1 numpy==1.26.4
+
+ENTRYPOINT ["/usr/local/minigrid/.github/docker/docker_entrypoint"]

py.Dockerfile

@@ -8,12 +8,9 @@ RUN apt-get -y update \
     && apt-get install --no-install-recommends -y \
     xvfb
 
-COPY . /usr/local/minigrid/
+COPY ../.. /usr/local/minigrid/
 WORKDIR /usr/local/minigrid/
 
-RUN pip install .[wfc,testing] --no-cache-dir
-
-RUN ["chmod", "+x", "/usr/local/minigrid/docker_entrypoint"]
-
-ENTRYPOINT ["/usr/local/minigrid/docker_entrypoint"]
+RUN pip install .[wfc,testing]
 
+ENTRYPOINT ["/usr/local/minigrid/.github/docker/docker_entrypoint"]

.github/stale.yml

@@ -59,4 +59,4 @@ only: issues
 
 # issues:
 #   exemptLabels:
-#     - confirmed
+#     - confirmed

.github/workflows/build-docs-dev.yml

@@ -46,4 +46,4 @@ jobs:
         with:
           folder: _build
           target-folder: main
-          clean: false
+          clean: false

.github/workflows/build-docs-version.yml

@@ -59,4 +59,4 @@ jobs:
           folder: _build
           clean-exclude: |
             *.*.*/
-            main
+            main

.github/workflows/build.yml

@@ -1,22 +0,0 @@
-name: build
-on: [pull_request, push]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-    steps:
-      - uses: actions/checkout@v2
-      - run: |
-           docker build -f py.Dockerfile \
-             --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
-             --tag minigrid-docker .      
-      - name: Run tests
-        run: docker run minigrid-docker pytest --ignore tests/test_wfc
-      - name: Run doctest
-        run: docker run minigrid-docker pytest --doctest-modules minigrid/

.github/workflows/manual-build-docs-version.yml

@@ -71,4 +71,4 @@ jobs:
           folder: _build
           clean-exclude: |
             *.*.*/
-            main
+            main

.github/workflows/pre-commit.yml

@@ -17,4 +17,4 @@ jobs:
       - uses: actions/setup-python@v5
       - run: pip install pre-commit
       - run: pre-commit --version
-      - run: pre-commit run --all-files
+      - run: pre-commit run --all-files

.github/workflows/build-publish.yml

@@ -8,10 +8,6 @@
 name: build-publish
 
 on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
   release:
     types: [published]
 
@@ -21,26 +17,17 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.x'
+          python-version: '3.10'
       - name: Install pypa/build
-        run: >-
-          python -m
-          pip install -U
-          build
+        run: python -m pip install -U build
       - name: Build a binary wheel and a source tarball
-        run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
+        run: python -m build --sdist --wheel --outdir dist/ .
       - name: Store wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: dist
 
@@ -51,7 +38,7 @@ jobs:
     if: github.event_name == 'release' && github.event.action == 'published'
     steps:
       - name: Download dists
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: artifact
           path: dist

.github/workflows/pytest.yml

@@ -0,0 +1,33 @@
+name: build
+on: [pull_request, push]
+
+permissions:
+  contents: read
+
+jobs:
+  build-latest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+           docker build -f .github/docker/py.Dockerfile \
+             --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
+             --tag minigrid-docker .
+      - name: Run tests
+        run: docker run minigrid-docker pytest
+      - name: Run doctest
+        run: docker run minigrid-docker pytest --doctest-modules minigrid/
+
+  build-old:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          docker build -f .github/docker/py-old.Dockerfile \
+             --build-arg PYTHON_VERSION="3.10" \
+             --tag minigrid-docker .
+      - name: Run tests
+        run: docker run minigrid-docker pytest

.pre-commit-config.yaml

@@ -1,17 +1,33 @@
 ---
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-ast
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: detect-private-key
+      - id: debug-statements
   - repo: https://github.com/python/black
-    rev: 23.12.1
+    rev: 24.10.0
     hooks:
       - id: black
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         args:
           - --ignore-words-list=linz
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
+    rev: 7.1.1
     hooks:
       - id: flake8
         args:
@@ -36,18 +52,18 @@ repos:
 #          - --convention=google
 #        additional_dependencies: ["toml"]
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args: ["--py37-plus"]
-  - repo: local
-    hooks:
-      - id: pyright
-        name: pyright
-        entry: pyright
-        language: node
-        pass_filenames: false
-        types: [python]
-        additional_dependencies: ["pyright@1.1.383"]
-        args:
-          - --project=pyproject.toml
+#  - repo: local
+#    hooks:
+#      - id: pyright
+#        name: pyright
+#        entry: pyright
+#        language: node
+#        pass_filenames: false
+#        types: [python]
+#        additional_dependencies: ["pyright@1.1.383"]
+#        args:
+#          - --project=pyproject.toml

CNAME

@@ -1 +0,0 @@
-minigrid.farama.org

CODE_OF_CONDUCT.rst

@@ -65,4 +65,3 @@ Attribution
 -----------
 This Code of Conduct is adapted from `Python's Code of Conduct <https://www.python.org/psf/conduct/>`_, which is under a `Creative Commons License
 <https://creativecommons.org/licenses/by-sa/3.0/>`_.
-

docs/_scripts/gen_env_docs.py

@@ -4,17 +4,20 @@ import os
 import re
 from itertools import chain
 
-from gymnasium.envs.registration import registry
+import gymnasium
 from tqdm import tqdm
 
+import minigrid
 from utils import env_name_format, trim
 
+gymnasium.register_envs(minigrid)
+
 readme_path = os.path.join(
     os.path.dirname(os.path.dirname(os.path.dirname(__file__))),
     "README.md",
 )
 
-all_envs = list(registry.values())
+all_envs = list(gymnasium.registry.values())
 
 filtered_envs_by_type = {}
 env_names = []
@@ -120,7 +123,6 @@ title: {formatted_env_name}
 |---|---|
 | Action Space | `{re.sub(' +', ' ', action_space_table)}` |
 | Observation Space | `{re.sub(' +', ' ', observation_space_table)}` |
-| Reward Range | `{env.reward_range}` |
 | Creation | `gymnasium.make("{env_spec.id}")` |
 """
 

docs/_scripts/gen_gifs.py

@@ -7,6 +7,10 @@ import gymnasium
 from PIL import Image
 from tqdm import tqdm
 
+import minigrid
+
+gymnasium.register_envs(minigrid)
+
 # snake to camel case: https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case # noqa: E501
 pattern = re.compile(r"(?<!^)(?=[A-Z])")
 
@@ -22,7 +26,7 @@ os.makedirs(output_dir, exist_ok=True)
 envs_completed = []
 
 # iterate through all envspecs
-for env_spec in tqdm(gymnasium.envs.registry.values()):
+for env_spec in tqdm(gymnasium.registry.values()):
     # minigrid.envs:Env or minigrid.envs.babyai:Env
     if not isinstance(env_spec.entry_point, str):
         continue
@@ -44,6 +48,9 @@ for env_spec in tqdm(gymnasium.envs.registry.values()):
         # try catch in case missing some installs
         try:
             env = gymnasium.make(env_spec.id, render_mode="rgb_array")
+            env.reset(seed=123)
+            env.action_space.seed(123)
+
             # the gymnasium needs to be rgb renderable
             if not ("rgb_array" in env.metadata["render_modes"]):
                 continue

docs/_static/img/minigrid-white.svg

@@ -57,22 +57,22 @@
    inkscape:window-maximized="1"
    inkscape:current-layer="layer3"
    showguides="true">
-   
-   
-   
-   
+
+
+
+
    <inkscape:grid
    type="xygrid"
    id="grid7671"
    dotted="true" />
-   
-   
-   
-   
-   
-   
-   
-   
+
+
+
+
+
+
+
+
   </sodipodi:namedview>
   <g
    id="layer3"

docs/_static/img/minigrid.svg

@@ -57,22 +57,22 @@
    inkscape:window-maximized="1"
    inkscape:current-layer="layer3"
    showguides="true">
-   
-   
-   
-   
+
+
+
+
    <inkscape:grid
    type="xygrid"
    id="grid7671"
    dotted="true" />
-   
-   
-   
-   
-   
-   
-   
-   
+
+
+
+
+
+
+
+
   </sodipodi:namedview>
   <g
    id="layer3"

docs/api/wrapper.md

@@ -14,8 +14,8 @@ field which can be used as an optional compass. Using dictionaries makes it
 easy for you to add additional information to observations
 if you need to, without having to encode everything into a single tensor.
 
-There are a variety of wrappers to change the observation format available in [minigrid/wrappers.py](/minigrid/wrappers.py). 
-If your RL code expects one single tensor for observations, take a look at `FlatObsWrapper`. 
+There are a variety of wrappers to change the observation format available in [minigrid/wrappers.py](/minigrid/wrappers.py).
+If your RL code expects one single tensor for observations, take a look at `FlatObsWrapper`.
 There is also an `ImgObsWrapper` that gets rid of the 'mission' field in observations, leaving only the image field tensor.
 
 Please note that the default observation format is a partially observable view of the environment using a
@@ -36,4 +36,4 @@ obs, _ = env.reset() # This now produces an RGB tensor only
 ```{toctree}
 :hidden:
 wrappers
-```
+```

docs/content/create_env_tutorial.md

@@ -6,7 +6,7 @@ firstpage:
 
 # Tutorial on Creating Environments
 
-In this tutorial, we will go through the process of creating a new environment. 
+In this tutorial, we will go through the process of creating a new environment.
 
 ## Boilerplate Code
 
@@ -55,7 +55,7 @@ Then, in the `__init__` function, we pass the required arguments to the parent c
 
 ## Generate the grid-world
 
-To create your own grid-world environment we override the function `_gen_grid`. We can see from the `MiniGridEnv` class 
+To create your own grid-world environment we override the function `_gen_grid`. We can see from the `MiniGridEnv` class
 
 ```python
 # MiniGridEnv._gen_grid
@@ -64,7 +64,7 @@ def _gen_grid(self, width, height):
     pass
 ```
 
-`_gen_grid` takes in two inputs `width` and `height`, which are used to specify the size of the environment. 
+`_gen_grid` takes in two inputs `width` and `height`, which are used to specify the size of the environment.
 
 ### Create World
 
@@ -207,7 +207,7 @@ class SimpleEnv(MiniGridEnv):
         # Generate vertical separation wall
         for i in range(0, height):
             self.grid.set(5, i, Wall())
-        
+
         # Place the door and key
         self.grid.set(5, 6, Door(COLOR_NAMES[0], is_locked=True))
         self.grid.set(3, 6, Key(COLOR_NAMES[0]))
@@ -232,7 +232,7 @@ def main():
     manual_control = ManualControl(env, seed=42)
     manual_control.start()
 
-    
+
 if __name__ == "__main__":
     main()
 ```

docs/content/installation.md

@@ -25,4 +25,4 @@ If you want to install the package in [development mode](https://setuptools.pypa
 python3 -m pip install -e .
 ```
 
-An installation in development mode (i.e., an editable install) is useful if you want to modify the source code of `minigrid` and have your changes take effect immediately.
+An installation in development mode (i.e., an editable install) is useful if you want to modify the source code of `minigrid` and have your changes take effect immediately.

docs/content/publications.md

@@ -41,7 +41,7 @@ List of publications & submissions using Minigrid or BabyAI (please open a pull
 - [Working Memory Graphs](https://arxiv.org/abs/1911.07141) (MSR, Nov 2019)
 - [Fast Task-Adaptation for Tasks Labeled Using Natural Language in Reinforcement Learning](https://arxiv.org/pdf/1910.04040.pdf) (Oct 2019, University of Antwerp)
 - [Generalization in Reinforcement Learning with Selective Noise Injection and Information Bottleneck](https://arxiv.org/abs/1910.12911) (MSR, NeurIPS, Oct 2019)
-- [Recurrent Independent Mechanisms](https://arxiv.org/pdf/1909.10893.pdf) (Mila, Sept 2019) 
+- [Recurrent Independent Mechanisms](https://arxiv.org/pdf/1909.10893.pdf) (Mila, Sept 2019)
 - [Learning Effective Subgoals with Multi-Task Hierarchical Reinforcement Learning](http://surl.tirl.info/proceedings/SURL-2019_paper_10.pdf) (Tsinghua University, August 2019)
 - [Mastering emergent language: learning to guide in simulated navigation](https://arxiv.org/abs/1908.05135) (University of Amsterdam, Aug 2019)
 - [Transfer Learning by Modeling a Distribution over Policies](https://arxiv.org/abs/1906.03574) (Mila, June 2019)
@@ -61,4 +61,3 @@ List of publications & submissions using Minigrid or BabyAI (please open a pull
 - [BabyAI: First Steps Towards Grounded Language Learning With a Human In the Loop](https://arxiv.org/abs/1810.08272) (Mila, ICLR, Oct 2018)
 
 This environment has been built as part of work done at [Mila](https://mila.quebec). The Dynamic obstacles environment has been added as part of work done at [IAS in TU Darmstadt](https://www.ias.informatik.tu-darmstadt.de/) and the University of Genoa for mobile robot navigation with dynamic obstacles.
-

docs/content/training.md

@@ -8,7 +8,7 @@ firstpage:
 
 The environments in the Minigrid library can be trained easily using [StableBaselines3](https://stable-baselines3.readthedocs.io/en/master/). In this tutorial we show how a PPO agent can be trained on the `MiniGrid-Empty-16x16-v0` environment.
 
-## Create Custom Feature Extractor 
+## Create Custom Feature Extractor
 
 Although `StableBaselines3` is fully compatible with `Gymnasium`-based environments (which includes Minigrid), the default CNN architecture does not directly support the Minigrid observation space. Thus, to train an agent on Minigrid environments, we need to create a custom feature extractor. This can be done by creating a feature extractor class that inherits from `stable_baselines3.common.torch_layers.BaseFeaturesExtractor`
 
@@ -64,4 +64,4 @@ By default the observation of Minigrid environments are dictionaries. Since the
 
 ## Further Reading
 
-One can also pass dictionary observations to StableBaseline3 policies, for a walkthrough the process of doing so see [here](https://stable-baselines3.readthedocs.io/en/master/guide/custom_policy.html#multiple-inputs-and-dictionary-observations). An implementation utilizing this functionality can be found [here](https://github.com/BolunDai0216/MinigridMiniworldTransfer/blob/main/minigrid_gotoobj_train.py).
+One can also pass dictionary observations to StableBaseline3 policies, for a walkthrough the process of doing so see [here](https://stable-baselines3.readthedocs.io/en/master/guide/custom_policy.html#multiple-inputs-and-dictionary-observations). An implementation utilizing this functionality can be found [here](https://github.com/BolunDai0216/MinigridMiniworldTransfer/blob/main/minigrid_gotoobj_train.py).

docs/environments/minigrid/index.md

@@ -41,4 +41,4 @@ RedBlueDoorEnv
 UnlockEnv
 UnlockPickupEnv
 
-```
+```

docs/index.md

@@ -85,4 +85,3 @@ environments/wfc/index
 release_notes
 Github <https://github.com/Farama-Foundation/MiniGrid>
 ```
-

docs/release_notes.md

@@ -9,4 +9,4 @@ title: Release Notes
     :github: https://github.com/Farama-Foundation/Minigrid/releases
     :pypi: https://pypi.org/project/minigrid/
     :changelog-url:
-```
+```