Updated Citation to Neurips 23 (#443)

Farama-Foundation · Jul 22, 2024 · 97438fb · 97438fb
1 parent 7e79669
commit 97438fb
Show file tree

Hide file tree

Showing 38 changed files with 36 additions and 33 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -45,7 +45,10 @@ preferred-citation:
     given-names: Pablo Samuel
   - family-names: Terry
     given-names: Jordan
-  journal: CoRR
-  title: Minigrid
-  volume: abs/2306.13831
+  title: "Minigrid & Miniworld: Modular & Customizable Reinforcement Learning Environments for Goal-Oriented Tasks"
+  type: inproceedings
   year: 2023
+  conference:
+    name: "Neural Information Processing Systems (NeurIPS)"
+  publisher:
+    name: "Proceedings of the Conference on Neural Information Processing Systems (NeurIPS)"
diff --git a/README.md b/README.md
@@ -43,11 +43,11 @@ The original `gym-minigrid` environments were created as part of work done at [M
 To cite this project please use:
 
 ```bibtex
-@article{MinigridMiniworld23,
-  author       = {Maxime Chevalier-Boisvert and Bolun Dai and Mark Towers and Rodrigo de Lazcano and Lucas Willems and Salem Lahlou and Suman Pal and Pablo Samuel Castro and Jordan Terry},
-  title        = {Minigrid \& Miniworld: Modular \& Customizable Reinforcement Learning Environments for Goal-Oriented Tasks},
-  journal      = {CoRR},
-  volume       = {abs/2306.13831},
+@inproceedings{MinigridMiniworld23,
+  author       = {Maxime Chevalier{-}Boisvert and Bolun Dai and Mark Towers and Rodrigo Perez{-}Vicente and Lucas Willems and Salem Lahlou and Suman Pal and Pablo Samuel Castro and Jordan Terry},
+  title        = {Minigrid {\&} Miniworld: Modular {\&} Customizable Reinforcement Learning Environments for Goal-Oriented Tasks},
+  booktitle    = {Advances in Neural Information Processing Systems 36, New Orleans, LA, USA},
+  month        = {December},
   year         = {2023},
 }
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -41,11 +41,11 @@ env.close()
 To cite this project please use:
 
 ```bibtex
-@article{MinigridMiniworld23,
-  author       = {Maxime Chevalier-Boisvert and Bolun Dai and Mark Towers and Rodrigo de Lazcano and Lucas Willems and Salem Lahlou and Suman Pal and Pablo Samuel Castro and Jordan Terry},
-  title        = {Minigrid \& Miniworld: Modular \& Customizable Reinforcement Learning Environments for Goal-Oriented Tasks},
-  journal      = {CoRR},
-  volume       = {abs/2306.13831},
+@inproceedings{MinigridMiniworld23,
+  author       = {Maxime Chevalier{-}Boisvert and Bolun Dai and Mark Towers and Rodrigo Perez{-}Vicente and Lucas Willems and Salem Lahlou and Suman Pal and Pablo Samuel Castro and Jordan Terry},
+  title        = {Minigrid {\&} Miniworld: Modular {\&} Customizable Reinforcement Learning Environments for Goal-Oriented Tasks},
+  booktitle    = {Advances in Neural Information Processing Systems 36, New Orleans, LA, USA},
+  month        = {December},
   year         = {2023},
 }
 ```

diff --git a/minigrid/core/world_object.py b/minigrid/core/world_object.py
@@ -25,7 +25,6 @@
 
 
 class WorldObj:
-
     """
     Base class for grid world objects
     """

diff --git a/minigrid/envs/babyai/core/levelgen.py b/minigrid/envs/babyai/core/levelgen.py
@@ -1,6 +1,7 @@
 """
 Copied and adapted from https://github.com/mila-iqia/babyai
 """
+
 from __future__ import annotations
 
 from minigrid.core.constants import COLOR_NAMES

diff --git a/minigrid/envs/babyai/core/roomgrid_level.py b/minigrid/envs/babyai/core/roomgrid_level.py
@@ -1,6 +1,7 @@
 """
 Copied and adapted from https://github.com/mila-iqia/babyai
 """
+
 from __future__ import annotations
 
 from minigrid.core.roomgrid import RoomGrid

diff --git a/minigrid/envs/babyai/core/verifier.py b/minigrid/envs/babyai/core/verifier.py
@@ -1,6 +1,7 @@
 """
 Copied and adapted from https://github.com/mila-iqia/babyai
 """
+
 from __future__ import annotations
 
 import os

diff --git a/minigrid/envs/babyai/goto.py b/minigrid/envs/babyai/goto.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with the `Go to` instruction.
 """
+
 from __future__ import annotations
 
 from minigrid.envs.babyai.core.levelgen import LevelGen

diff --git a/minigrid/envs/babyai/open.py b/minigrid/envs/babyai/open.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with the `Open` instruction.
 """
+
 from __future__ import annotations
 
 from minigrid.core.constants import COLOR_NAMES

diff --git a/minigrid/envs/babyai/other.py b/minigrid/envs/babyai/other.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with different instructions than those in other files.
 """
+
 from __future__ import annotations
 
 from minigrid.envs.babyai.core.roomgrid_level import RoomGridLevel

diff --git a/minigrid/envs/babyai/pickup.py b/minigrid/envs/babyai/pickup.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with the `Pick up` instruction.
 """
+
 from __future__ import annotations
 
 from minigrid.envs.babyai.core.levelgen import LevelGen

diff --git a/minigrid/envs/babyai/putnext.py b/minigrid/envs/babyai/putnext.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with the `Put Next` instruction.
 """
+
 from __future__ import annotations
 
 from minigrid.envs.babyai.core.roomgrid_level import RoomGridLevel

diff --git a/minigrid/envs/babyai/unlock.py b/minigrid/envs/babyai/unlock.py
@@ -2,6 +2,7 @@
 Copied and adapted from https://github.com/mila-iqia/babyai.
 Levels described in the Baby AI ICLR 2019 submission, with the `Unlock` instruction.
 """
+
 from __future__ import annotations
 
 from minigrid.core.constants import COLOR_NAMES

diff --git a/minigrid/envs/blockedunlockpickup.py b/minigrid/envs/blockedunlockpickup.py
@@ -7,7 +7,6 @@
 
 
 class BlockedUnlockPickupEnv(RoomGrid):
-
     """
 
     ## Description

diff --git a/minigrid/envs/crossing.py b/minigrid/envs/crossing.py
@@ -11,7 +11,6 @@
 
 
 class CrossingEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/distshift.py b/minigrid/envs/distshift.py
@@ -7,7 +7,6 @@
 
 
 class DistShiftEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/doorkey.py b/minigrid/envs/doorkey.py
@@ -7,7 +7,6 @@
 
 
 class DoorKeyEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/fetch.py b/minigrid/envs/fetch.py
@@ -8,7 +8,6 @@
 
 
 class FetchEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/fourrooms.py b/minigrid/envs/fourrooms.py
@@ -7,7 +7,6 @@
 
 
 class FourRoomsEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/keycorridor.py b/minigrid/envs/keycorridor.py
@@ -6,7 +6,6 @@
 
 
 class KeyCorridorEnv(RoomGrid):
-
     """
     ## Description
 

diff --git a/minigrid/envs/lavagap.py b/minigrid/envs/lavagap.py
@@ -9,7 +9,6 @@
 
 
 class LavaGapEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/lockedroom.py b/minigrid/envs/lockedroom.py
@@ -22,7 +22,6 @@ def rand_pos(self, env):
 
 
 class LockedRoomEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/memory.py b/minigrid/envs/memory.py
@@ -10,7 +10,6 @@
 
 
 class MemoryEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/multiroom.py b/minigrid/envs/multiroom.py
@@ -16,7 +16,6 @@ def __init__(self, top, size, entryDoorPos, exitDoorPos):
 
 
 class MultiRoomEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/obstructedmaze.py b/minigrid/envs/obstructedmaze.py
@@ -7,7 +7,6 @@
 
 
 class ObstructedMazeEnv(RoomGrid):
-
     """
     ## Description
 

diff --git a/minigrid/envs/putnear.py b/minigrid/envs/putnear.py
@@ -8,7 +8,6 @@
 
 
 class PutNearEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/redbluedoors.py b/minigrid/envs/redbluedoors.py
@@ -7,7 +7,6 @@
 
 
 class RedBlueDoorEnv(MiniGridEnv):
-
     """
     ## Description
 

diff --git a/minigrid/envs/unlock.py b/minigrid/envs/unlock.py
@@ -5,7 +5,6 @@
 
 
 class UnlockEnv(RoomGrid):
-
     """
     ## Description
 

diff --git a/minigrid/envs/unlockpickup.py b/minigrid/envs/unlockpickup.py
@@ -6,7 +6,6 @@
 
 
 class UnlockPickupEnv(RoomGrid):
-
     """
     ## Description
 

diff --git a/minigrid/envs/wfc/wfclogic/adjacency.py b/minigrid/envs/wfc/wfclogic/adjacency.py
@@ -1,4 +1,5 @@
 """Convert input data to adjacency information. Implementation based on https://github.com/ikarth/wfc_2019f"""
+
 from __future__ import annotations
 
 import numpy as np

diff --git a/minigrid/envs/wfc/wfclogic/control.py b/minigrid/envs/wfc/wfclogic/control.py
@@ -1,4 +1,5 @@
 """Main WFC execution function. Implementation based on https://github.com/ikarth/wfc_2019f"""
+
 from __future__ import annotations
 
 import logging

diff --git a/minigrid/envs/wfc/wfclogic/solver.py b/minigrid/envs/wfc/wfclogic/solver.py
@@ -1,4 +1,5 @@
 """Wave Function Collapse solver. Implementation based on https://github.com/ikarth/wfc_2019f"""
+
 from __future__ import annotations
 
 import itertools

diff --git a/minigrid/envs/wfc/wfclogic/tiles.py b/minigrid/envs/wfc/wfclogic/tiles.py
@@ -1,4 +1,5 @@
 """Breaks an image into consituant tiles. Implementation based on https://github.com/ikarth/wfc_2019f"""
+
 from __future__ import annotations
 
 import numpy as np

diff --git a/minigrid/envs/wfc/wfclogic/utilities.py b/minigrid/envs/wfc/wfclogic/utilities.py
@@ -1,4 +1,5 @@
 """Utility data and functions for WFC. Implementation based on https://github.com/ikarth/wfc_2019f"""
+
 from __future__ import annotations
 
 import collections

diff --git a/minigrid/wrappers.py b/minigrid/wrappers.py
@@ -1,8 +1,6 @@
 from __future__ import annotations
 
 import math
-import operator
-from functools import reduce
 from typing import Any
 
 import gymnasium as gym
@@ -596,7 +594,9 @@ def observation(self, obs):
             ), f"mission string too long ({len(mission)} chars)"
             mission = mission.lower()
 
-            str_array = np.zeros(shape=(self.maxStrLen, self.numCharCodes), dtype="uint8")
+            str_array = np.zeros(
+                shape=(self.maxStrLen, self.numCharCodes), dtype="uint8"
+            )
             # as `numCharCodes` < 255 then we can use `uint8`
 
             for idx, ch in enumerate(mission):

diff --git a/tests/test_wfc/test_wfc_adjacency.py b/tests/test_wfc/test_wfc_adjacency.py
@@ -1,4 +1,5 @@
 """Convert input data to adjacency information"""
+
 from __future__ import annotations
 
 import numpy as np

diff --git a/tests/test_wfc/test_wfc_tiles.py b/tests/test_wfc/test_wfc_tiles.py
@@ -1,4 +1,5 @@
 """Breaks an image into consituant tiles."""
+
 from __future__ import annotations
 
 from minigrid.envs.wfc.wfclogic import tiles as wfc_tiles

diff --git a/tests/utils.py b/tests/utils.py
@@ -1,4 +1,5 @@
 """Finds all the specs that we can test with"""
+
 from __future__ import annotations
 
 from importlib.util import find_spec