index.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803
  1. <!doctype html>
  2. <html class="no-js" lang="en" data-content_root="../">
  3. <head><meta charset="utf-8"/>
  4. <meta name="viewport" content="width=device-width,initial-scale=1"/>
  5. <meta name="color-scheme" content="light dark">
  6. <meta name="description" content="Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.">
  7. <meta property="og:title" content="MiniGrid Documentation" />
  8. <meta property="og:type" content="website" />
  9. <meta property="og:description" content="Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid." />
  10. <meta property="og:url" content="https://minigrid.farama.org/genindex.html" /><meta property="og:image" content="https://minigrid.farama.org//_static/img/minigrid-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="../search/" />
  11. <link rel="canonical" href="https://minigrid.farama.org/genindex.html" />
  12. <link rel="shortcut icon" href="../_static/minigrid-favicon.png"/><!-- Generated with Sphinx 7.2.6 and Furo 2023.08.19.dev1 --><title>Index - MiniGrid Documentation</title>
  13. <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
  14. <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=3e7f4c72" />
  15. <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=49cbaffd" />
  16. <style>
  17. body {
  18. --color-code-background: #f8f8f8;
  19. --color-code-foreground: black;
  20. }
  21. @media not print {
  22. body[data-theme="dark"] {
  23. --color-code-background: #202020;
  24. --color-code-foreground: #d0d0d0;
  25. }
  26. @media (prefers-color-scheme: dark) {
  27. body:not([data-theme="light"]) {
  28. --color-code-background: #202020;
  29. --color-code-foreground: #d0d0d0;
  30. }
  31. }
  32. }
  33. </style></head>
  34. <body>
  35. <header class="farama-header" aria-label="Farama header">
  36. <div class="farama-header__container">
  37. <div class="farama-header__left--mobile">
  38. <label class="nav-overlay-icon" for="__navigation">
  39. <div class="visually-hidden">Toggle site navigation sidebar</div>
  40. <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
  41. <defs></defs>
  42. <line x1="0.5" y1="4" x2="23.5" y2="4"></line>
  43. <line x1="0.232" y1="12" x2="23.5" y2="12"></line>
  44. <line x1="0.232" y1="20" x2="23.5" y2="20"></line>
  45. </svg>
  46. </label>
  47. </div>
  48. <div class="farama-header__left farama-header__center--mobile">
  49. <a href="../">
  50. <img class="farama-header__logo only-light" src="../_static/img/minigrid.svg" alt="Light Logo"/>
  51. <img class="farama-header__logo only-dark" src="../_static/img/minigrid-white.svg" alt="Dark Logo"/>
  52. <span class="farama-header__title">MiniGrid Documentation</span>
  53. </a>
  54. </div>
  55. <div class="farama-header__right">
  56. <div class="farama-header-menu">
  57. <button class="farama-header-menu__btn" aria-label="Open Farama Menu" aria-expanded="false" aria-haspopup="true" aria-controls="farama-menu">
  58. <img class="farama-black-logo-invert" src="../_static/img/farama-logo-header.svg">
  59. <svg viewBox="0 0 24 24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
  60. <polyline style="stroke-linecap: round; stroke-linejoin: round; fill: none; stroke-width: 2px;" points="1 7 12 18 23 7"></polyline>
  61. </svg>
  62. </button>
  63. <div class="farama-header-menu-container farama-hidden" aria-hidden="true" id="farama-menu">
  64. <div class="farama-header-menu__header">
  65. <a href="https://farama.org">
  66. <img class="farama-header-menu__logo farama-white-logo-invert" src="../_static/img/farama_solid_white.svg" alt="Farama Foundation logo">
  67. <span>Farama Foundation</span>
  68. </a>
  69. <div class="farama-header-menu-header__right">
  70. <button id="farama-close-menu">
  71. <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor"
  72. stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="icon-close">
  73. <line x1="3" y1="21" x2="21" y2="3"></line>
  74. <line x1="3" y1="3" x2="21" y2="21"></line>
  75. </svg>
  76. </button>
  77. </div>
  78. </div>
  79. <div class="farama-header-menu__body">
  80. <!-- Response from farama.org/api/projects.json -->
  81. </div>
  82. </div>
  83. </div>
  84. </div>
  85. </div>
  86. </header>
  87. <script>
  88. document.body.dataset.theme = localStorage.getItem("theme") || "auto";
  89. </script>
  90. <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  91. <symbol id="svg-toc" viewBox="0 0 24 24">
  92. <title>Contents</title>
  93. <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
  94. <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
  95. </svg>
  96. </symbol>
  97. <symbol id="svg-menu" viewBox="0 0 24 24">
  98. <title>Menu</title>
  99. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
  100. stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
  101. <line x1="3" y1="12" x2="21" y2="12"></line>
  102. <line x1="3" y1="6" x2="21" y2="6"></line>
  103. <line x1="3" y1="18" x2="21" y2="18"></line>
  104. </svg>
  105. </symbol>
  106. <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  107. <title>Expand</title>
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
  109. stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
  110. <polyline points="9 18 15 12 9 6"></polyline>
  111. </svg>
  112. </symbol>
  113. <symbol id="svg-sun" viewBox="0 0 24 24">
  114. <title>Light mode</title>
  115. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
  116. stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
  117. <circle cx="12" cy="12" r="5"></circle>
  118. <line x1="12" y1="1" x2="12" y2="3"></line>
  119. <line x1="12" y1="21" x2="12" y2="23"></line>
  120. <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
  121. <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
  122. <line x1="1" y1="12" x2="3" y2="12"></line>
  123. <line x1="21" y1="12" x2="23" y2="12"></line>
  124. <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
  125. <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
  126. </svg>
  127. </symbol>
  128. <symbol id="svg-moon" viewBox="0 0 24 24">
  129. <title>Dark mode</title>
  130. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
  131. stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
  132. <path stroke="none" d="M0 0h24v24H0z" fill="none" />
  133. <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
  134. </svg>
  135. </symbol>
  136. <symbol id="svg-sun-half" viewBox="0 0 24 24">
  137. <title>Auto light/dark mode</title>
  138. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
  139. stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
  140. <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
  141. <circle cx="12" cy="12" r="9" />
  142. <path d="M13 12h5" />
  143. <path d="M13 15h4" />
  144. <path d="M13 18h1" />
  145. <path d="M13 9h4" />
  146. <path d="M13 6h1" />
  147. </svg>
  148. </symbol>
  149. </svg>
  150. <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
  151. <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
  152. <label class="overlay sidebar-overlay" for="__navigation">
  153. <div class="visually-hidden">Hide navigation sidebar</div>
  154. </label>
  155. <label class="overlay toc-overlay" for="__toc">
  156. <div class="visually-hidden">Hide table of contents sidebar</div>
  157. </label>
  158. <div class="page">
  159. <!--<header class="mobile-header">
  160. <div class="header-left">
  161. <label class="nav-overlay-icon" for="__navigation">
  162. <div class="visually-hidden">Toggle site navigation sidebar</div>
  163. <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
  164. </label>
  165. </div>
  166. <div class="header-center">
  167. <a href="../"><div class="brand">MiniGrid Documentation</div></a>
  168. </div>
  169. <div class="header-right">
  170. <div class="theme-toggle-container theme-toggle-header">
  171. <button class="theme-toggle">
  172. <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  173. <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
  174. <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
  175. <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
  176. </button>
  177. </div>
  178. <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
  179. <div class="visually-hidden">Toggle table of contents sidebar</div>
  180. <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
  181. </label>
  182. </div>
  183. </header>-->
  184. <aside class="sidebar-drawer">
  185. <div class="sidebar-container">
  186. <div class="sidebar-sticky"><a class="farama-sidebar__title" href="../">
  187. <img class="farama-header__logo only-light" src="../_static/img/minigrid.svg" alt="Light Logo"/>
  188. <img class="farama-header__logo only-dark" src="../_static/img/minigrid-white.svg" alt="Dark Logo"/>
  189. <span class="farama-header__title">MiniGrid Documentation</span>
  190. </a><form class="sidebar-search-container" method="get" action="../search/" role="search">
  191. <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  192. <input type="hidden" name="check_keywords" value="yes">
  193. <input type="hidden" name="area" value="default">
  194. </form>
  195. <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  196. <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
  197. <ul>
  198. <li class="toctree-l1"><a class="reference internal" href="../content/basic_usage/">Basic Usage</a></li>
  199. <li class="toctree-l1"><a class="reference internal" href="../content/basic_usage/#installation">Installation</a></li>
  200. <li class="toctree-l1"><a class="reference internal" href="../content/publications/">List of Publications</a></li>
  201. <li class="toctree-l1"><a class="reference internal" href="../content/create_env_tutorial/">Tutorial on Creating Environments</a></li>
  202. <li class="toctree-l1"><a class="reference internal" href="../content/training/">Training Minigrid Environments</a></li>
  203. </ul>
  204. <p class="caption" role="heading"><span class="caption-text">Wrappers</span></p>
  205. <ul>
  206. <li class="toctree-l1 has-children"><a class="reference internal" href="../api/wrapper/">Wrapper</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Wrapper</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
  207. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/">Action Bonus</a></li>
  208. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#dict-observation-space">Dict Observation Space</a></li>
  209. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#direction-obs">Direction Obs</a></li>
  210. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#flatobs">FlatObs</a></li>
  211. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#fully-obs">Fully Obs</a></li>
  212. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#image-observation">Image Observation</a></li>
  213. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#no-death">No Death</a></li>
  214. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#observation">Observation</a></li>
  215. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#one-hot-partial-obs">One Hot Partial Obs</a></li>
  216. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#reseed">Reseed</a></li>
  217. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#rgb-img-obs">RGB Img Obs</a></li>
  218. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#rgb-partial-img-obs">RGB Partial Img Obs</a></li>
  219. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#position-bonus">Position Bonus</a></li>
  220. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#stochastic-action">Stochastic Action</a></li>
  221. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#symbolic-obs">Symbolic Obs</a></li>
  222. <li class="toctree-l2"><a class="reference internal" href="../api/wrappers/#view-size">View Size</a></li>
  223. </ul>
  224. </li>
  225. </ul>
  226. <p class="caption" role="heading"><span class="caption-text">Environments</span></p>
  227. <ul>
  228. <li class="toctree-l1 has-children"><a class="reference internal" href="../environments/minigrid/">Minigrid Environments</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Minigrid Environments</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
  229. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/BlockedUnlockPickupEnv/">Blocked Unlock Pickup</a></li>
  230. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/CrossingEnv/">Crossing</a></li>
  231. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/DistShiftEnv/">Dist Shift</a></li>
  232. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/DoorKeyEnv/">Door Key</a></li>
  233. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/DynamicObstaclesEnv/">Dynamic Obstacles</a></li>
  234. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/EmptyEnv/">Empty</a></li>
  235. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/FetchEnv/">Fetch</a></li>
  236. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/FourRoomsEnv/">Four Rooms</a></li>
  237. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/GoToDoorEnv/">Go To Door</a></li>
  238. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/GoToObjectEnv/">Go To Object</a></li>
  239. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/KeyCorridorEnv/">Key Corridor</a></li>
  240. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/LavaGapEnv/">Lava Gap</a></li>
  241. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/LockedRoomEnv/">Locked Room</a></li>
  242. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/MemoryEnv/">Memory</a></li>
  243. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/MultiRoomEnv/">Multi Room</a></li>
  244. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/ObstructedMaze_1Dlhb/">Obstructed Maze Dlhb</a></li>
  245. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/ObstructedMaze_Full/">Obstructed Maze Full</a></li>
  246. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/PlaygroundEnv/">Playground</a></li>
  247. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/PutNearEnv/">Put Near</a></li>
  248. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/RedBlueDoorEnv/">Red Blue Door</a></li>
  249. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/UnlockEnv/">Unlock</a></li>
  250. <li class="toctree-l2"><a class="reference internal" href="../environments/minigrid/UnlockPickupEnv/">Unlock Pickup</a></li>
  251. </ul>
  252. </li>
  253. <li class="toctree-l1 has-children"><a class="reference internal" href="../environments/babyai/">BabyAI Environments</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of BabyAI Environments</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
  254. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToRedBallGrey/">Go To Red Ball Grey</a></li>
  255. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToRedBall/">Go To Red Ball</a></li>
  256. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToRedBallNoDists/">Go To Red Ball No Dists</a></li>
  257. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToObj/">Go To Obj</a></li>
  258. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToLocal/">Go To Local</a></li>
  259. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoTo/">Go To</a></li>
  260. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToImpUnlock/">Go To Imp Unlock</a></li>
  261. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToSeq/">Go To Seq</a></li>
  262. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToRedBlueBall/">Go To Red Blue Ball</a></li>
  263. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToDoor/">Go To Door</a></li>
  264. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/GoToObjDoor/">Go To Obj Door</a></li>
  265. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/Open/">Open</a></li>
  266. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/OpenRedDoor/">Open Red Door</a></li>
  267. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/OpenDoor/">Open Door</a></li>
  268. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/OpenTwoDoors/">Open Two Doors</a></li>
  269. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/OpenDoorsOrder/">Open Doors Order</a></li>
  270. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/Pickup/">Pickup</a></li>
  271. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/UnblockPickup/">Unblock Pickup</a></li>
  272. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/PickupLoc/">Pickup Loc</a></li>
  273. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/PickupDist/">Pickup Dist</a></li>
  274. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/PickupAbove/">Pickup Above</a></li>
  275. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/PutNextLocal/">Put Next Local</a></li>
  276. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/PutNext/">Put Next</a></li>
  277. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/Unlock/">Unlock</a></li>
  278. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/UnlockLocal/">Unlock Local</a></li>
  279. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/KeyInBox/">Key In Box</a></li>
  280. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/UnlockPickup/">Unlock Pickup</a></li>
  281. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/BlockedUnlockPickup/">Blocked Unlock Pickup</a></li>
  282. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/UnlockToUnlock/">Unlock To Unlock</a></li>
  283. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/ActionObjDoor/">Action Obj Door</a></li>
  284. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/FindObjS5/">Find Obj</a></li>
  285. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/KeyCorridor/">Key Corridor</a></li>
  286. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/OneRoomS8/">One Room</a></li>
  287. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/MoveTwoAcross/">Move Two Across</a></li>
  288. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/Synth/">Synth</a></li>
  289. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/SynthLoc/">Synth Loc</a></li>
  290. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/SynthSeq/">Synth Seq</a></li>
  291. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/MiniBossLevel/">Mini Boss Level</a></li>
  292. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/BossLevel/">Boss Level</a></li>
  293. <li class="toctree-l2"><a class="reference internal" href="../environments/babyai/BossLevelNoUnlock/">Boss Level No Unlock</a></li>
  294. </ul>
  295. </li>
  296. </ul>
  297. <p class="caption" role="heading"><span class="caption-text">Development</span></p>
  298. <ul>
  299. <li class="toctree-l1"><a class="reference internal" href="../release_notes/">Release Notes</a></li>
  300. <li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
  301. </ul>
  302. </div>
  303. </div>
  304. </div>
  305. </div>
  306. </aside>
  307. <div class="main-container">
  308. <div class="main">
  309. <div class="content">
  310. <div class="article-container">
  311. <a href="#" class="back-to-top muted-link">
  312. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
  313. <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
  314. </svg>
  315. <span>Back to top</span>
  316. </a>
  317. <div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
  318. <button class="theme-toggle" title="Toggle color theme">
  319. <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  320. <svg class="theme-icon-when-auto">
  321. <use href="#svg-sun-half"></use>
  322. </svg>
  323. <svg class="theme-icon-when-dark">
  324. <use href="#svg-moon"></use>
  325. </svg>
  326. <svg class="theme-icon-when-light">
  327. <use href="#svg-sun"></use>
  328. </svg>
  329. </button>
  330. </div>
  331. <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
  332. <div class="visually-hidden">Toggle table of contents sidebar</div>
  333. <i class="icon"><svg>
  334. <use href="#svg-toc"></use>
  335. </svg></i>
  336. </label>
  337. </div>
  338. <article role="main">
  339. <section class="genindex-section">
  340. <h1 id="index">Index</h1>
  341. <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#V"><strong>V</strong></a></div>
  342. </section>
  343. <section id="A" class="genindex-section">
  344. <h2>A</h2>
  345. <table style="width: 100%" class="indextable genindextable"><tr>
  346. <td style="width: 33%; vertical-align: top;"><ul>
  347. <li><a href="../api/wrappers/#minigrid.wrappers.ActionBonus">ActionBonus (class in minigrid.wrappers)</a>
  348. </li>
  349. </ul></td>
  350. </tr></table>
  351. </section>
  352. <section id="D" class="genindex-section">
  353. <h2>D</h2>
  354. <table style="width: 100%" class="indextable genindextable"><tr>
  355. <td style="width: 33%; vertical-align: top;"><ul>
  356. <li><a href="../api/wrappers/#minigrid.wrappers.DictObservationSpaceWrapper">DictObservationSpaceWrapper (class in minigrid.wrappers)</a>
  357. </li>
  358. </ul></td>
  359. <td style="width: 33%; vertical-align: top;"><ul>
  360. <li><a href="../api/wrappers/#minigrid.wrappers.DirectionObsWrapper">DirectionObsWrapper (class in minigrid.wrappers)</a>
  361. </li>
  362. </ul></td>
  363. </tr></table>
  364. </section>
  365. <section id="F" class="genindex-section">
  366. <h2>F</h2>
  367. <table style="width: 100%" class="indextable genindextable"><tr>
  368. <td style="width: 33%; vertical-align: top;"><ul>
  369. <li><a href="../api/wrappers/#minigrid.wrappers.FlatObsWrapper">FlatObsWrapper (class in minigrid.wrappers)</a>
  370. </li>
  371. </ul></td>
  372. <td style="width: 33%; vertical-align: top;"><ul>
  373. <li><a href="../api/wrappers/#minigrid.wrappers.FullyObsWrapper">FullyObsWrapper (class in minigrid.wrappers)</a>
  374. </li>
  375. </ul></td>
  376. </tr></table>
  377. </section>
  378. <section id="I" class="genindex-section">
  379. <h2>I</h2>
  380. <table style="width: 100%" class="indextable genindextable"><tr>
  381. <td style="width: 33%; vertical-align: top;"><ul>
  382. <li><a href="../api/wrappers/#minigrid.wrappers.ImgObsWrapper">ImgObsWrapper (class in minigrid.wrappers)</a>
  383. </li>
  384. </ul></td>
  385. </tr></table>
  386. </section>
  387. <section id="N" class="genindex-section">
  388. <h2>N</h2>
  389. <table style="width: 100%" class="indextable genindextable"><tr>
  390. <td style="width: 33%; vertical-align: top;"><ul>
  391. <li><a href="../api/wrappers/#minigrid.wrappers.NoDeath">NoDeath (class in minigrid.wrappers)</a>
  392. </li>
  393. </ul></td>
  394. </tr></table>
  395. </section>
  396. <section id="O" class="genindex-section">
  397. <h2>O</h2>
  398. <table style="width: 100%" class="indextable genindextable"><tr>
  399. <td style="width: 33%; vertical-align: top;"><ul>
  400. <li><a href="../api/wrappers/#minigrid.wrappers.ObservationWrapper">ObservationWrapper (class in minigrid.wrappers)</a>
  401. </li>
  402. </ul></td>
  403. <td style="width: 33%; vertical-align: top;"><ul>
  404. <li><a href="../api/wrappers/#minigrid.wrappers.OneHotPartialObsWrapper">OneHotPartialObsWrapper (class in minigrid.wrappers)</a>
  405. </li>
  406. </ul></td>
  407. </tr></table>
  408. </section>
  409. <section id="P" class="genindex-section">
  410. <h2>P</h2>
  411. <table style="width: 100%" class="indextable genindextable"><tr>
  412. <td style="width: 33%; vertical-align: top;"><ul>
  413. <li><a href="../api/wrappers/#minigrid.wrappers.PositionBonus">PositionBonus (class in minigrid.wrappers)</a>
  414. </li>
  415. </ul></td>
  416. </tr></table>
  417. </section>
  418. <section id="R" class="genindex-section">
  419. <h2>R</h2>
  420. <table style="width: 100%" class="indextable genindextable"><tr>
  421. <td style="width: 33%; vertical-align: top;"><ul>
  422. <li><a href="../api/wrappers/#minigrid.wrappers.ReseedWrapper">ReseedWrapper (class in minigrid.wrappers)</a>
  423. </li>
  424. </ul></td>
  425. <td style="width: 33%; vertical-align: top;"><ul>
  426. <li><a href="../api/wrappers/#minigrid.wrappers.RGBImgObsWrapper">RGBImgObsWrapper (class in minigrid.wrappers)</a>
  427. </li>
  428. <li><a href="../api/wrappers/#minigrid.wrappers.RGBImgPartialObsWrapper">RGBImgPartialObsWrapper (class in minigrid.wrappers)</a>
  429. </li>
  430. </ul></td>
  431. </tr></table>
  432. </section>
  433. <section id="S" class="genindex-section">
  434. <h2>S</h2>
  435. <table style="width: 100%" class="indextable genindextable"><tr>
  436. <td style="width: 33%; vertical-align: top;"><ul>
  437. <li><a href="../api/wrappers/#minigrid.wrappers.StochasticActionWrapper">StochasticActionWrapper (class in minigrid.wrappers)</a>
  438. </li>
  439. </ul></td>
  440. <td style="width: 33%; vertical-align: top;"><ul>
  441. <li><a href="../api/wrappers/#minigrid.wrappers.SymbolicObsWrapper">SymbolicObsWrapper (class in minigrid.wrappers)</a>
  442. </li>
  443. </ul></td>
  444. </tr></table>
  445. </section>
  446. <section id="V" class="genindex-section">
  447. <h2>V</h2>
  448. <table style="width: 100%" class="indextable genindextable"><tr>
  449. <td style="width: 33%; vertical-align: top;"><ul>
  450. <li><a href="../api/wrappers/#minigrid.wrappers.ViewSizeWrapper">ViewSizeWrapper (class in minigrid.wrappers)</a>
  451. </li>
  452. </ul></td>
  453. </tr></table>
  454. </section>
  455. </article>
  456. </div>
  457. <footer>
  458. <div class="related-pages">
  459. </div>
  460. <div class="bottom-of-page">
  461. <div class="left-details">
  462. <div class="copyright">
  463. Copyright &#169; 2023 Farama Foundation
  464. </div>
  465. <!--
  466. Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
  467. <a href="https://github.com/pradyunsg/furo">Furo</a>
  468. -->
  469. </div>
  470. <div class="right-details">
  471. <div class="icons">
  472. <a class="muted-link" href="https://github.com/Farama-Foundation/Minigrid/"
  473. aria-label="On GitHub">
  474. <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
  475. <path fill-rule="evenodd"
  476. d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">
  477. </path>
  478. </svg>
  479. </a>
  480. </div>
  481. </div>
  482. </div>
  483. </footer>
  484. </div>
  485. <aside class="toc-drawer no-toc">
  486. </aside>
  487. </div>
  488. </div>
  489. </div>
  490. <script>
  491. const toggleMenu = () => {
  492. const menuBtn = document.querySelector(".farama-header-menu__btn");
  493. const menuContainer = document.querySelector(".farama-header-menu-container");
  494. if (document.querySelector(".farama-header-menu").classList.contains("active")) {
  495. menuBtn.setAttribute("aria-expanded", "false");
  496. menuContainer.setAttribute("aria-hidden", "true");
  497. } else {
  498. menuBtn.setAttribute("aria-expanded", "true");
  499. menuContainer.setAttribute("aria-hidden", "false");
  500. }
  501. document.querySelector(".farama-header-menu").classList.toggle("active");
  502. }
  503. document.querySelector(".farama-header-menu__btn").addEventListener("click", toggleMenu);
  504. document.getElementById("farama-close-menu").addEventListener("click", toggleMenu);
  505. </script>
  506. <script async src="https://www.googletagmanager.com/gtag/js?id=G-FBXJQQLXKD"></script>
  507. <script>
  508. const enableGtag = () => {
  509. window.dataLayer = window.dataLayer || [];
  510. function gtag(){dataLayer.push(arguments);}
  511. gtag('js', new Date());
  512. gtag('config', 'G-FBXJQQLXKD');
  513. }
  514. (() => {
  515. if (!localStorage.getItem("acceptedCookieAlert")) {
  516. const boxElem = document.createElement("div");
  517. boxElem.classList.add("cookie-alert");
  518. const containerElem = document.createElement("div");
  519. containerElem.classList.add("cookie-alert__container");
  520. const textElem = document.createElement("p");
  521. textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
  522. Google Analytics</a> to collect statistics.`;
  523. containerElem.appendChild(textElem);
  524. const declineBtn = Object.assign(document.createElement("button"),
  525. {
  526. innerText: "Deny",
  527. className: "farama-btn cookie-alert__button",
  528. id: "cookie-alert__decline",
  529. }
  530. );
  531. declineBtn.addEventListener("click", () => {
  532. localStorage.setItem("acceptedCookieAlert", false);
  533. boxElem.remove();
  534. });
  535. const acceptBtn = Object.assign(document.createElement("button"),
  536. {
  537. innerText: "Allow",
  538. className: "farama-btn cookie-alert__button",
  539. id: "cookie-alert__accept",
  540. }
  541. );
  542. acceptBtn.addEventListener("click", () => {
  543. localStorage.setItem("acceptedCookieAlert", true);
  544. boxElem.remove();
  545. enableGtag();
  546. });
  547. containerElem.appendChild(declineBtn);
  548. containerElem.appendChild(acceptBtn);
  549. boxElem.appendChild(containerElem);
  550. document.body.appendChild(boxElem);
  551. } else if (localStorage.getItem("acceptedCookieAlert") === "true") {
  552. enableGtag();
  553. }
  554. })()
  555. </script>
  556. <script src="../_static/documentation_options.js?v=7fa42598"></script>
  557. <script src="../_static/doctools.js?v=888ff710"></script>
  558. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  559. <script src="../_static/scripts/furo.js?v=7660844c"></script>
  560. <script>
  561. const createProjectsList = (projects, displayImages) => {
  562. const ulElem = Object.assign(document.createElement('ul'),
  563. {
  564. className:'farama-header-menu-list',
  565. }
  566. )
  567. for (let project of projects) {
  568. const liElem = document.createElement("li");
  569. const aElem = Object.assign(document.createElement("a"),
  570. {
  571. href: project.link
  572. }
  573. );
  574. liElem.appendChild(aElem);
  575. if (displayImages) {
  576. const imgElem = Object.assign(document.createElement("img"),
  577. {
  578. src: project.image ? imagesBasepath + project.image : imagesBasepath + "/farama_black.svg",
  579. alt: `${project.name} logo`,
  580. className: "farama-black-logo-invert"
  581. }
  582. );
  583. aElem.appendChild(imgElem);
  584. }
  585. aElem.appendChild(document.createTextNode(project.name));
  586. ulElem.appendChild(liElem);
  587. }
  588. return ulElem;
  589. }
  590. // Create menu with Farama projects by using the API at farama.org/api/projects.json
  591. const createCORSRequest = (method, url) => {
  592. let xhr = new XMLHttpRequest();
  593. xhr.responseType = 'json';
  594. if ("withCredentials" in xhr) {
  595. xhr.open(method, url, true);
  596. } else if (typeof XDomainRequest != "undefined") {
  597. // IE8 & IE9
  598. xhr = new XDomainRequest();
  599. xhr.open(method, url);
  600. } else {
  601. // CORS not supported.
  602. xhr = null;
  603. }
  604. return xhr;
  605. };
  606. const url = 'https://farama.org/api/projects.json';
  607. const imagesBasepath = "https://farama.org/assets/images"
  608. const method = 'GET';
  609. let xhr = createCORSRequest(method, url);
  610. xhr.onload = () => {
  611. const jsonResponse = xhr.response;
  612. const sections = {
  613. "Core Projects": [],
  614. "Mature Projects": {
  615. "Documentation": [],
  616. "Repositories": [],
  617. },
  618. "Incubating Projects": {
  619. "Documentation": [],
  620. "Repositories": [],
  621. },
  622. "Foundation": [
  623. {
  624. name: "About",
  625. link: "https://farama.org/about"
  626. },
  627. {
  628. name: "Standards",
  629. link: "https://farama.org/project_standards",
  630. },
  631. {
  632. name: "Donate",
  633. link: "https://farama.org/donations"
  634. }
  635. ]
  636. }
  637. // Categorize projects
  638. Object.keys(jsonResponse).forEach(key => {
  639. projectJson = jsonResponse[key];
  640. if (projectJson.website !== null) {
  641. projectJson.link = projectJson.website;
  642. } else {
  643. projectJson.link = projectJson.github;
  644. }
  645. if (projectJson.type === "core") {
  646. sections["Core Projects"].push(projectJson)
  647. } else if (projectJson.type == "mature") {
  648. if (projectJson.website !== null) {
  649. sections["Mature Projects"]["Documentation"].push(projectJson)
  650. } else {
  651. sections["Mature Projects"]["Repositories"].push(projectJson)
  652. }
  653. } else {
  654. if (projectJson.website !== null) {
  655. sections["Incubating Projects"]["Documentation"].push(projectJson)
  656. } else {
  657. sections["Incubating Projects"]["Repositories"].push(projectJson)
  658. }
  659. }
  660. })
  661. const menuContainer = document.querySelector(".farama-header-menu__body");
  662. Object.keys(sections).forEach((key, i) => {
  663. const sectionElem = Object.assign(
  664. document.createElement('div'), {
  665. className:'farama-header-menu__section',
  666. }
  667. )
  668. sectionElem.appendChild(Object.assign(document.createElement('span'),
  669. {
  670. className:'farama-header-menu__section-title' ,
  671. innerText: key
  672. }
  673. ))
  674. // is not a list
  675. if (sections[key].constructor !== Array) {
  676. const subSections = sections[key];
  677. const subSectionContainerElem = Object.assign(
  678. document.createElement('div'), {
  679. className:'farama-header-menu__subsections-container',
  680. style: 'display: flex'
  681. }
  682. )
  683. Object.keys(subSections).forEach((subKey, i) => {
  684. const subSectionElem = Object.assign(
  685. document.createElement('div'), {
  686. className:'farama-header-menu__subsection',
  687. }
  688. )
  689. subSectionElem.appendChild(Object.assign(document.createElement('span'),
  690. {
  691. className:'farama-header-menu__subsection-title' ,
  692. innerText: subKey
  693. }
  694. ))
  695. const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
  696. subSectionElem.appendChild(ulElem);
  697. subSectionContainerElem.appendChild(subSectionElem);
  698. })
  699. sectionElem.appendChild(subSectionContainerElem);
  700. } else {
  701. const projects = sections[key];
  702. const ulElem = createProjectsList(projects, true);
  703. sectionElem.appendChild(ulElem);
  704. }
  705. menuContainer.appendChild(sectionElem)
  706. });
  707. }
  708. xhr.onerror = function() {
  709. console.error("Unable to load projects");
  710. };
  711. xhr.send();
  712. </script>
  713. <script>
  714. const versioningConfig = {
  715. githubUser: 'Farama-Foundation',
  716. githubRepo: 'Minigrid',
  717. };
  718. fetch('/main/_static/versioning/versioning_menu.html').then(response => {
  719. if (response.status === 200) {
  720. response.text().then(text => {
  721. const container = document.createElement("div");
  722. container.innerHTML = text;
  723. document.querySelector("body").appendChild(container);
  724. // innerHtml doenst evaluate scripts, we need to add them dynamically
  725. Array.from(container.querySelectorAll("script")).forEach(oldScript => {
  726. const newScript = document.createElement("script");
  727. Array.from(oldScript.attributes).forEach(attr => newScript.setAttribute(attr.name, attr.value));
  728. newScript.appendChild(document.createTextNode(oldScript.innerHTML));
  729. oldScript.parentNode.replaceChild(newScript, oldScript);
  730. });
  731. });
  732. } else {
  733. console.warn("Unable to load versioning menu", response);
  734. }
  735. });
  736. </script>
  737. </body>
  738. </html>