Home Explore Help
Sign In
radu
/
Gym-MiniGrid
mirror of https://github.com/maximecb/gym-minigrid.git
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Browse Source

Deploying to gh-pages from @ Farama-Foundation/MiniGrid@f2a30bd1b28058fde0db723aa271b595af439548 🚀

rodrigodelazcano 3 years ago
parent
066b77ec7a
commit
72a679c750
100 changed files with 26081 additions and 0 deletions
Unified View Show Diff Stats
  1. 4 0
      .buildinfo
  2. 0 0
      .nojekyll
  3. 318 0
      404.html
  4. 1 0
      CNAME
  5. 367 0
      README/index.html
  6. 904 0
      _static/basic.css
  7. 53 0
      _static/css/custom.css
  8. 35 0
      _static/css/env_pages.css
  9. 69 0
      _static/debug.css
  10. 323 0
      _static/doctools.js
  11. 12 0
      _static/documentation_options.js
  12. BIN
      _static/file.png
  13. 147 0
      _static/img/favicon.svg
  14. BIN
      _static/img/figures/BlockedUnlockPickup.png
  15. BIN
      _static/img/figures/DistShift1.png
  16. BIN
      _static/img/figures/DistShift2.png
  17. BIN
      _static/img/figures/KeyCorridorS3R1.png
  18. BIN
      _static/img/figures/KeyCorridorS3R2.png
  19. BIN
      _static/img/figures/KeyCorridorS3R3.png
  20. BIN
      _static/img/figures/KeyCorridorS4R3.png
  21. BIN
      _static/img/figures/KeyCorridorS5R3.png
  22. BIN
      _static/img/figures/KeyCorridorS6R3.png
  23. BIN
      _static/img/figures/LavaCrossingS11N5.png
  24. BIN
      _static/img/figures/LavaCrossingS9N1.png
  25. BIN
      _static/img/figures/LavaCrossingS9N2.png
  26. BIN
      _static/img/figures/LavaCrossingS9N3.png
  27. BIN
      _static/img/figures/LavaGapS6.png
  28. BIN
      _static/img/figures/ObstructedMaze-1Dl.png
  29. BIN
      _static/img/figures/ObstructedMaze-1Dlh.png
  30. BIN
      _static/img/figures/ObstructedMaze-1Dlhb.png
  31. BIN
      _static/img/figures/ObstructedMaze-1Q.png
  32. BIN
      _static/img/figures/ObstructedMaze-2Dl.png
  33. BIN
      _static/img/figures/ObstructedMaze-2Dlh.png
  34. BIN
      _static/img/figures/ObstructedMaze-2Dlhb.png
  35. BIN
      _static/img/figures/ObstructedMaze-2Q.png
  36. BIN
      _static/img/figures/ObstructedMaze-4Q.png
  37. BIN
      _static/img/figures/SimpleCrossingS11N5.png
  38. BIN
      _static/img/figures/SimpleCrossingS9N1.png
  39. BIN
      _static/img/figures/SimpleCrossingS9N2.png
  40. BIN
      _static/img/figures/SimpleCrossingS9N3.png
  41. BIN
      _static/img/figures/Unlock.png
  42. BIN
      _static/img/figures/UnlockPickup.png
  43. BIN
      _static/img/figures/door-key-curriculum.gif
  44. BIN
      _static/img/figures/door-key-env.png
  45. BIN
      _static/img/figures/dynamic_obstacles.gif
  46. BIN
      _static/img/figures/empty-env.png
  47. BIN
      _static/img/figures/fetch-env.png
  48. BIN
      _static/img/figures/four-rooms-env.png
  49. BIN
      _static/img/figures/gotodoor-6x6.mp4
  50. BIN
      _static/img/figures/gotodoor-6x6.png
  51. BIN
      _static/img/figures/multi-room.gif
  52. 1 0
      _static/img/github_icon.svg
  53. 130 0
      _static/img/minigrid-github.svg
  54. 185 0
      _static/img/minigrid-text.svg
  55. BIN
      _static/img/minigrid-white.png
  56. 151 0
      _static/img/minigrid-white.svg
  57. BIN
      _static/img/minigrid.png
  58. 147 0
      _static/img/minigrid.svg
  59. 10872 0
      _static/jquery-3.5.1.js
  60. 2 0
      _static/jquery.js
  61. 297 0
      _static/language_data.js
  62. BIN
      _static/minigrid-white.png
  63. BIN
      _static/minus.png
  64. BIN
      _static/plus.png
  65. 252 0
      _static/pygments.css
  66. 0 0
      _static/scripts/furo-extensions.js
  67. 3 0
      _static/scripts/furo.js
  68. 7 0
      _static/scripts/furo.js.LICENSE.txt
  69. 1 0
      _static/scripts/furo.js.map
  70. 528 0
      _static/searchtools.js
  71. 296 0
      _static/skeleton.css
  72. 2 0
      _static/styles/furo-extensions.css
  73. 1 0
      _static/styles/furo-extensions.css.map
  74. 2 0
      _static/styles/furo.css
  75. 1 0
      _static/styles/furo.css.map
  76. 2042 0
      _static/underscore-1.13.1.js
  77. 6 0
      _static/underscore.js
  78. 348 0
      api/wrappers/index.html
  79. 364 0
      content/basic_usage/index.html
  80. 333 0
      content/installation/index.html
  81. 388 0
      content/pubs/index.html
  82. 444 0
      environments/blocked_unlock_pickup/index.html
  83. 363 0
      environments/design/index.html
  84. 445 0
      environments/dist_shift2/index.html
  85. 443 0
      environments/door_key/index.html
  86. 449 0
      environments/dynamic/index.html
  87. 449 0
      environments/empty/index.html
  88. 449 0
      environments/fetch/index.html
  89. 440 0
      environments/four_rooms/index.html
  90. 445 0
      environments/go_to_door/index.html
  91. 335 0
      environments/go_to_object/index.html
  92. 321 0
      environments/index.html
  93. 453 0
      environments/key_corridor_s6_r3/index.html
  94. 448 0
      environments/lava_gap_s7/index.html
  95. 443 0
      environments/locked_room/index.html
  96. 446 0
      environments/memory_s7/index.html
  97. 445 0
      environments/multi_room/index.html
  98. 336 0
      environments/obstructed_maze/index.html
  99. 335 0
      environments/playground/index.html
  100. 0 0
      environments/put_near/index.html

+ 4 - 0
.buildinfo
View File 

@@ -0,0 +1,4 @@
 
+# Sphinx build info version 1
 
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
 
+config: 95b793023333541e970e0a0e0f3f9403
 
+tags: d77d1c0d9ca2f4c8421862c7c5a0d620

+ 0 - 0
.nojekyll
View File


+ 318 - 0
404.html
View File 

@@ -0,0 +1,318 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="/MiniGrid/genindex/" /><link rel="search" title="Search" href="/MiniGrid/search/" /><link rel="prev" title="Playground" href="/environments/playground/" />
 
+        <link rel="canonical" href="https://fenggu.me/404.html" />
 
+
 
+    <link rel="shortcut icon" href="/MiniGrid/_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>404 - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="/MiniGrid/_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="/MiniGrid/_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="/MiniGrid/_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="/MiniGrid/_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="#"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="#">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="/MiniGrid/_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="/MiniGrid/_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="/MiniGrid/search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="/MiniGrid/content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="/MiniGrid/content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="/MiniGrid/api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="/MiniGrid/content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="/MiniGrid/environments/design/">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="/MiniGrid/environments/">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="/MiniGrid/environments/playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="/MiniGrid/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="id1">
 
+<h1>404<a class="headerlink" href="#id1" title="Permalink to this headline">#</a></h1>
 
+<section id="page-not-found">
 
+<h2>Page Not Found<a class="headerlink" href="#page-not-found" title="Permalink to this headline">#</a></h2>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="#" id="documentation_options" src="/MiniGrid/_static/documentation_options.js"></script>
 
+    <script src="/MiniGrid/_static/jquery.js"></script>
 
+    <script src="/MiniGrid/_static/underscore.js"></script>
 
+    <script src="/MiniGrid/_static/doctools.js"></script>
 
+    <script src="/MiniGrid/_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 1 - 0
CNAME
View File 

@@ -0,0 +1 @@
 
+fenggu.me

+ 367 - 0
README/index.html
View File 

@@ -0,0 +1,367 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" />
 
+        <link rel="canonical" href="https://fenggu.me/README.html" />
 
+
 
+    <link rel="shortcut icon" href="../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>MiniGrid-docs - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../environments/design/">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="../environments/">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../environments/playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="minigrid-docs">
 
+<h1>MiniGrid-docs<a class="headerlink" href="#minigrid-docs" title="Permalink to this headline">#</a></h1>
 
+<p>This repo contains the <span class="xref myst">NEW website</span> for <a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">MiniGrid</a>. This site is currently in Beta and we are in the process of adding/editing information.</p>
 
+<p>The documentation uses Sphinx. However, the documentation is written in regular md, NOT rst.</p>
 
+<p>If you are modifying a non-environment page or an atari environment page, please PR this repo. Otherwise, follow the steps below:</p>
 
+<section id="instructions-for-modifying-environment-pages">
 
+<h2>Instructions for modifying environment pages<a class="headerlink" href="#instructions-for-modifying-environment-pages" title="Permalink to this headline">#</a></h2>
 
+<section id="editing-an-environment-page">
 
+<h3>Editing an environment page<a class="headerlink" href="#editing-an-environment-page" title="Permalink to this headline">#</a></h3>
 
+<p>If you are editing an Atari environment, directly edit the md file in this repository.</p>
 
+<p>Otherwise, fork Gym and edit the docstring in the environment’s Python file. Then, pip install your Gym fork and run <code class="docutils literal notranslate"><span class="pre">docs/scripts/gen_mds.py</span></code> in this repo. This will automatically generate a md documentation file for the environment.</p>
 
+</section>
 
+</section>
 
+<section id="build-the-documentation">
 
+<h2>Build the Documentation<a class="headerlink" href="#build-the-documentation" title="Permalink to this headline">#</a></h2>
 
+<p>Install the required packages and Gym (or your fork):</p>
 
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
 
+<span class="n">pip</span> <span class="n">install</span> <span class="n">gym</span>
 
+</pre></div>
 
+</div>
 
+<p>To build the documentation once:</p>
 
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">docs</span>
 
+<span class="n">make</span> <span class="n">dirhtml</span>
 
+</pre></div>
 
+</div>
 
+<p>To rebuild the documentation automatically every time a change is made:</p>
 
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">docs</span>
 
+<span class="n">sphinx</span><span class="o">-</span><span class="n">autobuild</span> <span class="o">-</span><span class="n">b</span> <span class="n">dirhtml</span> <span class="o">./</span><span class="n">source</span> <span class="n">build</span><span class="o">/</span><span class="n">html</span>
 
+</pre></div>
 
+</div>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">MiniGrid-docs</a><ul>
 
+<li><a class="reference internal" href="#instructions-for-modifying-environment-pages">Instructions for modifying environment pages</a><ul>
 
+<li><a class="reference internal" href="#editing-an-environment-page">Editing an environment page</a></li>
 
+</ul>
 
+</li>
 
+<li><a class="reference internal" href="#build-the-documentation">Build the Documentation</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 
+    <script src="../_static/jquery.js"></script>
 
+    <script src="../_static/underscore.js"></script>
 
+    <script src="../_static/doctools.js"></script>
 
+    <script src="../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 904 - 0
_static/basic.css
View File 

@@ -0,0 +1,904 @@
 
+/*
 
+ * basic.css
 
+ * ~~~~~~~~~
 
+ *
 
+ * Sphinx stylesheet -- basic theme.
 
+ *
 
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
 
+ * :license: BSD, see LICENSE for details.
 
+ *
 
+ */
 
+
 
+/* -- main layout ----------------------------------------------------------- */
 
+
 
+div.clearer {
 
+    clear: both;
 
+}
 
+
 
+div.section::after {
 
+    display: block;
 
+    content: '';
 
+    clear: left;
 
+}
 
+
 
+/* -- relbar ---------------------------------------------------------------- */
 
+
 
+div.related {
 
+    width: 100%;
 
+    font-size: 90%;
 
+}
 
+
 
+div.related h3 {
 
+    display: none;
 
+}
 
+
 
+div.related ul {
 
+    margin: 0;
 
+    padding: 0 0 0 10px;
 
+    list-style: none;
 
+}
 
+
 
+div.related li {
 
+    display: inline;
 
+}
 
+
 
+div.related li.right {
 
+    float: right;
 
+    margin-right: 5px;
 
+}
 
+
 
+/* -- sidebar --------------------------------------------------------------- */
 
+
 
+div.sphinxsidebarwrapper {
 
+    padding: 10px 5px 0 10px;
 
+}
 
+
 
+div.sphinxsidebar {
 
+    float: left;
 
+    width: 230px;
 
+    margin-left: -100%;
 
+    font-size: 90%;
 
+    word-wrap: break-word;
 
+    overflow-wrap : break-word;
 
+}
 
+
 
+div.sphinxsidebar ul {
 
+    list-style: none;
 
+}
 
+
 
+div.sphinxsidebar ul ul,
 
+div.sphinxsidebar ul.want-points {
 
+    margin-left: 20px;
 
+    list-style: square;
 
+}
 
+
 
+div.sphinxsidebar ul ul {
 
+    margin-top: 0;
 
+    margin-bottom: 0;
 
+}
 
+
 
+div.sphinxsidebar form {
 
+    margin-top: 10px;
 
+}
 
+
 
+div.sphinxsidebar input {
 
+    border: 1px solid #98dbcc;
 
+    font-family: sans-serif;
 
+    font-size: 1em;
 
+}
 
+
 
+div.sphinxsidebar #searchbox form.search {
 
+    overflow: hidden;
 
+}
 
+
 
+div.sphinxsidebar #searchbox input[type="text"] {
 
+    float: left;
 
+    width: 80%;
 
+    padding: 0.25em;
 
+    box-sizing: border-box;
 
+}
 
+
 
+div.sphinxsidebar #searchbox input[type="submit"] {
 
+    float: left;
 
+    width: 20%;
 
+    border-left: none;
 
+    padding: 0.25em;
 
+    box-sizing: border-box;
 
+}
 
+
 
+
 
+img {
 
+    border: 0;
 
+    max-width: 100%;
 
+}
 
+
 
+/* -- search page ----------------------------------------------------------- */
 
+
 
+ul.search {
 
+    margin: 10px 0 0 20px;
 
+    padding: 0;
 
+}
 
+
 
+ul.search li {
 
+    padding: 5px 0 5px 20px;
 
+    background-image: url(file.png);
 
+    background-repeat: no-repeat;
 
+    background-position: 0 7px;
 
+}
 
+
 
+ul.search li a {
 
+    font-weight: bold;
 
+}
 
+
 
+ul.search li p.context {
 
+    color: #888;
 
+    margin: 2px 0 0 30px;
 
+    text-align: left;
 
+}
 
+
 
+ul.keywordmatches li.goodmatch a {
 
+    font-weight: bold;
 
+}
 
+
 
+/* -- index page ------------------------------------------------------------ */
 
+
 
+table.contentstable {
 
+    width: 90%;
 
+    margin-left: auto;
 
+    margin-right: auto;
 
+}
 
+
 
+table.contentstable p.biglink {
 
+    line-height: 150%;
 
+}
 
+
 
+a.biglink {
 
+    font-size: 1.3em;
 
+}
 
+
 
+span.linkdescr {
 
+    font-style: italic;
 
+    padding-top: 5px;
 
+    font-size: 90%;
 
+}
 
+
 
+/* -- general index --------------------------------------------------------- */
 
+
 
+table.indextable {
 
+    width: 100%;
 
+}
 
+
 
+table.indextable td {
 
+    text-align: left;
 
+    vertical-align: top;
 
+}
 
+
 
+table.indextable ul {
 
+    margin-top: 0;
 
+    margin-bottom: 0;
 
+    list-style-type: none;
 
+}
 
+
 
+table.indextable > tbody > tr > td > ul {
 
+    padding-left: 0em;
 
+}
 
+
 
+table.indextable tr.pcap {
 
+    height: 10px;
 
+}
 
+
 
+table.indextable tr.cap {
 
+    margin-top: 10px;
 
+    background-color: #f2f2f2;
 
+}
 
+
 
+img.toggler {
 
+    margin-right: 3px;
 
+    margin-top: 3px;
 
+    cursor: pointer;
 
+}
 
+
 
+div.modindex-jumpbox {
 
+    border-top: 1px solid #ddd;
 
+    border-bottom: 1px solid #ddd;
 
+    margin: 1em 0 1em 0;
 
+    padding: 0.4em;
 
+}
 
+
 
+div.genindex-jumpbox {
 
+    border-top: 1px solid #ddd;
 
+    border-bottom: 1px solid #ddd;
 
+    margin: 1em 0 1em 0;
 
+    padding: 0.4em;
 
+}
 
+
 
+/* -- domain module index --------------------------------------------------- */
 
+
 
+table.modindextable td {
 
+    padding: 2px;
 
+    border-collapse: collapse;
 
+}
 
+
 
+/* -- general body styles --------------------------------------------------- */
 
+
 
+div.body {
 
+    min-width: 450px;
 
+    max-width: 800px;
 
+}
 
+
 
+div.body p, div.body dd, div.body li, div.body blockquote {
 
+    -moz-hyphens: auto;
 
+    -ms-hyphens: auto;
 
+    -webkit-hyphens: auto;
 
+    hyphens: auto;
 
+}
 
+
 
+a.headerlink {
 
+    visibility: hidden;
 
+}
 
+
 
+a.brackets:before,
 
+span.brackets > a:before{
 
+    content: "[";
 
+}
 
+
 
+a.brackets:after,
 
+span.brackets > a:after {
 
+    content: "]";
 
+}
 
+
 
+h1:hover > a.headerlink,
 
+h2:hover > a.headerlink,
 
+h3:hover > a.headerlink,
 
+h4:hover > a.headerlink,
 
+h5:hover > a.headerlink,
 
+h6:hover > a.headerlink,
 
+dt:hover > a.headerlink,
 
+caption:hover > a.headerlink,
 
+p.caption:hover > a.headerlink,
 
+div.code-block-caption:hover > a.headerlink {
 
+    visibility: visible;
 
+}
 
+
 
+div.body p.caption {
 
+    text-align: inherit;
 
+}
 
+
 
+div.body td {
 
+    text-align: left;
 
+}
 
+
 
+.first {
 
+    margin-top: 0 !important;
 
+}
 
+
 
+p.rubric {
 
+    margin-top: 30px;
 
+    font-weight: bold;
 
+}
 
+
 
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
 
+    clear: left;
 
+    float: left;
 
+    margin-right: 1em;
 
+}
 
+
 
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
 
+    clear: right;
 
+    float: right;
 
+    margin-left: 1em;
 
+}
 
+
 
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
 
+  display: block;
 
+  margin-left: auto;
 
+  margin-right: auto;
 
+}
 
+
 
+img.align-default, figure.align-default, .figure.align-default {
 
+  display: block;
 
+  margin-left: auto;
 
+  margin-right: auto;
 
+}
 
+
 
+.align-left {
 
+    text-align: left;
 
+}
 
+
 
+.align-center {
 
+    text-align: center;
 
+}
 
+
 
+.align-default {
 
+    text-align: center;
 
+}
 
+
 
+.align-right {
 
+    text-align: right;
 
+}
 
+
 
+/* -- sidebars -------------------------------------------------------------- */
 
+
 
+div.sidebar,
 
+aside.sidebar {
 
+    margin: 0 0 0.5em 1em;
 
+    border: 1px solid #ddb;
 
+    padding: 7px;
 
+    background-color: #ffe;
 
+    width: 40%;
 
+    float: right;
 
+    clear: right;
 
+    overflow-x: auto;
 
+}
 
+
 
+p.sidebar-title {
 
+    font-weight: bold;
 
+}
 
+
 
+div.admonition, div.topic, blockquote {
 
+    clear: left;
 
+}
 
+
 
+/* -- topics ---------------------------------------------------------------- */
 
+
 
+div.topic {
 
+    border: 1px solid #ccc;
 
+    padding: 7px;
 
+    margin: 10px 0 10px 0;
 
+}
 
+
 
+p.topic-title {
 
+    font-size: 1.1em;
 
+    font-weight: bold;
 
+    margin-top: 10px;
 
+}
 
+
 
+/* -- admonitions ----------------------------------------------------------- */
 
+
 
+div.admonition {
 
+    margin-top: 10px;
 
+    margin-bottom: 10px;
 
+    padding: 7px;
 
+}
 
+
 
+div.admonition dt {
 
+    font-weight: bold;
 
+}
 
+
 
+p.admonition-title {
 
+    margin: 0px 10px 5px 0px;
 
+    font-weight: bold;
 
+}
 
+
 
+div.body p.centered {
 
+    text-align: center;
 
+    margin-top: 25px;
 
+}
 
+
 
+/* -- content of sidebars/topics/admonitions -------------------------------- */
 
+
 
+div.sidebar > :last-child,
 
+aside.sidebar > :last-child,
 
+div.topic > :last-child,
 
+div.admonition > :last-child {
 
+    margin-bottom: 0;
 
+}
 
+
 
+div.sidebar::after,
 
+aside.sidebar::after,
 
+div.topic::after,
 
+div.admonition::after,
 
+blockquote::after {
 
+    display: block;
 
+    content: '';
 
+    clear: both;
 
+}
 
+
 
+/* -- tables ---------------------------------------------------------------- */
 
+
 
+table.docutils {
 
+    margin-top: 10px;
 
+    margin-bottom: 10px;
 
+    border: 0;
 
+    border-collapse: collapse;
 
+}
 
+
 
+table.align-center {
 
+    margin-left: auto;
 
+    margin-right: auto;
 
+}
 
+
 
+table.align-default {
 
+    margin-left: auto;
 
+    margin-right: auto;
 
+}
 
+
 
+table caption span.caption-number {
 
+    font-style: italic;
 
+}
 
+
 
+table caption span.caption-text {
 
+}
 
+
 
+table.docutils td, table.docutils th {
 
+    padding: 1px 8px 1px 5px;
 
+    border-top: 0;
 
+    border-left: 0;
 
+    border-right: 0;
 
+    border-bottom: 1px solid #aaa;
 
+}
 
+
 
+table.footnote td, table.footnote th {
 
+    border: 0 !important;
 
+}
 
+
 
+th {
 
+    text-align: left;
 
+    padding-right: 5px;
 
+}
 
+
 
+table.citation {
 
+    border-left: solid 1px gray;
 
+    margin-left: 1px;
 
+}
 
+
 
+table.citation td {
 
+    border-bottom: none;
 
+}
 
+
 
+th > :first-child,
 
+td > :first-child {
 
+    margin-top: 0px;
 
+}
 
+
 
+th > :last-child,
 
+td > :last-child {
 
+    margin-bottom: 0px;
 
+}
 
+
 
+/* -- figures --------------------------------------------------------------- */
 
+
 
+div.figure, figure {
 
+    margin: 0.5em;
 
+    padding: 0.5em;
 
+}
 
+
 
+div.figure p.caption, figcaption {
 
+    padding: 0.3em;
 
+}
 
+
 
+div.figure p.caption span.caption-number,
 
+figcaption span.caption-number {
 
+    font-style: italic;
 
+}
 
+
 
+div.figure p.caption span.caption-text,
 
+figcaption span.caption-text {
 
+}
 
+
 
+/* -- field list styles ----------------------------------------------------- */
 
+
 
+table.field-list td, table.field-list th {
 
+    border: 0 !important;
 
+}
 
+
 
+.field-list ul {
 
+    margin: 0;
 
+    padding-left: 1em;
 
+}
 
+
 
+.field-list p {
 
+    margin: 0;
 
+}
 
+
 
+.field-name {
 
+    -moz-hyphens: manual;
 
+    -ms-hyphens: manual;
 
+    -webkit-hyphens: manual;
 
+    hyphens: manual;
 
+}
 
+
 
+/* -- hlist styles ---------------------------------------------------------- */
 
+
 
+table.hlist {
 
+    margin: 1em 0;
 
+}
 
+
 
+table.hlist td {
 
+    vertical-align: top;
 
+}
 
+
 
+/* -- object description styles --------------------------------------------- */
 
+
 
+.sig {
 
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
 
+}
 
+
 
+.sig-name, code.descname {
 
+    background-color: transparent;
 
+    font-weight: bold;
 
+}
 
+
 
+.sig-name {
 
+	font-size: 1.1em;
 
+}
 
+
 
+code.descname {
 
+    font-size: 1.2em;
 
+}
 
+
 
+.sig-prename, code.descclassname {
 
+    background-color: transparent;
 
+}
 
+
 
+.optional {
 
+    font-size: 1.3em;
 
+}
 
+
 
+.sig-paren {
 
+    font-size: larger;
 
+}
 
+
 
+.sig-param.n {
 
+	font-style: italic;
 
+}
 
+
 
+/* C++ specific styling */
 
+
 
+.sig-inline.c-texpr,
 
+.sig-inline.cpp-texpr {
 
+	font-family: unset;
 
+}
 
+
 
+.sig.c   .k, .sig.c   .kt,
 
+.sig.cpp .k, .sig.cpp .kt {
 
+	color: #0033B3;
 
+}
 
+
 
+.sig.c   .m,
 
+.sig.cpp .m {
 
+	color: #1750EB;
 
+}
 
+
 
+.sig.c   .s, .sig.c   .sc,
 
+.sig.cpp .s, .sig.cpp .sc {
 
+	color: #067D17;
 
+}
 
+
 
+
 
+/* -- other body styles ----------------------------------------------------- */
 
+
 
+ol.arabic {
 
+    list-style: decimal;
 
+}
 
+
 
+ol.loweralpha {
 
+    list-style: lower-alpha;
 
+}
 
+
 
+ol.upperalpha {
 
+    list-style: upper-alpha;
 
+}
 
+
 
+ol.lowerroman {
 
+    list-style: lower-roman;
 
+}
 
+
 
+ol.upperroman {
 
+    list-style: upper-roman;
 
+}
 
+
 
+:not(li) > ol > li:first-child > :first-child,
 
+:not(li) > ul > li:first-child > :first-child {
 
+    margin-top: 0px;
 
+}
 
+
 
+:not(li) > ol > li:last-child > :last-child,
 
+:not(li) > ul > li:last-child > :last-child {
 
+    margin-bottom: 0px;
 
+}
 
+
 
+ol.simple ol p,
 
+ol.simple ul p,
 
+ul.simple ol p,
 
+ul.simple ul p {
 
+    margin-top: 0;
 
+}
 
+
 
+ol.simple > li:not(:first-child) > p,
 
+ul.simple > li:not(:first-child) > p {
 
+    margin-top: 0;
 
+}
 
+
 
+ol.simple p,
 
+ul.simple p {
 
+    margin-bottom: 0;
 
+}
 
+
 
+dl.footnote > dt,
 
+dl.citation > dt {
 
+    float: left;
 
+    margin-right: 0.5em;
 
+}
 
+
 
+dl.footnote > dd,
 
+dl.citation > dd {
 
+    margin-bottom: 0em;
 
+}
 
+
 
+dl.footnote > dd:after,
 
+dl.citation > dd:after {
 
+    content: "";
 
+    clear: both;
 
+}
 
+
 
+dl.field-list {
 
+    display: grid;
 
+    grid-template-columns: fit-content(30%) auto;
 
+}
 
+
 
+dl.field-list > dt {
 
+    font-weight: bold;
 
+    word-break: break-word;
 
+    padding-left: 0.5em;
 
+    padding-right: 5px;
 
+}
 
+
 
+dl.field-list > dt:after {
 
+    content: ":";
 
+}
 
+
 
+dl.field-list > dd {
 
+    padding-left: 0.5em;
 
+    margin-top: 0em;
 
+    margin-left: 0em;
 
+    margin-bottom: 0em;
 
+}
 
+
 
+dl {
 
+    margin-bottom: 15px;
 
+}
 
+
 
+dd > :first-child {
 
+    margin-top: 0px;
 
+}
 
+
 
+dd ul, dd table {
 
+    margin-bottom: 10px;
 
+}
 
+
 
+dd {
 
+    margin-top: 3px;
 
+    margin-bottom: 10px;
 
+    margin-left: 30px;
 
+}
 
+
 
+dl > dd:last-child,
 
+dl > dd:last-child > :last-child {
 
+    margin-bottom: 0;
 
+}
 
+
 
+dt:target, span.highlighted {
 
+    background-color: #fbe54e;
 
+}
 
+
 
+rect.highlighted {
 
+    fill: #fbe54e;
 
+}
 
+
 
+dl.glossary dt {
 
+    font-weight: bold;
 
+    font-size: 1.1em;
 
+}
 
+
 
+.versionmodified {
 
+    font-style: italic;
 
+}
 
+
 
+.system-message {
 
+    background-color: #fda;
 
+    padding: 5px;
 
+    border: 3px solid red;
 
+}
 
+
 
+.footnote:target  {
 
+    background-color: #ffa;
 
+}
 
+
 
+.line-block {
 
+    display: block;
 
+    margin-top: 1em;
 
+    margin-bottom: 1em;
 
+}
 
+
 
+.line-block .line-block {
 
+    margin-top: 0;
 
+    margin-bottom: 0;
 
+    margin-left: 1.5em;
 
+}
 
+
 
+.guilabel, .menuselection {
 
+    font-family: sans-serif;
 
+}
 
+
 
+.accelerator {
 
+    text-decoration: underline;
 
+}
 
+
 
+.classifier {
 
+    font-style: oblique;
 
+}
 
+
 
+.classifier:before {
 
+    font-style: normal;
 
+    margin: 0.5em;
 
+    content: ":";
 
+}
 
+
 
+abbr, acronym {
 
+    border-bottom: dotted 1px;
 
+    cursor: help;
 
+}
 
+
 
+/* -- code displays --------------------------------------------------------- */
 
+
 
+pre {
 
+    overflow: auto;
 
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 
+}
 
+
 
+pre, div[class*="highlight-"] {
 
+    clear: both;
 
+}
 
+
 
+span.pre {
 
+    -moz-hyphens: none;
 
+    -ms-hyphens: none;
 
+    -webkit-hyphens: none;
 
+    hyphens: none;
 
+}
 
+
 
+div[class*="highlight-"] {
 
+    margin: 1em 0;
 
+}
 
+
 
+td.linenos pre {
 
+    border: 0;
 
+    background-color: transparent;
 
+    color: #aaa;
 
+}
 
+
 
+table.highlighttable {
 
+    display: block;
 
+}
 
+
 
+table.highlighttable tbody {
 
+    display: block;
 
+}
 
+
 
+table.highlighttable tr {
 
+    display: flex;
 
+}
 
+
 
+table.highlighttable td {
 
+    margin: 0;
 
+    padding: 0;
 
+}
 
+
 
+table.highlighttable td.linenos {
 
+    padding-right: 0.5em;
 
+}
 
+
 
+table.highlighttable td.code {
 
+    flex: 1;
 
+    overflow: hidden;
 
+}
 
+
 
+.highlight .hll {
 
+    display: block;
 
+}
 
+
 
+div.highlight pre,
 
+table.highlighttable pre {
 
+    margin: 0;
 
+}
 
+
 
+div.code-block-caption + div {
 
+    margin-top: 0;
 
+}
 
+
 
+div.code-block-caption {
 
+    margin-top: 1em;
 
+    padding: 2px 5px;
 
+    font-size: small;
 
+}
 
+
 
+div.code-block-caption code {
 
+    background-color: transparent;
 
+}
 
+
 
+table.highlighttable td.linenos,
 
+span.linenos,
 
+div.highlight span.gp {  /* gp: Generic.Prompt */
 
+  user-select: none;
 
+  -webkit-user-select: text; /* Safari fallback only */
 
+  -webkit-user-select: none; /* Chrome/Safari */
 
+  -moz-user-select: none; /* Firefox */
 
+  -ms-user-select: none; /* IE10+ */
 
+}
 
+
 
+div.code-block-caption span.caption-number {
 
+    padding: 0.1em 0.3em;
 
+    font-style: italic;
 
+}
 
+
 
+div.code-block-caption span.caption-text {
 
+}
 
+
 
+div.literal-block-wrapper {
 
+    margin: 1em 0;
 
+}
 
+
 
+code.xref, a code {
 
+    background-color: transparent;
 
+    font-weight: bold;
 
+}
 
+
 
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
 
+    background-color: transparent;
 
+}
 
+
 
+.viewcode-link {
 
+    float: right;
 
+}
 
+
 
+.viewcode-back {
 
+    float: right;
 
+    font-family: sans-serif;
 
+}
 
+
 
+div.viewcode-block:target {
 
+    margin: -1px -10px;
 
+    padding: 0 10px;
 
+}
 
+
 
+/* -- math display ---------------------------------------------------------- */
 
+
 
+img.math {
 
+    vertical-align: middle;
 
+}
 
+
 
+div.body div.math p {
 
+    text-align: center;
 
+}
 
+
 
+span.eqno {
 
+    float: right;
 
+}
 
+
 
+span.eqno a.headerlink {
 
+    position: absolute;
 
+    z-index: 1;
 
+}
 
+
 
+div.math:hover a.headerlink {
 
+    visibility: visible;
 
+}
 
+
 
+/* -- printout stylesheet --------------------------------------------------- */
 
+
 
+@media print {
 
+    div.document,
 
+    div.documentwrapper,
 
+    div.bodywrapper {
 
+        margin: 0 !important;
 
+        width: 100%;
 
+    }
 
+
 
+    div.sphinxsidebar,
 
+    div.related,
 
+    div.footer,
 
+    #top-link {
 
+        display: none;
 
+    }
 
+}

+ 53 - 0
_static/css/custom.css
View File 

@@ -0,0 +1,53 @@
 
+h1 {
 
+    font-size: 2.25rem;
 
+}
 
+
 
+h2 {
 
+    font-size: 1.75rem;
 
+}
 
+
 
+h3 {
 
+    font-size: 1.45rem;
 
+}
 
+
 
+.cookie_alert {
 
+    position: fixed;
 
+    display: flex;
 
+    width: 100%;
 
+    min-height: 70px;
 
+    background-color: var(--color-background-secondary);
 
+    color: var(--color-foreground-primary);
 
+    border-top: 1px solid var(--color-background-border);
 
+    bottom: 0;
 
+    left: 0;
 
+    z-index: 99999;
 
+}
 
+
 
+.cookie_container {
 
+    display: flex;
 
+    align-items: center;
 
+    width: 700px;
 
+    max-width: calc(100% - 28px);
 
+    margin: auto;
 
+}
 
+
 
+.cookie_alert p {
 
+    flex: 1;
 
+}
 
+
 
+.cookie_alert button {
 
+    background-color: transparent;
 
+    border: none;
 
+    width: 26px;
 
+    height: 26px;
 
+    padding: 0;
 
+    cursor: pointer;
 
+}
 
+
 
+.cookie_alert button svg .cls-1 {
 
+     stroke: var(--color-foreground-primary);
 
+}
 
+
 
+.cookie_alert button svg {
 
+    width: 100%;
 
+}

+ 35 - 0
_static/css/env_pages.css
View File 

@@ -0,0 +1,35 @@
 
+.env-grid {
 
+    display: flex;
 
+    flex-wrap: wrap;
 
+    justify-content: center;
 
+    width: 100%;
 
+    box-sizing: border-box;
 
+}
 
+.env-grid__cell {
 
+    display: flex;
 
+    flex-direction: column;
 
+    width: 180px;
 
+    height: 180px;
 
+    padding: 10px;
 
+}
 
+.cell__image-container {
 
+    display: flex;
 
+    height: 148px;
 
+    justify-content: center;
 
+}
 
+.cell__image-container img {
 
+    max-height: 100%;
 
+}
 
+.cell__title {
 
+    display: flex;
 
+    justify-content: center;
 
+    text-align: center;
 
+    align-items: flex-end;
 
+    height: 32px;
 
+    line-height: 16px;
 
+}
 
+.more-btn {
 
+    width: 240px;
 
+    margin: 12px auto;
 
+    display: block;
 
+}

+ 69 - 0
_static/debug.css
View File 

@@ -0,0 +1,69 @@
 
+/*
 
+  This CSS file should be overridden by the theme authors. It's
 
+  meant for debugging and developing the skeleton that this theme provides.
 
+*/
 
+body {
 
+  font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif,
 
+    "Apple Color Emoji", "Segoe UI Emoji";
 
+  background: lavender;
 
+}
 
+.sb-announcement {
 
+  background: rgb(131, 131, 131);
 
+}
 
+.sb-announcement__inner {
 
+  background: black;
 
+  color: white;
 
+}
 
+.sb-header {
 
+  background: lightskyblue;
 
+}
 
+.sb-header__inner {
 
+  background: royalblue;
 
+  color: white;
 
+}
 
+.sb-header-secondary {
 
+  background: lightcyan;
 
+}
 
+.sb-header-secondary__inner {
 
+  background: cornflowerblue;
 
+  color: white;
 
+}
 
+.sb-sidebar-primary {
 
+  background: lightgreen;
 
+}
 
+.sb-main {
 
+  background: blanchedalmond;
 
+}
 
+.sb-main__inner {
 
+  background: antiquewhite;
 
+}
 
+.sb-header-article {
 
+  background: lightsteelblue;
 
+}
 
+.sb-article-container {
 
+  background: snow;
 
+}
 
+.sb-article-main {
 
+  background: white;
 
+}
 
+.sb-footer-article {
 
+  background: lightpink;
 
+}
 
+.sb-sidebar-secondary {
 
+  background: lightgoldenrodyellow;
 
+}
 
+.sb-footer-content {
 
+  background: plum;
 
+}
 
+.sb-footer-content__inner {
 
+  background: palevioletred;
 
+}
 
+.sb-footer {
 
+  background: pink;
 
+}
 
+.sb-footer__inner {
 
+  background: salmon;
 
+}
 
+[role="main"] {
 
+  background: white;
 
+}

+ 323 - 0
_static/doctools.js
View File 

@@ -0,0 +1,323 @@
 
+/*
 
+ * doctools.js
 
+ * ~~~~~~~~~~~
 
+ *
 
+ * Sphinx JavaScript utilities for all documentation.
 
+ *
 
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
 
+ * :license: BSD, see LICENSE for details.
 
+ *
 
+ */
 
+
 
+/**
 
+ * select a different prefix for underscore
 
+ */
 
+$u = _.noConflict();
 
+
 
+/**
 
+ * make the code below compatible with browsers without
 
+ * an installed firebug like debugger
 
+if (!window.console || !console.firebug) {
 
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
 
+    "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
 
+    "profile", "profileEnd"];
 
+  window.console = {};
 
+  for (var i = 0; i < names.length; ++i)
 
+    window.console[names[i]] = function() {};
 
+}
 
+ */
 
+
 
+/**
 
+ * small helper function to urldecode strings
 
+ *
 
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
 
+ */
 
+jQuery.urldecode = function(x) {
 
+  if (!x) {
 
+    return x
 
+  }
 
+  return decodeURIComponent(x.replace(/\+/g, ' '));
 
+};
 
+
 
+/**
 
+ * small helper function to urlencode strings
 
+ */
 
+jQuery.urlencode = encodeURIComponent;
 
+
 
+/**
 
+ * This function returns the parsed url parameters of the
 
+ * current request. Multiple values per key are supported,
 
+ * it will always return arrays of strings for the value parts.
 
+ */
 
+jQuery.getQueryParameters = function(s) {
 
+  if (typeof s === 'undefined')
 
+    s = document.location.search;
 
+  var parts = s.substr(s.indexOf('?') + 1).split('&');
 
+  var result = {};
 
+  for (var i = 0; i < parts.length; i++) {
 
+    var tmp = parts[i].split('=', 2);
 
+    var key = jQuery.urldecode(tmp[0]);
 
+    var value = jQuery.urldecode(tmp[1]);
 
+    if (key in result)
 
+      result[key].push(value);
 
+    else
 
+      result[key] = [value];
 
+  }
 
+  return result;
 
+};
 
+
 
+/**
 
+ * highlight a given string on a jquery object by wrapping it in
 
+ * span elements with the given class name.
 
+ */
 
+jQuery.fn.highlightText = function(text, className) {
 
+  function highlight(node, addItems) {
 
+    if (node.nodeType === 3) {
 
+      var val = node.nodeValue;
 
+      var pos = val.toLowerCase().indexOf(text);
 
+      if (pos >= 0 &&
 
+          !jQuery(node.parentNode).hasClass(className) &&
 
+          !jQuery(node.parentNode).hasClass("nohighlight")) {
 
+        var span;
 
+        var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
 
+        if (isInSVG) {
 
+          span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
 
+        } else {
 
+          span = document.createElement("span");
 
+          span.className = className;
 
+        }
 
+        span.appendChild(document.createTextNode(val.substr(pos, text.length)));
 
+        node.parentNode.insertBefore(span, node.parentNode.insertBefore(
 
+          document.createTextNode(val.substr(pos + text.length)),
 
+          node.nextSibling));
 
+        node.nodeValue = val.substr(0, pos);
 
+        if (isInSVG) {
 
+          var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
 
+          var bbox = node.parentElement.getBBox();
 
+          rect.x.baseVal.value = bbox.x;
 
+          rect.y.baseVal.value = bbox.y;
 
+          rect.width.baseVal.value = bbox.width;
 
+          rect.height.baseVal.value = bbox.height;
 
+          rect.setAttribute('class', className);
 
+          addItems.push({
 
+              "parent": node.parentNode,
 
+              "target": rect});
 
+        }
 
+      }
 
+    }
 
+    else if (!jQuery(node).is("button, select, textarea")) {
 
+      jQuery.each(node.childNodes, function() {
 
+        highlight(this, addItems);
 
+      });
 
+    }
 
+  }
 
+  var addItems = [];
 
+  var result = this.each(function() {
 
+    highlight(this, addItems);
 
+  });
 
+  for (var i = 0; i < addItems.length; ++i) {
 
+    jQuery(addItems[i].parent).before(addItems[i].target);
 
+  }
 
+  return result;
 
+};
 
+
 
+/*
 
+ * backward compatibility for jQuery.browser
 
+ * This will be supported until firefox bug is fixed.
 
+ */
 
+if (!jQuery.browser) {
 
+  jQuery.uaMatch = function(ua) {
 
+    ua = ua.toLowerCase();
 
+
 
+    var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
 
+      /(webkit)[ \/]([\w.]+)/.exec(ua) ||
 
+      /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
 
+      /(msie) ([\w.]+)/.exec(ua) ||
 
+      ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
 
+      [];
 
+
 
+    return {
 
+      browser: match[ 1 ] || "",
 
+      version: match[ 2 ] || "0"
 
+    };
 
+  };
 
+  jQuery.browser = {};
 
+  jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
 
+}
 
+
 
+/**
 
+ * Small JavaScript module for the documentation.
 
+ */
 
+var Documentation = {
 
+
 
+  init : function() {
 
+    this.fixFirefoxAnchorBug();
 
+    this.highlightSearchWords();
 
+    this.initIndexTable();
 
+    if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
 
+      this.initOnKeyListeners();
 
+    }
 
+  },
 
+
 
+  /**
 
+   * i18n support
 
+   */
 
+  TRANSLATIONS : {},
 
+  PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
 
+  LOCALE : 'unknown',
 
+
 
+  // gettext and ngettext don't access this so that the functions
 
+  // can safely bound to a different name (_ = Documentation.gettext)
 
+  gettext : function(string) {
 
+    var translated = Documentation.TRANSLATIONS[string];
 
+    if (typeof translated === 'undefined')
 
+      return string;
 
+    return (typeof translated === 'string') ? translated : translated[0];
 
+  },
 
+
 
+  ngettext : function(singular, plural, n) {
 
+    var translated = Documentation.TRANSLATIONS[singular];
 
+    if (typeof translated === 'undefined')
 
+      return (n == 1) ? singular : plural;
 
+    return translated[Documentation.PLURALEXPR(n)];
 
+  },
 
+
 
+  addTranslations : function(catalog) {
 
+    for (var key in catalog.messages)
 
+      this.TRANSLATIONS[key] = catalog.messages[key];
 
+    this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
 
+    this.LOCALE = catalog.locale;
 
+  },
 
+
 
+  /**
 
+   * add context elements like header anchor links
 
+   */
 
+  addContextElements : function() {
 
+    $('div[id] > :header:first').each(function() {
 
+      $('<a class="headerlink">\u00B6</a>').
 
+      attr('href', '#' + this.id).
 
+      attr('title', _('Permalink to this headline')).
 
+      appendTo(this);
 
+    });
 
+    $('dt[id]').each(function() {
 
+      $('<a class="headerlink">\u00B6</a>').
 
+      attr('href', '#' + this.id).
 
+      attr('title', _('Permalink to this definition')).
 
+      appendTo(this);
 
+    });
 
+  },
 
+
 
+  /**
 
+   * workaround a firefox stupidity
 
+   * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
 
+   */
 
+  fixFirefoxAnchorBug : function() {
 
+    if (document.location.hash && $.browser.mozilla)
 
+      window.setTimeout(function() {
 
+        document.location.href += '';
 
+      }, 10);
 
+  },
 
+
 
+  /**
 
+   * highlight the search words provided in the url in the text
 
+   */
 
+  highlightSearchWords : function() {
 
+    var params = $.getQueryParameters();
 
+    var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
 
+    if (terms.length) {
 
+      var body = $('div.body');
 
+      if (!body.length) {
 
+        body = $('body');
 
+      }
 
+      window.setTimeout(function() {
 
+        $.each(terms, function() {
 
+          body.highlightText(this.toLowerCase(), 'highlighted');
 
+        });
 
+      }, 10);
 
+      $('<p class="highlight-link"><a href="javascript:Documentation.' +
 
+        'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
 
+          .appendTo($('#searchbox'));
 
+    }
 
+  },
 
+
 
+  /**
 
+   * init the domain index toggle buttons
 
+   */
 
+  initIndexTable : function() {
 
+    var togglers = $('img.toggler').click(function() {
 
+      var src = $(this).attr('src');
 
+      var idnum = $(this).attr('id').substr(7);
 
+      $('tr.cg-' + idnum).toggle();
 
+      if (src.substr(-9) === 'minus.png')
 
+        $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
 
+      else
 
+        $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
 
+    }).css('display', '');
 
+    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
 
+        togglers.click();
 
+    }
 
+  },
 
+
 
+  /**
 
+   * helper function to hide the search marks again
 
+   */
 
+  hideSearchWords : function() {
 
+    $('#searchbox .highlight-link').fadeOut(300);
 
+    $('span.highlighted').removeClass('highlighted');
 
+  },
 
+
 
+  /**
 
+   * make the url absolute
 
+   */
 
+  makeURL : function(relativeURL) {
 
+    return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
 
+  },
 
+
 
+  /**
 
+   * get the current relative url
 
+   */
 
+  getCurrentURL : function() {
 
+    var path = document.location.pathname;
 
+    var parts = path.split(/\//);
 
+    $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
 
+      if (this === '..')
 
+        parts.pop();
 
+    });
 
+    var url = parts.join('/');
 
+    return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
 
+  },
 
+
 
+  initOnKeyListeners: function() {
 
+    $(document).keydown(function(event) {
 
+      var activeElementType = document.activeElement.tagName;
 
+      // don't navigate when in search box, textarea, dropdown or button
 
+      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
 
+          && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
 
+          && !event.shiftKey) {
 
+        switch (event.keyCode) {
 
+          case 37: // left
 
+            var prevHref = $('link[rel="prev"]').prop('href');
 
+            if (prevHref) {
 
+              window.location.href = prevHref;
 
+              return false;
 
+            }
 
+            break;
 
+          case 39: // right
 
+            var nextHref = $('link[rel="next"]').prop('href');
 
+            if (nextHref) {
 
+              window.location.href = nextHref;
 
+              return false;
 
+            }
 
+            break;
 
+        }
 
+      }
 
+    });
 
+  }
 
+};
 
+
 
+// quick alias for translations
 
+_ = Documentation.gettext;
 
+
 
+$(document).ready(function() {
 
+  Documentation.init();
 
+});

+ 12 - 0
_static/documentation_options.js
View File 

@@ -0,0 +1,12 @@
 
+var DOCUMENTATION_OPTIONS = {
 
+    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
 
+    VERSION: '1.2.1',
 
+    LANGUAGE: 'None',
 
+    COLLAPSE_INDEX: false,
 
+    BUILDER: 'dirhtml',
 
+    FILE_SUFFIX: '.html',
 
+    LINK_SUFFIX: '.html',
 
+    HAS_SOURCE: false,
 
+    SOURCELINK_SUFFIX: '.txt',
 
+    NAVIGATION_WITH_KEYS: false
 
+};

BIN
_static/file.png
View File


File diff suppressed because it is too large
+ 147 - 0
_static/img/favicon.svg


BIN
_static/img/figures/BlockedUnlockPickup.png
View File


BIN
_static/img/figures/DistShift1.png
View File


BIN
_static/img/figures/DistShift2.png
View File


BIN
_static/img/figures/KeyCorridorS3R1.png
View File


BIN
_static/img/figures/KeyCorridorS3R2.png
View File


BIN
_static/img/figures/KeyCorridorS3R3.png
View File


BIN
_static/img/figures/KeyCorridorS4R3.png
View File


BIN
_static/img/figures/KeyCorridorS5R3.png
View File


BIN
_static/img/figures/KeyCorridorS6R3.png
View File


BIN
_static/img/figures/LavaCrossingS11N5.png
View File


BIN
_static/img/figures/LavaCrossingS9N1.png
View File


BIN
_static/img/figures/LavaCrossingS9N2.png
View File


BIN
_static/img/figures/LavaCrossingS9N3.png
View File


BIN
_static/img/figures/LavaGapS6.png
View File


BIN
_static/img/figures/ObstructedMaze-1Dl.png
View File


BIN
_static/img/figures/ObstructedMaze-1Dlh.png
View File


BIN
_static/img/figures/ObstructedMaze-1Dlhb.png
View File


BIN
_static/img/figures/ObstructedMaze-1Q.png
View File


BIN
_static/img/figures/ObstructedMaze-2Dl.png
View File


BIN
_static/img/figures/ObstructedMaze-2Dlh.png
View File


BIN
_static/img/figures/ObstructedMaze-2Dlhb.png
View File


BIN
_static/img/figures/ObstructedMaze-2Q.png
View File


BIN
_static/img/figures/ObstructedMaze-4Q.png
View File


BIN
_static/img/figures/SimpleCrossingS11N5.png
View File


BIN
_static/img/figures/SimpleCrossingS9N1.png
View File


BIN
_static/img/figures/SimpleCrossingS9N2.png
View File


BIN
_static/img/figures/SimpleCrossingS9N3.png
View File


BIN
_static/img/figures/Unlock.png
View File


BIN
_static/img/figures/UnlockPickup.png
View File


BIN
_static/img/figures/door-key-curriculum.gif
View File


BIN
_static/img/figures/door-key-env.png
View File


BIN
_static/img/figures/dynamic_obstacles.gif
View File


BIN
_static/img/figures/empty-env.png
View File


BIN
_static/img/figures/fetch-env.png
View File


BIN
_static/img/figures/four-rooms-env.png
View File


BIN
_static/img/figures/gotodoor-6x6.mp4
View File


BIN
_static/img/figures/gotodoor-6x6.png
View File


BIN
_static/img/figures/multi-room.gif
View File


File diff suppressed because it is too large
+ 1 - 0
_static/img/github_icon.svg


File diff suppressed because it is too large
+ 130 - 0
_static/img/minigrid-github.svg


File diff suppressed because it is too large
+ 185 - 0
_static/img/minigrid-text.svg


BIN
_static/img/minigrid-white.png
View File


File diff suppressed because it is too large
+ 151 - 0
_static/img/minigrid-white.svg


BIN
_static/img/minigrid.png
View File


File diff suppressed because it is too large
+ 147 - 0
_static/img/minigrid.svg


File diff suppressed because it is too large
+ 10872 - 0
_static/jquery-3.5.1.js


File diff suppressed because it is too large
+ 2 - 0
_static/jquery.js


+ 297 - 0
_static/language_data.js
View File 

@@ -0,0 +1,297 @@
 
+/*
 
+ * language_data.js
 
+ * ~~~~~~~~~~~~~~~~
 
+ *
 
+ * This script contains the language-specific data used by searchtools.js,
 
+ * namely the list of stopwords, stemmer, scorer and splitter.
 
+ *
 
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
 
+ * :license: BSD, see LICENSE for details.
 
+ *
 
+ */
 
+
 
+var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
 
+
 
+
 
+/* Non-minified version is copied as a separate JS file, is available */
 
+
 
+/**
 
+ * Porter Stemmer
 
+ */
 
+var Stemmer = function() {
 
+
 
+  var step2list = {
 
+    ational: 'ate',
 
+    tional: 'tion',
 
+    enci: 'ence',
 
+    anci: 'ance',
 
+    izer: 'ize',
 
+    bli: 'ble',
 
+    alli: 'al',
 
+    entli: 'ent',
 
+    eli: 'e',
 
+    ousli: 'ous',
 
+    ization: 'ize',
 
+    ation: 'ate',
 
+    ator: 'ate',
 
+    alism: 'al',
 
+    iveness: 'ive',
 
+    fulness: 'ful',
 
+    ousness: 'ous',
 
+    aliti: 'al',
 
+    iviti: 'ive',
 
+    biliti: 'ble',
 
+    logi: 'log'
 
+  };
 
+
 
+  var step3list = {
 
+    icate: 'ic',
 
+    ative: '',
 
+    alize: 'al',
 
+    iciti: 'ic',
 
+    ical: 'ic',
 
+    ful: '',
 
+    ness: ''
 
+  };
 
+
 
+  var c = "[^aeiou]";          // consonant
 
+  var v = "[aeiouy]";          // vowel
 
+  var C = c + "[^aeiouy]*";    // consonant sequence
 
+  var V = v + "[aeiou]*";      // vowel sequence
 
+
 
+  var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
 
+  var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
 
+  var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
 
+  var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
 
+
 
+  this.stemWord = function (w) {
 
+    var stem;
 
+    var suffix;
 
+    var firstch;
 
+    var origword = w;
 
+
 
+    if (w.length < 3)
 
+      return w;
 
+
 
+    var re;
 
+    var re2;
 
+    var re3;
 
+    var re4;
 
+
 
+    firstch = w.substr(0,1);
 
+    if (firstch == "y")
 
+      w = firstch.toUpperCase() + w.substr(1);
 
+
 
+    // Step 1a
 
+    re = /^(.+?)(ss|i)es$/;
 
+    re2 = /^(.+?)([^s])s$/;
 
+
 
+    if (re.test(w))
 
+      w = w.replace(re,"$1$2");
 
+    else if (re2.test(w))
 
+      w = w.replace(re2,"$1$2");
 
+
 
+    // Step 1b
 
+    re = /^(.+?)eed$/;
 
+    re2 = /^(.+?)(ed|ing)$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      re = new RegExp(mgr0);
 
+      if (re.test(fp[1])) {
 
+        re = /.$/;
 
+        w = w.replace(re,"");
 
+      }
 
+    }
 
+    else if (re2.test(w)) {
 
+      var fp = re2.exec(w);
 
+      stem = fp[1];
 
+      re2 = new RegExp(s_v);
 
+      if (re2.test(stem)) {
 
+        w = stem;
 
+        re2 = /(at|bl|iz)$/;
 
+        re3 = new RegExp("([^aeiouylsz])\\1$");
 
+        re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
 
+        if (re2.test(w))
 
+          w = w + "e";
 
+        else if (re3.test(w)) {
 
+          re = /.$/;
 
+          w = w.replace(re,"");
 
+        }
 
+        else if (re4.test(w))
 
+          w = w + "e";
 
+      }
 
+    }
 
+
 
+    // Step 1c
 
+    re = /^(.+?)y$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      stem = fp[1];
 
+      re = new RegExp(s_v);
 
+      if (re.test(stem))
 
+        w = stem + "i";
 
+    }
 
+
 
+    // Step 2
 
+    re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      stem = fp[1];
 
+      suffix = fp[2];
 
+      re = new RegExp(mgr0);
 
+      if (re.test(stem))
 
+        w = stem + step2list[suffix];
 
+    }
 
+
 
+    // Step 3
 
+    re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      stem = fp[1];
 
+      suffix = fp[2];
 
+      re = new RegExp(mgr0);
 
+      if (re.test(stem))
 
+        w = stem + step3list[suffix];
 
+    }
 
+
 
+    // Step 4
 
+    re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
 
+    re2 = /^(.+?)(s|t)(ion)$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      stem = fp[1];
 
+      re = new RegExp(mgr1);
 
+      if (re.test(stem))
 
+        w = stem;
 
+    }
 
+    else if (re2.test(w)) {
 
+      var fp = re2.exec(w);
 
+      stem = fp[1] + fp[2];
 
+      re2 = new RegExp(mgr1);
 
+      if (re2.test(stem))
 
+        w = stem;
 
+    }
 
+
 
+    // Step 5
 
+    re = /^(.+?)e$/;
 
+    if (re.test(w)) {
 
+      var fp = re.exec(w);
 
+      stem = fp[1];
 
+      re = new RegExp(mgr1);
 
+      re2 = new RegExp(meq1);
 
+      re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
 
+      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
 
+        w = stem;
 
+    }
 
+    re = /ll$/;
 
+    re2 = new RegExp(mgr1);
 
+    if (re.test(w) && re2.test(w)) {
 
+      re = /.$/;
 
+      w = w.replace(re,"");
 
+    }
 
+
 
+    // and turn initial Y back to y
 
+    if (firstch == "y")
 
+      w = firstch.toLowerCase() + w.substr(1);
 
+    return w;
 
+  }
 
+}
 
+
 
+
 
+
 
+
 
+var splitChars = (function() {
 
+    var result = {};
 
+    var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
 
+         1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
 
+         2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
 
+         2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
 
+         3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
 
+         3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
 
+         4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
 
+         8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
 
+         11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
 
+         43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
 
+    var i, j, start, end;
 
+    for (i = 0; i < singles.length; i++) {
 
+        result[singles[i]] = true;
 
+    }
 
+    var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
 
+         [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
 
+         [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
 
+         [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
 
+         [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
 
+         [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
 
+         [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
 
+         [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
 
+         [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
 
+         [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
 
+         [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
 
+         [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
 
+         [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
 
+         [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
 
+         [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
 
+         [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
 
+         [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
 
+         [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
 
+         [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
 
+         [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
 
+         [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
 
+         [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
 
+         [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
 
+         [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
 
+         [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
 
+         [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
 
+         [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
 
+         [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
 
+         [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
 
+         [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
 
+         [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
 
+         [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
 
+         [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
 
+         [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
 
+         [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
 
+         [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
 
+         [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
 
+         [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
 
+         [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
 
+         [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
 
+         [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
 
+         [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
 
+         [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
 
+         [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
 
+         [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
 
+         [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
 
+         [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
 
+         [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
 
+         [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
 
+    for (i = 0; i < ranges.length; i++) {
 
+        start = ranges[i][0];
 
+        end = ranges[i][1];
 
+        for (j = start; j <= end; j++) {
 
+            result[j] = true;
 
+        }
 
+    }
 
+    return result;
 
+})();
 
+
 
+function splitQuery(query) {
 
+    var result = [];
 
+    var start = -1;
 
+    for (var i = 0; i < query.length; i++) {
 
+        if (splitChars[query.charCodeAt(i)]) {
 
+            if (start !== -1) {
 
+                result.push(query.slice(start, i));
 
+                start = -1;
 
+            }
 
+        } else if (start === -1) {
 
+            start = i;
 
+        }
 
+    }
 
+    if (start !== -1) {
 
+        result.push(query.slice(start));
 
+    }
 
+    return result;
 
+}
 
+
 
+

BIN
_static/minigrid-white.png
View File


BIN
_static/minus.png
View File


BIN
_static/plus.png
View File


+ 252 - 0
_static/pygments.css
View File 

@@ -0,0 +1,252 @@
 
+.highlight pre { line-height: 125%; }
 
+.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+.highlight .hll { background-color: #ffffcc }
 
+.highlight { background: #f8f8f8; }
 
+.highlight .c { color: #8f5902; font-style: italic } /* Comment */
 
+.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
 
+.highlight .g { color: #000000 } /* Generic */
 
+.highlight .k { color: #204a87; font-weight: bold } /* Keyword */
 
+.highlight .l { color: #000000 } /* Literal */
 
+.highlight .n { color: #000000 } /* Name */
 
+.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */
 
+.highlight .x { color: #000000 } /* Other */
 
+.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
 
+.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
 
+.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
 
+.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */
 
+.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
 
+.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
 
+.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
 
+.highlight .gd { color: #a40000 } /* Generic.Deleted */
 
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
 
+.highlight .gr { color: #ef2929 } /* Generic.Error */
 
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
 
+.highlight .go { color: #000000; font-style: italic } /* Generic.Output */
 
+.highlight .gp { color: #8f5902 } /* Generic.Prompt */
 
+.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
 
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
 
+.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
 
+.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */
 
+.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */
 
+.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */
 
+.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */
 
+.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */
 
+.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */
 
+.highlight .ld { color: #000000 } /* Literal.Date */
 
+.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */
 
+.highlight .s { color: #4e9a06 } /* Literal.String */
 
+.highlight .na { color: #c4a000 } /* Name.Attribute */
 
+.highlight .nb { color: #204a87 } /* Name.Builtin */
 
+.highlight .nc { color: #000000 } /* Name.Class */
 
+.highlight .no { color: #000000 } /* Name.Constant */
 
+.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */
 
+.highlight .ni { color: #ce5c00 } /* Name.Entity */
 
+.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
 
+.highlight .nf { color: #000000 } /* Name.Function */
 
+.highlight .nl { color: #f57900 } /* Name.Label */
 
+.highlight .nn { color: #000000 } /* Name.Namespace */
 
+.highlight .nx { color: #000000 } /* Name.Other */
 
+.highlight .py { color: #000000 } /* Name.Property */
 
+.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */
 
+.highlight .nv { color: #000000 } /* Name.Variable */
 
+.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */
 
+.highlight .w { color: #f8f8f8 } /* Text.Whitespace */
 
+.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */
 
+.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */
 
+.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */
 
+.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */
 
+.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */
 
+.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
 
+.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
 
+.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
 
+.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
 
+.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
 
+.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
 
+.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
 
+.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
 
+.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
 
+.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
 
+.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
 
+.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
 
+.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
 
+.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
 
+.highlight .fm { color: #000000 } /* Name.Function.Magic */
 
+.highlight .vc { color: #000000 } /* Name.Variable.Class */
 
+.highlight .vg { color: #000000 } /* Name.Variable.Global */
 
+.highlight .vi { color: #000000 } /* Name.Variable.Instance */
 
+.highlight .vm { color: #000000 } /* Name.Variable.Magic */
 
+.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */
 
+@media not print {
 
+body[data-theme="dark"] .highlight pre { line-height: 125%; }
 
+body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+body[data-theme="dark"] .highlight .hll { background-color: #404040 }
 
+body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 }
 
+body[data-theme="dark"] .highlight .c { color: #999999; font-style: italic } /* Comment */
 
+body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 
+body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */
 
+body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */
 
+body[data-theme="dark"] .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
 
+body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */
 
+body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */
 
+body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */
 
+body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */
 
+body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */
 
+body[data-theme="dark"] .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
 
+body[data-theme="dark"] .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
 
+body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
 
+body[data-theme="dark"] .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
 
+body[data-theme="dark"] .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
 
+body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 
+body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
 
+body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
 
+body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
 
+body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 
+body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
 
+body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */
 
+body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 
+body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 
+body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
 
+body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
 
+body[data-theme="dark"] .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
 
+body[data-theme="dark"] .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
 
+body[data-theme="dark"] .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
 
+body[data-theme="dark"] .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
 
+body[data-theme="dark"] .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
 
+body[data-theme="dark"] .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
 
+body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */
 
+body[data-theme="dark"] .highlight .m { color: #3677a9 } /* Literal.Number */
 
+body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */
 
+body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */
 
+body[data-theme="dark"] .highlight .nb { color: #24909d } /* Name.Builtin */
 
+body[data-theme="dark"] .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
 
+body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */
 
+body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */
 
+body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */
 
+body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */
 
+body[data-theme="dark"] .highlight .nf { color: #447fcf } /* Name.Function */
 
+body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */
 
+body[data-theme="dark"] .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
 
+body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */
 
+body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */
 
+body[data-theme="dark"] .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
 
+body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */
 
+body[data-theme="dark"] .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
 
+body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */
 
+body[data-theme="dark"] .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
 
+body[data-theme="dark"] .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
 
+body[data-theme="dark"] .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
 
+body[data-theme="dark"] .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
 
+body[data-theme="dark"] .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
 
+body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
 
+body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
 
+body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
 
+body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */
 
+body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */
 
+body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */
 
+body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */
 
+body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */
 
+body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */
 
+body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */
 
+body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
 
+body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
 
+body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
 
+body[data-theme="dark"] .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
 
+body[data-theme="dark"] .highlight .fm { color: #447fcf } /* Name.Function.Magic */
 
+body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */
 
+body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */
 
+body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
 
+body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
 
+body[data-theme="dark"] .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
 
+@media (prefers-color-scheme: dark) {
 
+body:not([data-theme="light"]) .highlight pre { line-height: 125%; }
 
+body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 
+body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 
+body:not([data-theme="light"]) .highlight .hll { background-color: #404040 }
 
+body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 }
 
+body:not([data-theme="light"]) .highlight .c { color: #999999; font-style: italic } /* Comment */
 
+body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 
+body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */
 
+body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */
 
+body:not([data-theme="light"]) .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
 
+body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */
 
+body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */
 
+body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */
 
+body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */
 
+body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */
 
+body:not([data-theme="light"]) .highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
 
+body:not([data-theme="light"]) .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
 
+body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
 
+body:not([data-theme="light"]) .highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
 
+body:not([data-theme="light"]) .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
 
+body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 
+body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */
 
+body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
 
+body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */
 
+body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 
+body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */
 
+body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */
 
+body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 
+body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 
+body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
 
+body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */
 
+body:not([data-theme="light"]) .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
 
+body:not([data-theme="light"]) .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
 
+body:not([data-theme="light"]) .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
 
+body:not([data-theme="light"]) .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
 
+body:not([data-theme="light"]) .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
 
+body:not([data-theme="light"]) .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
 
+body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */
 
+body:not([data-theme="light"]) .highlight .m { color: #3677a9 } /* Literal.Number */
 
+body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */
 
+body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */
 
+body:not([data-theme="light"]) .highlight .nb { color: #24909d } /* Name.Builtin */
 
+body:not([data-theme="light"]) .highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
 
+body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */
 
+body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */
 
+body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */
 
+body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */
 
+body:not([data-theme="light"]) .highlight .nf { color: #447fcf } /* Name.Function */
 
+body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */
 
+body:not([data-theme="light"]) .highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
 
+body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */
 
+body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */
 
+body:not([data-theme="light"]) .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
 
+body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */
 
+body:not([data-theme="light"]) .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
 
+body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */
 
+body:not([data-theme="light"]) .highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
 
+body:not([data-theme="light"]) .highlight .mf { color: #3677a9 } /* Literal.Number.Float */
 
+body:not([data-theme="light"]) .highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
 
+body:not([data-theme="light"]) .highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
 
+body:not([data-theme="light"]) .highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
 
+body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
 
+body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
 
+body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */
 
+body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */
 
+body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */
 
+body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */
 
+body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */
 
+body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */
 
+body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */
 
+body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */
 
+body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
 
+body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
 
+body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
 
+body:not([data-theme="light"]) .highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
 
+body:not([data-theme="light"]) .highlight .fm { color: #447fcf } /* Name.Function.Magic */
 
+body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */
 
+body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */
 
+body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */
 
+body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */
 
+body:not([data-theme="light"]) .highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
 
+}
 
+}

+ 0 - 0
_static/scripts/furo-extensions.js
View File


File diff suppressed because it is too large
+ 3 - 0
_static/scripts/furo.js


+ 7 - 0
_static/scripts/furo.js.LICENSE.txt
View File 

@@ -0,0 +1,7 @@
 
+/*!
 
+ * gumshoejs v5.1.2 (patched by @pradyunsg)
 
+ * A simple, framework-agnostic scrollspy script.
 
+ * (c) 2019 Chris Ferdinandi
 
+ * MIT License
 
+ * http://github.com/cferdinandi/gumshoe
 
+ */

File diff suppressed because it is too large
+ 1 - 0
_static/scripts/furo.js.map


+ 528 - 0
_static/searchtools.js
View File 

@@ -0,0 +1,528 @@
 
+/*
 
+ * searchtools.js
 
+ * ~~~~~~~~~~~~~~~~
 
+ *
 
+ * Sphinx JavaScript utilities for the full-text search.
 
+ *
 
+ * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
 
+ * :license: BSD, see LICENSE for details.
 
+ *
 
+ */
 
+
 
+if (!Scorer) {
 
+  /**
 
+   * Simple result scoring code.
 
+   */
 
+  var Scorer = {
 
+    // Implement the following function to further tweak the score for each result
 
+    // The function takes a result array [filename, title, anchor, descr, score]
 
+    // and returns the new score.
 
+    /*
 
+    score: function(result) {
 
+      return result[4];
 
+    },
 
+    */
 
+
 
+    // query matches the full name of an object
 
+    objNameMatch: 11,
 
+    // or matches in the last dotted part of the object name
 
+    objPartialMatch: 6,
 
+    // Additive scores depending on the priority of the object
 
+    objPrio: {0:  15,   // used to be importantResults
 
+              1:  5,   // used to be objectResults
 
+              2: -5},  // used to be unimportantResults
 
+    //  Used when the priority is not in the mapping.
 
+    objPrioDefault: 0,
 
+
 
+    // query found in title
 
+    title: 15,
 
+    partialTitle: 7,
 
+    // query found in terms
 
+    term: 5,
 
+    partialTerm: 2
 
+  };
 
+}
 
+
 
+if (!splitQuery) {
 
+  function splitQuery(query) {
 
+    return query.split(/\s+/);
 
+  }
 
+}
 
+
 
+/**
 
+ * Search Module
 
+ */
 
+var Search = {
 
+
 
+  _index : null,
 
+  _queued_query : null,
 
+  _pulse_status : -1,
 
+
 
+  htmlToText : function(htmlString) {
 
+      var virtualDocument = document.implementation.createHTMLDocument('virtual');
 
+      var htmlElement = $(htmlString, virtualDocument);
 
+      htmlElement.find('.headerlink').remove();
 
+      docContent = htmlElement.find('[role=main]')[0];
 
+      if(docContent === undefined) {
 
+          console.warn("Content block not found. Sphinx search tries to obtain it " +
 
+                       "via '[role=main]'. Could you check your theme or template.");
 
+          return "";
 
+      }
 
+      return docContent.textContent || docContent.innerText;
 
+  },
 
+
 
+  init : function() {
 
+      var params = $.getQueryParameters();
 
+      if (params.q) {
 
+          var query = params.q[0];
 
+          $('input[name="q"]')[0].value = query;
 
+          this.performSearch(query);
 
+      }
 
+  },
 
+
 
+  loadIndex : function(url) {
 
+    $.ajax({type: "GET", url: url, data: null,
 
+            dataType: "script", cache: true,
 
+            complete: function(jqxhr, textstatus) {
 
+              if (textstatus != "success") {
 
+                document.getElementById("searchindexloader").src = url;
 
+              }
 
+            }});
 
+  },
 
+
 
+  setIndex : function(index) {
 
+    var q;
 
+    this._index = index;
 
+    if ((q = this._queued_query) !== null) {
 
+      this._queued_query = null;
 
+      Search.query(q);
 
+    }
 
+  },
 
+
 
+  hasIndex : function() {
 
+      return this._index !== null;
 
+  },
 
+
 
+  deferQuery : function(query) {
 
+      this._queued_query = query;
 
+  },
 
+
 
+  stopPulse : function() {
 
+      this._pulse_status = 0;
 
+  },
 
+
 
+  startPulse : function() {
 
+    if (this._pulse_status >= 0)
 
+        return;
 
+    function pulse() {
 
+      var i;
 
+      Search._pulse_status = (Search._pulse_status + 1) % 4;
 
+      var dotString = '';
 
+      for (i = 0; i < Search._pulse_status; i++)
 
+        dotString += '.';
 
+      Search.dots.text(dotString);
 
+      if (Search._pulse_status > -1)
 
+        window.setTimeout(pulse, 500);
 
+    }
 
+    pulse();
 
+  },
 
+
 
+  /**
 
+   * perform a search for something (or wait until index is loaded)
 
+   */
 
+  performSearch : function(query) {
 
+    // create the required interface elements
 
+    this.out = $('#search-results');
 
+    this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
 
+    this.dots = $('<span></span>').appendTo(this.title);
 
+    this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
 
+    this.output = $('<ul class="search"/>').appendTo(this.out);
 
+
 
+    $('#search-progress').text(_('Preparing search...'));
 
+    this.startPulse();
 
+
 
+    // index already loaded, the browser was quick!
 
+    if (this.hasIndex())
 
+      this.query(query);
 
+    else
 
+      this.deferQuery(query);
 
+  },
 
+
 
+  /**
 
+   * execute search (requires search index to be loaded)
 
+   */
 
+  query : function(query) {
 
+    var i;
 
+
 
+    // stem the searchterms and add them to the correct list
 
+    var stemmer = new Stemmer();
 
+    var searchterms = [];
 
+    var excluded = [];
 
+    var hlterms = [];
 
+    var tmp = splitQuery(query);
 
+    var objectterms = [];
 
+    for (i = 0; i < tmp.length; i++) {
 
+      if (tmp[i] !== "") {
 
+          objectterms.push(tmp[i].toLowerCase());
 
+      }
 
+
 
+      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
 
+        // skip this "word"
 
+        continue;
 
+      }
 
+      // stem the word
 
+      var word = stemmer.stemWord(tmp[i].toLowerCase());
 
+      // prevent stemmer from cutting word smaller than two chars
 
+      if(word.length < 3 && tmp[i].length >= 3) {
 
+        word = tmp[i];
 
+      }
 
+      var toAppend;
 
+      // select the correct list
 
+      if (word[0] == '-') {
 
+        toAppend = excluded;
 
+        word = word.substr(1);
 
+      }
 
+      else {
 
+        toAppend = searchterms;
 
+        hlterms.push(tmp[i].toLowerCase());
 
+      }
 
+      // only add if not already in the list
 
+      if (!$u.contains(toAppend, word))
 
+        toAppend.push(word);
 
+    }
 
+    var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
 
+
 
+    // console.debug('SEARCH: searching for:');
 
+    // console.info('required: ', searchterms);
 
+    // console.info('excluded: ', excluded);
 
+
 
+    // prepare search
 
+    var terms = this._index.terms;
 
+    var titleterms = this._index.titleterms;
 
+
 
+    // array of [filename, title, anchor, descr, score]
 
+    var results = [];
 
+    $('#search-progress').empty();
 
+
 
+    // lookup as object
 
+    for (i = 0; i < objectterms.length; i++) {
 
+      var others = [].concat(objectterms.slice(0, i),
 
+                             objectterms.slice(i+1, objectterms.length));
 
+      results = results.concat(this.performObjectSearch(objectterms[i], others));
 
+    }
 
+
 
+    // lookup as search terms in fulltext
 
+    results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
 
+
 
+    // let the scorer override scores with a custom scoring function
 
+    if (Scorer.score) {
 
+      for (i = 0; i < results.length; i++)
 
+        results[i][4] = Scorer.score(results[i]);
 
+    }
 
+
 
+    // now sort the results by score (in opposite order of appearance, since the
 
+    // display function below uses pop() to retrieve items) and then
 
+    // alphabetically
 
+    results.sort(function(a, b) {
 
+      var left = a[4];
 
+      var right = b[4];
 
+      if (left > right) {
 
+        return 1;
 
+      } else if (left < right) {
 
+        return -1;
 
+      } else {
 
+        // same score: sort alphabetically
 
+        left = a[1].toLowerCase();
 
+        right = b[1].toLowerCase();
 
+        return (left > right) ? -1 : ((left < right) ? 1 : 0);
 
+      }
 
+    });
 
+
 
+    // for debugging
 
+    //Search.lastresults = results.slice();  // a copy
 
+    //console.info('search results:', Search.lastresults);
 
+
 
+    // print the results
 
+    var resultCount = results.length;
 
+    function displayNextItem() {
 
+      // results left, load the summary and display it
 
+      if (results.length) {
 
+        var item = results.pop();
 
+        var listItem = $('<li></li>');
 
+        var requestUrl = "";
 
+        var linkUrl = "";
 
+        if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
 
+          // dirhtml builder
 
+          var dirname = item[0] + '/';
 
+          if (dirname.match(/\/index\/$/)) {
 
+            dirname = dirname.substring(0, dirname.length-6);
 
+          } else if (dirname == 'index/') {
 
+            dirname = '';
 
+          }
 
+          requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
 
+          linkUrl = requestUrl;
 
+
 
+        } else {
 
+          // normal html builders
 
+          requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
 
+          linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
 
+        }
 
+        listItem.append($('<a/>').attr('href',
 
+            linkUrl +
 
+            highlightstring + item[2]).html(item[1]));
 
+        if (item[3]) {
 
+          listItem.append($('<span> (' + item[3] + ')</span>'));
 
+          Search.output.append(listItem);
 
+          setTimeout(function() {
 
+            displayNextItem();
 
+          }, 5);
 
+        } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
 
+          $.ajax({url: requestUrl,
 
+                  dataType: "text",
 
+                  complete: function(jqxhr, textstatus) {
 
+                    var data = jqxhr.responseText;
 
+                    if (data !== '' && data !== undefined) {
 
+                      var summary = Search.makeSearchSummary(data, searchterms, hlterms);
 
+                      if (summary) {
 
+                        listItem.append(summary);
 
+                      }
 
+                    }
 
+                    Search.output.append(listItem);
 
+                    setTimeout(function() {
 
+                      displayNextItem();
 
+                    }, 5);
 
+                  }});
 
+        } else {
 
+          // no source available, just display title
 
+          Search.output.append(listItem);
 
+          setTimeout(function() {
 
+            displayNextItem();
 
+          }, 5);
 
+        }
 
+      }
 
+      // search finished, update title and status message
 
+      else {
 
+        Search.stopPulse();
 
+        Search.title.text(_('Search Results'));
 
+        if (!resultCount)
 
+          Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
 
+        else
 
+            Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
 
+        Search.status.fadeIn(500);
 
+      }
 
+    }
 
+    displayNextItem();
 
+  },
 
+
 
+  /**
 
+   * search for object names
 
+   */
 
+  performObjectSearch : function(object, otherterms) {
 
+    var filenames = this._index.filenames;
 
+    var docnames = this._index.docnames;
 
+    var objects = this._index.objects;
 
+    var objnames = this._index.objnames;
 
+    var titles = this._index.titles;
 
+
 
+    var i;
 
+    var results = [];
 
+
 
+    for (var prefix in objects) {
 
+      for (var name in objects[prefix]) {
 
+        var fullname = (prefix ? prefix + '.' : '') + name;
 
+        var fullnameLower = fullname.toLowerCase()
 
+        if (fullnameLower.indexOf(object) > -1) {
 
+          var score = 0;
 
+          var parts = fullnameLower.split('.');
 
+          // check for different match types: exact matches of full name or
 
+          // "last name" (i.e. last dotted part)
 
+          if (fullnameLower == object || parts[parts.length - 1] == object) {
 
+            score += Scorer.objNameMatch;
 
+          // matches in last name
 
+          } else if (parts[parts.length - 1].indexOf(object) > -1) {
 
+            score += Scorer.objPartialMatch;
 
+          }
 
+          var match = objects[prefix][name];
 
+          var objname = objnames[match[1]][2];
 
+          var title = titles[match[0]];
 
+          // If more than one term searched for, we require other words to be
 
+          // found in the name/title/description
 
+          if (otherterms.length > 0) {
 
+            var haystack = (prefix + ' ' + name + ' ' +
 
+                            objname + ' ' + title).toLowerCase();
 
+            var allfound = true;
 
+            for (i = 0; i < otherterms.length; i++) {
 
+              if (haystack.indexOf(otherterms[i]) == -1) {
 
+                allfound = false;
 
+                break;
 
+              }
 
+            }
 
+            if (!allfound) {
 
+              continue;
 
+            }
 
+          }
 
+          var descr = objname + _(', in ') + title;
 
+
 
+          var anchor = match[3];
 
+          if (anchor === '')
 
+            anchor = fullname;
 
+          else if (anchor == '-')
 
+            anchor = objnames[match[1]][1] + '-' + fullname;
 
+          // add custom score for some objects according to scorer
 
+          if (Scorer.objPrio.hasOwnProperty(match[2])) {
 
+            score += Scorer.objPrio[match[2]];
 
+          } else {
 
+            score += Scorer.objPrioDefault;
 
+          }
 
+          results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
 
+        }
 
+      }
 
+    }
 
+
 
+    return results;
 
+  },
 
+
 
+  /**
 
+   * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+   */
 
+  escapeRegExp : function(string) {
 
+    return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 
+  },
 
+
 
+  /**
 
+   * search for full-text terms in the index
 
+   */
 
+  performTermsSearch : function(searchterms, excluded, terms, titleterms) {
 
+    var docnames = this._index.docnames;
 
+    var filenames = this._index.filenames;
 
+    var titles = this._index.titles;
 
+
 
+    var i, j, file;
 
+    var fileMap = {};
 
+    var scoreMap = {};
 
+    var results = [];
 
+
 
+    // perform the search on the required terms
 
+    for (i = 0; i < searchterms.length; i++) {
 
+      var word = searchterms[i];
 
+      var files = [];
 
+      var _o = [
 
+        {files: terms[word], score: Scorer.term},
 
+        {files: titleterms[word], score: Scorer.title}
 
+      ];
 
+      // add support for partial matches
 
+      if (word.length > 2) {
 
+        var word_regex = this.escapeRegExp(word);
 
+        for (var w in terms) {
 
+          if (w.match(word_regex) && !terms[word]) {
 
+            _o.push({files: terms[w], score: Scorer.partialTerm})
 
+          }
 
+        }
 
+        for (var w in titleterms) {
 
+          if (w.match(word_regex) && !titleterms[word]) {
 
+              _o.push({files: titleterms[w], score: Scorer.partialTitle})
 
+          }
 
+        }
 
+      }
 
+
 
+      // no match but word was a required one
 
+      if ($u.every(_o, function(o){return o.files === undefined;})) {
 
+        break;
 
+      }
 
+      // found search word in contents
 
+      $u.each(_o, function(o) {
 
+        var _files = o.files;
 
+        if (_files === undefined)
 
+          return
 
+
 
+        if (_files.length === undefined)
 
+          _files = [_files];
 
+        files = files.concat(_files);
 
+
 
+        // set score for the word in each file to Scorer.term
 
+        for (j = 0; j < _files.length; j++) {
 
+          file = _files[j];
 
+          if (!(file in scoreMap))
 
+            scoreMap[file] = {};
 
+          scoreMap[file][word] = o.score;
 
+        }
 
+      });
 
+
 
+      // create the mapping
 
+      for (j = 0; j < files.length; j++) {
 
+        file = files[j];
 
+        if (file in fileMap && fileMap[file].indexOf(word) === -1)
 
+          fileMap[file].push(word);
 
+        else
 
+          fileMap[file] = [word];
 
+      }
 
+    }
 
+
 
+    // now check if the files don't contain excluded terms
 
+    for (file in fileMap) {
 
+      var valid = true;
 
+
 
+      // check if all requirements are matched
 
+      var filteredTermCount = // as search terms with length < 3 are discarded: ignore
 
+        searchterms.filter(function(term){return term.length > 2}).length
 
+      if (
 
+        fileMap[file].length != searchterms.length &&
 
+        fileMap[file].length != filteredTermCount
 
+      ) continue;
 
+
 
+      // ensure that none of the excluded terms is in the search result
 
+      for (i = 0; i < excluded.length; i++) {
 
+        if (terms[excluded[i]] == file ||
 
+            titleterms[excluded[i]] == file ||
 
+            $u.contains(terms[excluded[i]] || [], file) ||
 
+            $u.contains(titleterms[excluded[i]] || [], file)) {
 
+          valid = false;
 
+          break;
 
+        }
 
+      }
 
+
 
+      // if we have still a valid result we can add it to the result list
 
+      if (valid) {
 
+        // select one (max) score for the file.
 
+        // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
 
+        var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
 
+        results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
 
+      }
 
+    }
 
+    return results;
 
+  },
 
+
 
+  /**
 
+   * helper function to return a node containing the
 
+   * search summary for a given text. keywords is a list
 
+   * of stemmed words, hlwords is the list of normal, unstemmed
 
+   * words. the first one is used to find the occurrence, the
 
+   * latter for highlighting it.
 
+   */
 
+  makeSearchSummary : function(htmlText, keywords, hlwords) {
 
+    var text = Search.htmlToText(htmlText);
 
+    if (text == "") {
 
+      return null;
 
+    }
 
+    var textLower = text.toLowerCase();
 
+    var start = 0;
 
+    $.each(keywords, function() {
 
+      var i = textLower.indexOf(this.toLowerCase());
 
+      if (i > -1)
 
+        start = i;
 
+    });
 
+    start = Math.max(start - 120, 0);
 
+    var excerpt = ((start > 0) ? '...' : '') +
 
+      $.trim(text.substr(start, 240)) +
 
+      ((start + 240 - text.length) ? '...' : '');
 
+    var rv = $('<p class="context"></p>').text(excerpt);
 
+    $.each(hlwords, function() {
 
+      rv = rv.highlightText(this, 'highlighted');
 
+    });
 
+    return rv;
 
+  }
 
+};
 
+
 
+$(document).ready(function() {
 
+  Search.init();
 
+});

+ 296 - 0
_static/skeleton.css
View File 

@@ -0,0 +1,296 @@
 
+/* Some sane resets. */
 
+html {
 
+  height: 100%;
 
+}
 
+
 
+body {
 
+  margin: 0;
 
+  min-height: 100%;
 
+}
 
+
 
+/* All the flexbox magic! */
 
+body,
 
+.sb-announcement,
 
+.sb-content,
 
+.sb-main,
 
+.sb-container,
 
+.sb-container__inner,
 
+.sb-article-container,
 
+.sb-footer-content,
 
+.sb-header,
 
+.sb-header-secondary,
 
+.sb-footer {
 
+  display: flex;
 
+}
 
+
 
+/* These order things vertically */
 
+body,
 
+.sb-main,
 
+.sb-article-container {
 
+  flex-direction: column;
 
+}
 
+
 
+/* Put elements in the center */
 
+.sb-header,
 
+.sb-header-secondary,
 
+.sb-container,
 
+.sb-content,
 
+.sb-footer,
 
+.sb-footer-content {
 
+  justify-content: center;
 
+}
 
+/* Put elements at the ends */
 
+.sb-article-container {
 
+  justify-content: space-between;
 
+}
 
+
 
+/* These elements grow. */
 
+.sb-main,
 
+.sb-content,
 
+.sb-container,
 
+article {
 
+  flex-grow: 1;
 
+}
 
+
 
+/* Because padding making this wider is not fun */
 
+article {
 
+  box-sizing: border-box;
 
+}
 
+
 
+/* The announcements element should never be wider than the page. */
 
+.sb-announcement {
 
+  max-width: 100%;
 
+}
 
+
 
+.sb-sidebar-primary,
 
+.sb-sidebar-secondary {
 
+  flex-shrink: 0;
 
+  width: 17rem;
 
+}
 
+
 
+.sb-announcement__inner {
 
+  justify-content: center;
 
+
 
+  box-sizing: border-box;
 
+  height: 3rem;
 
+
 
+  overflow-x: auto;
 
+  white-space: nowrap;
 
+}
 
+
 
+/* Sidebars, with checkbox-based toggle */
 
+.sb-sidebar-primary,
 
+.sb-sidebar-secondary {
 
+  position: fixed;
 
+  height: 100%;
 
+  top: 0;
 
+}
 
+
 
+.sb-sidebar-primary {
 
+  left: -17rem;
 
+  transition: left 250ms ease-in-out;
 
+}
 
+.sb-sidebar-secondary {
 
+  right: -17rem;
 
+  transition: right 250ms ease-in-out;
 
+}
 
+
 
+.sb-sidebar-toggle {
 
+  display: none;
 
+}
 
+.sb-sidebar-overlay {
 
+  position: fixed;
 
+  top: 0;
 
+  width: 0;
 
+  height: 0;
 
+
 
+  transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease;
 
+
 
+  opacity: 0;
 
+  background-color: rgba(0, 0, 0, 0.54);
 
+}
 
+
 
+#sb-sidebar-toggle--primary:checked
 
+  ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"],
 
+#sb-sidebar-toggle--secondary:checked
 
+  ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] {
 
+  width: 100%;
 
+  height: 100%;
 
+  opacity: 1;
 
+  transition: width 0ms ease, height 0ms ease, opacity 250ms ease;
 
+}
 
+
 
+#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary {
 
+  left: 0;
 
+}
 
+#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary {
 
+  right: 0;
 
+}
 
+
 
+/* Full-width mode */
 
+.drop-secondary-sidebar-for-full-width-content
 
+  .hide-when-secondary-sidebar-shown {
 
+  display: none !important;
 
+}
 
+.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary {
 
+  display: none !important;
 
+}
 
+
 
+/* Mobile views */
 
+.sb-page-width {
 
+  width: 100%;
 
+}
 
+
 
+.sb-article-container,
 
+.sb-footer-content__inner,
 
+.drop-secondary-sidebar-for-full-width-content [role="main"],
 
+.drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+  width: 100vw;
 
+}
 
+
 
+[role="main"],
 
+.match-content-width {
 
+  padding: 0 1rem;
 
+  box-sizing: border-box;
 
+}
 
+
 
+@media (min-width: 32rem) {
 
+  [role="main"],
 
+  .match-content-width {
 
+    padding: 0 2rem;
 
+  }
 
+}
 
+
 
+/* Tablet views */
 
+@media (min-width: 42rem) {
 
+  .sb-article-container {
 
+    width: auto;
 
+  }
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 42rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 42rem;
 
+  }
 
+}
 
+@media (min-width: 46rem) {
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 46rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 46rem;
 
+  }
 
+}
 
+@media (min-width: 50rem) {
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 50rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 50rem;
 
+  }
 
+}
 
+
 
+/* Tablet views */
 
+@media (min-width: 59rem) {
 
+  .sb-sidebar-secondary {
 
+    position: static;
 
+  }
 
+  .hide-when-secondary-sidebar-shown {
 
+    display: none !important;
 
+  }
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 59rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 42rem;
 
+  }
 
+}
 
+@media (min-width: 63rem) {
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 63rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 46rem;
 
+  }
 
+}
 
+@media (min-width: 67rem) {
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 67rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 50rem;
 
+  }
 
+}
 
+
 
+/* Desktop views */
 
+@media (min-width: 76rem) {
 
+  .sb-sidebar-primary {
 
+    position: static;
 
+  }
 
+  .hide-when-primary-sidebar-shown {
 
+    display: none !important;
 
+  }
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 59rem;
 
+  }
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 42rem;
 
+  }
 
+}
 
+
 
+/* Full desktop views */
 
+@media (min-width: 80rem) {
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 46rem;
 
+  }
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 63rem;
 
+  }
 
+}
 
+
 
+@media (min-width: 84rem) {
 
+  [role="main"],
 
+  .match-content-width {
 
+    width: 50rem;
 
+  }
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 67rem;
 
+  }
 
+}
 
+
 
+@media (min-width: 88rem) {
 
+  .sb-footer-content__inner,
 
+  .drop-secondary-sidebar-for-full-width-content [role="main"],
 
+  .drop-secondary-sidebar-for-full-width-content .match-content-width {
 
+    width: 67rem;
 
+  }
 
+  .sb-page-width {
 
+    width: 88rem;
 
+  }
 
+}

File diff suppressed because it is too large
+ 2 - 0
_static/styles/furo-extensions.css


File diff suppressed because it is too large
+ 1 - 0
_static/styles/furo-extensions.css.map


File diff suppressed because it is too large
+ 2 - 0
_static/styles/furo.css


File diff suppressed because it is too large
+ 1 - 0
_static/styles/furo.css.map


File diff suppressed because it is too large
+ 2042 - 0
_static/underscore-1.13.1.js


File diff suppressed because it is too large
+ 6 - 0
_static/underscore.js


+ 348 - 0
api/wrappers/index.html
View File 

@@ -0,0 +1,348 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="List of publications" href="../../content/pubs/" /><link rel="prev" title="Basic Usage" href="../../content/basic_usage/" />
 
+        <link rel="canonical" href="https://fenggu.me/api/wrappers.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Wrappers - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../environments/design/">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="wrappers">
 
+<h1>Wrappers<a class="headerlink" href="#wrappers" title="Permalink to this headline">#</a></h1>
 
+<p>MiniGrid is built to support tasks involving natural language and sparse rewards.
 
+The observations are dictionaries, with an ‘image’ field, partially observable
 
+view of the environment, a ‘mission’ field which is a textual string
 
+describing the objective the agent should reach to get a reward, and a ‘direction’
 
+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.</p>
 
+<p>There are a variety of wrappers to change the observation format available in <span class="xref myst">minigrid/wrappers.py</span>.
 
+If your RL code expects one single tensor for observations, take a look at <code class="docutils literal notranslate"><span class="pre">FlatObsWrapper</span></code>.
 
+There is also an <code class="docutils literal notranslate"><span class="pre">ImgObsWrapper</span></code> that gets rid of the ‘mission’ field in observations, leaving only the image field tensor.</p>
 
+<p>Please note that the default observation format is a partially observable view of the environment using a
 
+compact and efficient encoding, with 3 input values per visible grid cell, 7x7x3 values total.
 
+These values are <strong>not pixels</strong>. If you want to obtain an array of RGB pixels as observations instead,
 
+use the <code class="docutils literal notranslate"><span class="pre">RGBImgPartialObsWrapper</span></code>. You can use it as follows:</p>
 
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gym</span>
 
+<span class="kn">from</span> <span class="nn">minigrid.wrappers</span> <span class="kn">import</span> <span class="n">RGBImgPartialObsWrapper</span><span class="p">,</span> <span class="n">ImgObsWrapper</span>
 
+
 
+<span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">&#39;MiniGrid-Empty-8x8-v0&#39;</span><span class="p">)</span>
 
+<span class="n">env</span> <span class="o">=</span> <span class="n">RGBImgPartialObsWrapper</span><span class="p">(</span><span class="n">env</span><span class="p">)</span> <span class="c1"># Get pixel observations</span>
 
+<span class="n">env</span> <span class="o">=</span> <span class="n">ImgObsWrapper</span><span class="p">(</span><span class="n">env</span><span class="p">)</span> <span class="c1"># Get rid of the &#39;mission&#39; field</span>
 
+<span class="n">obs</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> <span class="c1"># This now produces an RGB tensor only</span>
 
+</pre></div>
 
+</div>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          
+          <a class="prev-page" href="../../content/basic_usage/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Basic Usage</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

File diff suppressed because it is too large
+ 364 - 0
content/basic_usage/index.html


+ 333 - 0
content/installation/index.html
View File 

@@ -0,0 +1,333 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Basic Usage" href="../basic_usage/" /><link rel="prev" title="MiniGrid is a simple and easily configurable grid world environments for reinforcement learning" href="../../" />
 
+        <link rel="canonical" href="https://fenggu.me/content/installation.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Installation - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../environments/design/">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="installation">
 
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">#</a></h1>
 
+<p>There is now a <a class="reference external" href="https://pypi.org/project/minigrid/">pip package</a> available, which is updated periodically:</p>
 
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">gym</span><span class="o">-</span><span class="n">minigrid</span>
 
+</pre></div>
 
+</div>
 
+<p>Alternatively, to get the latest version of MiniGrid, you can clone this repository and install the dependencies with <code class="docutils literal notranslate"><span class="pre">pip3</span></code>:</p>
 
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">Farama</span><span class="o">-</span><span class="n">Foundation</span><span class="o">/</span><span class="n">MiniGrid</span>
 
+<span class="n">cd</span> <span class="n">MiniGrid</span>
 
+<span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span>
 
+</pre></div>
 
+</div>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../basic_usage/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Basic Usage</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 388 - 0
content/pubs/index.html
View File 

@@ -0,0 +1,388 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="General Structure" href="../../environments/design/" /><link rel="prev" title="Wrappers" href="../../api/wrappers/" />
 
+        <link rel="canonical" href="https://fenggu.me/content/pubs.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>List of publications - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../environments/design/">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../../environments/playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="list-of-publications">
 
+<h1>List of publications<a class="headerlink" href="#list-of-publications" title="Permalink to this headline">#</a></h1>
 
+<section id="list-of-publications-submissions-using-minigrid-or-babyai-please-open-a-pull-request-to-add-missing-entries">
 
+<h2>List of publications &amp; submissions using MiniGrid or BabyAI (please open a pull request to add missing entries):<a class="headerlink" href="#list-of-publications-submissions-using-minigrid-or-babyai-please-open-a-pull-request-to-add-missing-entries" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><a class="reference external" href="https://proceedings.mlr.press/v162/paischer22a.html">History Compression via Language Models in Reinforcement Learning.</a> (Johannes Kepler University Linz, PMLR 2022)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2202.02886">Leveraging Approximate Symbolic Models for Reinforcement Learning via Skill Diversity</a> (Arizona State University, ICML 2022)</p></li>
 
+<li><p><a class="reference external" href="https://proceedings.mlr.press/v162/mavor-parker22a.html">How to Stay Curious while avoiding Noisy TVs using Aleatoric Uncertainty Estimation</a> (University College London, Boston University, ICML 2022)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/pdf?id=rUwm9wCjURV">In a Nutshell, the Human Asked for This: Latent Goals for Following Temporal Specifications</a> (Imperial College London, ICLR 2022)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2111.13119">Interesting Object, Curious Agent: Learning Task-Agnostic Exploration</a> (Meta AI Research, NeurIPS 2021)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2111.04894">Safe Policy Optimization with Local Generalized Linear Function Approximations</a> (IBM Research, Tsinghua University, NeurIPS 2021)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2106.02097">A Consciousness-Inspired Planning Agent for Model-Based Reinforcement Learning</a> (Mila, McGill University, NeurIPS 2021)</p></li>
 
+<li><p><a class="reference external" href="http://www.ifaamas.org/Proceedings/aamas2021/pdfs/p1118.pdf">SPOTTER: Extending Symbolic Planning Operators through Targeted Reinforcement Learning</a> (Tufts University, SIFT, AAMAS 2021)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2102.04220">Grid-to-Graph: Flexible Spatial Relational Inductive Biases for Reinforcement Learning</a> (UCL, AAMAS 2021)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/forum?id=MtEE0CktZht">Rank the Episodes: A Simple Approach for Exploration in Procedurally-Generated Environments</a> (Texas A&amp;M University, Kuai Inc., ICLR 2021)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/forum?id=_mQp5cr_iNy">Adversarially Guided Actor-Critic</a> (INRIA, Google Brain, ICLR 2021)</p></li>
 
+<li><p><a class="reference external" href="https://papers.nips.cc/paper/2020/file/ec3183a7f107d1b8dbb90cb3c01ea7d5-Paper.pdf">Information-theoretic Task Selection for Meta-Reinforcement Learning</a> (University of Leeds, NeurIPS 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/2012.08621.pdf">BeBold: Exploration Beyond the Boundary of Explored Regions</a> (UCB, December 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/2010.08843">Approximate Information State for Approximate Planning and Reinforcement Learning in Partially Observed Systems</a> (McGill, October 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/2010.03934.pdf">Prioritized Level Replay</a> (FAIR, October 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/2008.12760.pdf">AllenAct: A Framework for Embodied AI Research</a> (Allen Institute for AI, August 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/2006.12122.pdf">Learning with AMIGO: Adversarially Motivated Intrinsic Goals</a> (MIT, FAIR, ICLR 2021)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/forum?id=rkg-TJBFPB">RIDE: Rewarding Impact-Driven Exploration for Procedurally-Generated Environments</a> (FAIR, ICLR 2020)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/1912.05525.pdf">Learning to Request Guidance in Emergent Communication</a> (University of Amsterdam, Dec 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1911.07141">Working Memory Graphs</a> (MSR, Nov 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/1910.04040.pdf">Fast Task-Adaptation for Tasks Labeled Using Natural Language in Reinforcement Learning</a> (Oct 2019, University of Antwerp)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1910.12911">Generalization in Reinforcement Learning with Selective Noise Injection and Information Bottleneck</a> (MSR, NeurIPS, Oct 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/1909.10893.pdf">Recurrent Independent Mechanisms</a> (Mila, Sept 2019)</p></li>
 
+<li><p><a class="reference external" href="http://surl.tirl.info/proceedings/SURL-2019_paper_10.pdf">Learning Effective Subgoals with Multi-Task Hierarchical Reinforcement Learning</a> (Tsinghua University, August 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1908.05135">Mastering emergent language: learning to guide in simulated navigation</a> (University of Amsterdam, Aug 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1906.03574">Transfer Learning by Modeling a Distribution over Policies</a> (Mila, June 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1906.10667">Reinforcement Learning with Competitive Ensembles of Information-Constrained Primitives</a> (Mila, June 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1905.11589">Learning distant cause and effect using only local and immediate credit assignment</a> (Incubator 491, May 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1904.04700">Practical Open-Loop Optimistic Planning</a> (INRIA, April 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1907.00664">Learning World Graphs to Accelerate Hierarchical Reinforcement Learning</a> (Salesforce Research, 2019)</p></li>
 
+<li><p><a class="reference external" href="https://mila.quebec/wp-content/uploads/2019/05/WebPage.pdf">Variational State Encoding as Intrinsic Motivation in Reinforcement Learning</a> (Mila, TARL 2019)</p></li>
 
+<li><p><a class="reference external" href="https://tarl2019.github.io/assets/papers/modhe2019unsupervised.pdf">Unsupervised Discovery of Decision States Through Intrinsic Control</a> (Georgia Tech, TARL 2019)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/forum?id=SkgQBn0cF7">Modeling the Long Term Future in Model-Based Reinforcement Learning</a> (Mila, ICLR 2019)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/pdf/1902.10646.pdf">Unifying Ensemble Methods for Q-learning via Social Choice Theory</a> (Max Planck Institute, Feb 2019)</p></li>
 
+<li><p><a class="reference external" href="https://personalrobotics.cs.washington.edu/workshops/mlmp2018/assets/docs/18_CameraReadySubmission.pdf">Planning Beyond The Sensing Horizon Using a Learned Context</a> (MLMP&#64;IROS, 2018)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1811.07882">Guiding Policies with Language via Meta-Learning</a> (UC Berkeley, Nov 2018)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1811.06889">On the Complexity of Exploration in Goal-Driven Navigation</a> (CMU, NeurIPS, Nov 2018)</p></li>
 
+<li><p><a class="reference external" href="https://openreview.net/forum?id=rJg8yhAqKm">Transfer and Exploration via the Information Bottleneck</a> (Mila, Nov 2018)</p></li>
 
+<li><p><a class="reference external" href="https://gupea.ub.gu.se/bitstream/2077/62445/1/gupea_2077_62445_1.pdf">Creating safer reward functions for reinforcement learning agents in the gridworld</a> (University of Gothenburg, 2018)</p></li>
 
+<li><p><a class="reference external" href="https://arxiv.org/abs/1810.08272">BabyAI: First Steps Towards Grounded Language Learning With a Human In the Loop</a> (Mila, ICLR, Oct 2018)</p></li>
 
+</ul>
 
+<p>This environment has been built as part of work done at <a class="reference external" href="https://mila.quebec">Mila</a>. The Dynamic obstacles environment has been added as part of work done at <a class="reference external" href="https://www.ias.informatik.tu-darmstadt.de/">IAS in TU Darmstadt</a> and the University of Genoa for mobile robot navigation with dynamic obstacles.</p>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../../environments/design/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">General Structure</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">List of publications</a><ul>
 
+<li><a class="reference internal" href="#list-of-publications-submissions-using-minigrid-or-babyai-please-open-a-pull-request-to-add-missing-entries">List of publications &amp; submissions using MiniGrid or BabyAI (please open a pull request to add missing entries):</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 444 - 0
environments/blocked_unlock_pickup/index.html
View File 

@@ -0,0 +1,444 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Obstructed Maze" href="../obstructed_maze/" /><link rel="prev" title="Unlock Pickup" href="../unlock_pickup/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/blocked_unlock_pickup.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Blocked Unlock Pickup - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="blocked-unlock-pickup">
 
+<h1>Blocked Unlock Pickup<a class="headerlink" href="#blocked-unlock-pickup" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>The agent has to pick up a box which is placed in another room, behind a
 
+locked door. The door is also blocked by a ball which the agent has to move
 
+before it can unlock the door. Hence, the agent has to learn to move the
 
+ball, pick up the key, open the door and pick up the object in the other
 
+room. This environment can be solved without relying on language.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“pick up the {color} {type}”</p>
 
+<p>{color} is the color of the box. Can be “red”, “green”, “blue”, “purple”,
 
+“yellow” or “grey”.</p>
 
+<p>{type} is the type of the object. Can be “box” or “key”.</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent picks up the correct box.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-BlockedUnlockPickup-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../obstructed_maze/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Obstructed Maze</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../unlock_pickup/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Unlock Pickup</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Blocked Unlock Pickup</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 363 - 0
environments/design/index.html
View File 

@@ -0,0 +1,363 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Included environments" href="../" /><link rel="prev" title="List of publications" href="../../content/pubs/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/design.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>General Structure - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">General Structure</a></li>
 
+<li class="toctree-l1 has-children"><a class="reference internal" href="../">Included environments</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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="general-structure">
 
+<h1>General Structure<a class="headerlink" href="#general-structure" title="Permalink to this headline">#</a></h1>
 
+<p>Structure of the world:</p>
 
+<ul class="simple">
 
+<li><p>The world is an NxM grid of tiles</p></li>
 
+<li><p>Each tile in the grid world contains zero or one object</p>
 
+<ul>
 
+<li><p>Cells that do not contain an object have the value <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
 
+</ul>
 
+</li>
 
+<li><p>Each object has an associated discrete color (string)</p></li>
 
+<li><p>Each object has an associated type (string)</p>
 
+<ul>
 
+<li><p>Provided object types are: wall, floor, lava, door, key, ball, box and goal</p></li>
 
+</ul>
 
+</li>
 
+<li><p>The agent can pick up and carry exactly one object (eg: ball or key)</p></li>
 
+<li><p>To open a locked door, the agent has to be carrying a key matching the door’s color</p></li>
 
+</ul>
 
+<p>Actions in the basic environment:</p>
 
+<ul class="simple">
 
+<li><p>Turn left</p></li>
 
+<li><p>Turn right</p></li>
 
+<li><p>Move forward</p></li>
 
+<li><p>Pick up an object</p></li>
 
+<li><p>Drop the object being carried</p></li>
 
+<li><p>Toggle (open doors, interact with objects)</p></li>
 
+<li><p>Done (task completed, optional)</p></li>
 
+</ul>
 
+<p>Default tile/observation encoding:</p>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple: <code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in <span class="xref myst">minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+<p>By default, sparse rewards are given for reaching a green goal tile. A
 
+reward of 1 is given for success, and zero for failure. There is also an
 
+environment-specific time step limit for completing the task.
 
+You can define your own reward function by creating a class derived
 
+from <code class="docutils literal notranslate"><span class="pre">MiniGridEnv</span></code>. Extending the environment with new object types or new actions
 
+should be very easy. If you wish to do this, you should take a look at the
 
+<span class="xref myst">minigrid/minigrid.py</span> source file.</p>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Included environments</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 445 - 0
environments/dist_shift2/index.html
View File 

@@ -0,0 +1,445 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Lava Gap S7" href="../lava_gap_s7/" /><link rel="prev" title="Obstructed Maze" href="../obstructed_maze/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/dist_shift2.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Dist Shift2 - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="dist-shift2">
 
+<h1>Dist Shift2<a class="headerlink" href="#dist-shift2" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is based on one of the DeepMind [AI safety gridworlds]
 
+(https://github.com/deepmind/ai-safety-gridworlds). The agent starts in the
 
+top-left corner and must reach the goal which is in the top-right corner,
 
+but has to avoid stepping into lava on its way. The aim of this environment
 
+is to test an agent’s ability to generalize. There are two slightly
 
+different variants of the environment, so that the agent can be trained on
 
+one variant and tested on the other.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“get to the green goal square”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>The agent falls into lava.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DistShift1-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DistShift2-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../lava_gap_s7/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Lava Gap S7</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../obstructed_maze/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Obstructed Maze</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Dist Shift2</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 443 - 0
environments/door_key/index.html
View File 

@@ -0,0 +1,443 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Multi Room" href="../multi_room/" /><link rel="prev" title="Four Rooms" href="../four_rooms/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/door_key.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Door Key - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="door-key">
 
+<h1>Door Key<a class="headerlink" href="#door-key" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment has a key that the agent must pick up in order to unlock a
 
+goal and then get to the green goal square. This environment is difficult,
 
+because of the sparse reward, to solve using classical RL algorithms. It is
 
+useful to experiment with curiosity or curriculum learning.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“use the key to open the door and then get to the goal”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Toggle/activate an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DoorKey-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DoorKey-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DoorKey-8x8-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-DoorKey-16x16-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../multi_room/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Multi Room</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../four_rooms/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Four Rooms</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Door Key</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 449 - 0
environments/dynamic/index.html
View File 

@@ -0,0 +1,449 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Go To Object" href="../go_to_object/" /><link rel="prev" title="Simple Crossing S11 N5" href="../simple_crossing_s11_n5/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/dynamic.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Dynamic - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="dynamic">
 
+<h1>Dynamic<a class="headerlink" href="#dynamic" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is an empty room with moving obstacles.
 
+The goal of the agent is to reach the green goal square without colliding
 
+with any obstacle. A large penalty is subtracted if the agent collides with
 
+an obstacle and the episode finishes. This environment is useful to test
 
+Dynamic Obstacle Avoidance for mobile robots with Reinforcement Learning in
 
+Partial Observability.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“get to the green goal square”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure. A ‘-1’ penalty is
 
+subtracted if the agent collides with an obstacle.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>The agent collides with an obstacle.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-Random-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-Random-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-8x8-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Dynamic-Obstacles-16x16-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../go_to_object/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Go To Object</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../simple_crossing_s11_n5/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Simple Crossing S11 N5</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Dynamic</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 449 - 0
environments/empty/index.html
View File 

@@ -0,0 +1,449 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Four Rooms" href="../four_rooms/" /><link rel="prev" title="Included environments" href="../" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/empty.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Empty - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="empty">
 
+<h1>Empty<a class="headerlink" href="#empty" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is an empty room, and the goal of the agent is to reach the
 
+green goal square, which provides a sparse reward. A small penalty is
 
+subtracted for the number of steps to reach the goal. This environment is
 
+useful, with small rooms, to validate that your RL algorithm works
 
+correctly, and with large rooms to experiment with sparse rewards and
 
+exploration. The random variants of the environment have the agent starting
 
+at a random position for each episode, while the regular variants have the
 
+agent always starting in the corner opposite to the goal.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“get to the green goal square”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-Random-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-Random-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-8x8-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Empty-16x16-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../four_rooms/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Four Rooms</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Included environments</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Empty</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 449 - 0
environments/fetch/index.html
View File 

@@ -0,0 +1,449 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Go To Door" href="../go_to_door/" /><link rel="prev" title="Multi Room" href="../multi_room/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/fetch.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Fetch - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="fetch">
 
+<h1>Fetch<a class="headerlink" href="#fetch" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment has multiple objects of assorted types and colors. The
 
+agent receives a textual string as part of its observation telling it which
 
+object to pick up. Picking up the wrong object terminates the episode with
 
+zero reward.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“{syntax} {color} {type}”</p>
 
+<p>{syntax} is one of the following: “get a”, “go get a”, “fetch a”,
 
+“go fetch a”, “you must fetch a”.</p>
 
+<p>{color} is the color of the box. Can be “red”, “green”, “blue”, “purple”,
 
+“yellow” or “grey”.</p>
 
+<p>{type} is the type of the object. Can be “key” or “ball”.</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent picks up the correct object.</p></li>
 
+<li><p>The agent picks up the wrong object.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<p>N: number of objects to be generated.</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Fetch-5x5-N2-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Fetch-6x6-N2-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-Fetch-8x8-N3-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../go_to_door/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Go To Door</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../multi_room/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Multi Room</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Fetch</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 440 - 0
environments/four_rooms/index.html
View File 

@@ -0,0 +1,440 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Door Key" href="../door_key/" /><link rel="prev" title="Empty" href="../empty/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/four_rooms.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Four Rooms - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="four-rooms">
 
+<h1>Four Rooms<a class="headerlink" href="#four-rooms" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>Classic four room reinforcement learning environment. The agent must
 
+navigate in a maze composed of four rooms interconnected by 4 gaps in the
 
+walls. To obtain a reward, the agent must reach the green goal square. Both
 
+the agent and the goal square are randomly placed in any of the four rooms.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“reach the goal”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-FourRooms-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../door_key/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Door Key</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../empty/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Empty</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Four Rooms</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 445 - 0
environments/go_to_door/index.html
View File 

@@ -0,0 +1,445 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Put Near" href="../put_near/" /><link rel="prev" title="Fetch" href="../fetch/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/go_to_door.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Go To Door - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="go-to-door">
 
+<h1>Go To Door<a class="headerlink" href="#go-to-door" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is a room with four doors, one on each wall. The agent
 
+receives a textual (mission) string as input, telling it which door to go
 
+to, (eg: “go to the red door”). It receives a positive reward for performing
 
+the <code class="docutils literal notranslate"><span class="pre">done</span></code> action next to the correct door, as indicated in the mission
 
+string.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“go to the {color} door”</p>
 
+<p>{color} is the color of the door. Can be “red”, “green”, “blue”, “purple”,
 
+“yellow” or “grey”.</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Done completing task</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent stands next the correct door performing the <code class="docutils literal notranslate"><span class="pre">done</span></code> action.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-GoToDoor-5x5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-GoToDoor-6x6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-GoToDoor-8x8-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../put_near/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Put Near</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../fetch/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Fetch</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Go To Door</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 335 - 0
environments/go_to_object/index.html
View File 

@@ -0,0 +1,335 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Playground" href="../playground/" /><link rel="prev" title="Dynamic" href="../dynamic/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/go_to_object.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Go To Object - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="go-to-object">
 
+<h1>Go To Object<a class="headerlink" href="#go-to-object" title="Permalink to this headline">#</a></h1>
 
+<p>Environment in which the agent is instructed to go to a given object
 
+named using an English text string</p>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../playground/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Playground</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../dynamic/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Dynamic</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 321 - 0
environments/index.html
View File 

@@ -0,0 +1,321 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" /><link rel="next" title="Empty" href="empty/" /><link rel="prev" title="General Structure" href="design/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/index.html" />
 
+
 
+    <link rel="shortcut icon" href="../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Included environments - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 
+<li class="toctree-l2"><a class="reference internal" href="empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="included-environments">
 
+<h1>Included environments<a class="headerlink" href="#included-environments" title="Permalink to this headline">#</a></h1>
 
+<p>The environments listed below are implemented in the <span class="xref myst">minigrid/envs</span> directory.
 
+Each environment provides one or more configurations registered with OpenAI gym. Each environment
 
+is also programmatically tunable in terms of size/complexity, which is useful for curriculum learning
 
+or to fine-tune difficulty.</p>
 
+<div class="toctree-wrapper compound">
 
+</div>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          
+          
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 
+    <script src="../_static/jquery.js"></script>
 
+    <script src="../_static/underscore.js"></script>
 
+    <script src="../_static/doctools.js"></script>
 
+    <script src="../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 453 - 0
environments/key_corridor_s6_r3/index.html
View File 

@@ -0,0 +1,453 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Unlock" href="../unlock/" /><link rel="prev" title="Locked Room" href="../locked_room/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/key_corridor_s6_r3.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Key Corridor S6 R3 - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="key-corridor-s6-r3">
 
+<h1>Key Corridor S6 R3<a class="headerlink" href="#key-corridor-s6-r3" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is similar to the locked room environment, but there are
 
+multiple registered environment configurations of increasing size,
 
+making it easier to use curriculum learning to train an agent to solve it.
 
+The agent has to pick up an object which is behind a locked door. The key is
 
+hidden in another room, and the agent has to explore the environment to find
 
+it. The mission string does not give the agent any clues as to where the
 
+key is placed. This environment can be solved without relying on language.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“pick up the {color} {obj_type}”</p>
 
+<p>{color} is the color of the object. Can be “red”, “green”, “blue”, “purple”,
 
+“yellow” or “grey”.</p>
 
+<p>{type} is the type of the object. Can be “ball” or “key”.</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent picks up the correct object.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<p>S: room size.
 
+R: Number of rows.</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS3R1-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS3R2-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS3R3-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS4R3-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS5R3-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-KeyCorridorS6R3-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../unlock/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Unlock</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../locked_room/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Locked Room</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Key Corridor S6 R3</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 448 - 0
environments/lava_gap_s7/index.html
View File 

@@ -0,0 +1,448 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Simple Crossing S11 N5" href="../simple_crossing_s11_n5/" /><link rel="prev" title="Dist Shift2" href="../dist_shift2/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/lava_gap_s7.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Lava Gap S7 - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="lava-gap-s7">
 
+<h1>Lava Gap S7<a class="headerlink" href="#lava-gap-s7" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>The agent has to reach the green goal square at the opposite corner of the
 
+room, and must pass through a narrow gap in a vertical strip of deadly lava.
 
+Touching the lava terminate the episode with a zero reward. This environment
 
+is useful for studying safety and safe exploration.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>Depending on the <code class="docutils literal notranslate"><span class="pre">obstacle_type</span></code> parameter:</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">Lava</span></code>: “avoid the lava and get to the green goal square”</p></li>
 
+<li><p>otherwise: “find the opening and get to the green goal square”</p></li>
 
+</ul>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>The agent falls into lava.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<p>S: size of map SxS.</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-LavaGapS5-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-LavaGapS6-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-LavaGapS7-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../simple_crossing_s11_n5/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Simple Crossing S11 N5</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../dist_shift2/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Dist Shift2</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Lava Gap S7</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 443 - 0
environments/locked_room/index.html
View File 

@@ -0,0 +1,443 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Key Corridor S6 R3" href="../key_corridor_s6_r3/" /><link rel="prev" title="Memory S7" href="../memory_s7/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/locked_room.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Locked Room - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="locked-room">
 
+<h1>Locked Room<a class="headerlink" href="#locked-room" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>The environment has six rooms, one of which is locked. The agent receives
 
+a textual mission string as input, telling it which room to go to in order
 
+to get the key that opens the locked room. It then has to go into the locked
 
+room in order to reach the final goal. This environment is extremely
 
+difficult to solve with vanilla reinforcement learning alone.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“get the {lockedroom_color} key from the {keyroom_color} room, unlock the {door_color} door and go to the goal”</p>
 
+<p>{lockedroom_color}, {keyroom_color}, and {door_color} can be “red”, “green”,
 
+“blue”, “purple”, “yellow” or “grey”.</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Toggle/activate an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-LockedRoom-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../key_corridor_s6_r3/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Key Corridor S6 R3</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../memory_s7/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Memory S7</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Locked Room</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 446 - 0
environments/memory_s7/index.html
View File 

@@ -0,0 +1,446 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Locked Room" href="../locked_room/" /><link rel="prev" title="Red Blue Doors" href="../red_blue_doors/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/memory_s7.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Memory S7 - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="memory-s7">
 
+<h1>Memory S7<a class="headerlink" href="#memory-s7" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment is a memory test. The agent starts in a small room where it
 
+sees an object. It then has to go through a narrow hallway which ends in a
 
+split. At each end of the split there is an object, one of which is the same
 
+as the object in the starting room. The agent has to remember the initial
 
+object, and go to the matching object at split.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“go to the matching object at the end of the hallway”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Pick up an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Toggle/activate an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the correct matching object.</p></li>
 
+<li><p>The agent reaches the wrong matching object.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<p>S: size of map SxS.</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MemoryS17Random-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MemoryS13Random-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MemoryS13-v0</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MemoryS11-v0</span></code></p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../locked_room/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Locked Room</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../red_blue_doors/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Red Blue Doors</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Memory S7</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 445 - 0
environments/multi_room/index.html
View File 

@@ -0,0 +1,445 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Fetch" href="../fetch/" /><link rel="prev" title="Door Key" href="../door_key/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/multi_room.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Multi Room - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="multi-room">
 
+<h1>Multi Room<a class="headerlink" href="#multi-room" title="Permalink to this headline">#</a></h1>
 
+<section id="description">
 
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">#</a></h2>
 
+<p>This environment has a series of connected rooms with doors that must be
 
+opened in order to get to the next room. The final room has the green goal
 
+square the agent must get to. This environment is extremely difficult to
 
+solve using RL alone. However, by gradually increasing the number of rooms
 
+and building a curriculum, the environment can be solved.</p>
 
+</section>
 
+<section id="mission-space">
 
+<h2>Mission Space<a class="headerlink" href="#mission-space" title="Permalink to this headline">#</a></h2>
 
+<p>“traverse the rooms to get to the goal”</p>
 
+</section>
 
+<section id="action-space">
 
+<h2>Action Space<a class="headerlink" href="#action-space" title="Permalink to this headline">#</a></h2>
 
+<div class="table-wrapper colwidths-auto docutils container">
 
+<table class="colwidths-auto docutils align-default">
 
+<thead>
 
+<tr class="row-odd"><th class="head"><p>Num</p></th>
 
+<th class="head"><p>Name</p></th>
 
+<th class="head"><p>Action</p></th>
 
+</tr>
 
+</thead>
 
+<tbody>
 
+<tr class="row-even"><td><p>0</p></td>
 
+<td><p>left</p></td>
 
+<td><p>Turn left</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>1</p></td>
 
+<td><p>right</p></td>
 
+<td><p>Turn right</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>2</p></td>
 
+<td><p>forward</p></td>
 
+<td><p>Move forward</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>3</p></td>
 
+<td><p>pickup</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>4</p></td>
 
+<td><p>drop</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+<tr class="row-odd"><td><p>5</p></td>
 
+<td><p>toggle</p></td>
 
+<td><p>Toggle/activate an object</p></td>
 
+</tr>
 
+<tr class="row-even"><td><p>6</p></td>
 
+<td><p>done</p></td>
 
+<td><p>Unused</p></td>
 
+</tr>
 
+</tbody>
 
+</table>
 
+</div>
 
+</section>
 
+<section id="observation-encoding">
 
+<h2>Observation Encoding<a class="headerlink" href="#observation-encoding" title="Permalink to this headline">#</a></h2>
 
+<ul class="simple">
 
+<li><p>Each tile is encoded as a 3 dimensional tuple:
 
+<code class="docutils literal notranslate"><span class="pre">(OBJECT_IDX,</span> <span class="pre">COLOR_IDX,</span> <span class="pre">STATE)</span></code></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">OBJECT_TO_IDX</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_TO_IDX</span></code> mapping can be found in
 
+<span class="xref myst">gym_minigrid/minigrid.py</span></p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">STATE</span></code> refers to the door state with 0=open, 1=closed and 2=locked</p></li>
 
+</ul>
 
+</section>
 
+<section id="rewards">
 
+<h2>Rewards<a class="headerlink" href="#rewards" title="Permalink to this headline">#</a></h2>
 
+<p>A reward of ‘1’ is given for success, and ‘0’ for failure.</p>
 
+</section>
 
+<section id="termination">
 
+<h2>Termination<a class="headerlink" href="#termination" title="Permalink to this headline">#</a></h2>
 
+<p>The episode ends if any one of the following conditions is met:</p>
 
+<ol class="arabic simple">
 
+<li><p>The agent reaches the goal.</p></li>
 
+<li><p>Timeout (see <code class="docutils literal notranslate"><span class="pre">max_steps</span></code>).</p></li>
 
+</ol>
 
+</section>
 
+<section id="registered-configurations">
 
+<h2>Registered Configurations<a class="headerlink" href="#registered-configurations" title="Permalink to this headline">#</a></h2>
 
+<p>S: size of map SxS.
 
+N: number of rooms.</p>
 
+<ul class="simple">
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MultiRoom-N2-S4-v0</span></code> (two small rooms)</p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MultiRoom-N4-S5-v0</span></code> (four rooms)</p></li>
 
+<li><p><code class="docutils literal notranslate"><span class="pre">MiniGrid-MultiRoom-N6-v0</span></code> (six rooms)</p></li>
 
+</ul>
 
+</section>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../fetch/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Fetch</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../door_key/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Door Key</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer">
 
+      
+      
+      <div class="toc-sticky toc-scroll">
 
+        <div class="toc-title-container">
 
+          <span class="toc-title">
 
+            On this page
 
+          </span>
 
+        </div>
 
+        <div class="toc-tree-container">
 
+          <div class="toc-tree">
 
+            <ul>
 
+<li><a class="reference internal" href="#">Multi Room</a><ul>
 
+<li><a class="reference internal" href="#description">Description</a></li>
 
+<li><a class="reference internal" href="#mission-space">Mission Space</a></li>
 
+<li><a class="reference internal" href="#action-space">Action Space</a></li>
 
+<li><a class="reference internal" href="#observation-encoding">Observation Encoding</a></li>
 
+<li><a class="reference internal" href="#rewards">Rewards</a></li>
 
+<li><a class="reference internal" href="#termination">Termination</a></li>
 
+<li><a class="reference internal" href="#registered-configurations">Registered Configurations</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+
 
+          </div>
 
+        </div>
 
+      </div>
 
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 336 - 0
environments/obstructed_maze/index.html
View File 

@@ -0,0 +1,336 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Dist Shift2" href="../dist_shift2/" /><link rel="prev" title="Blocked Unlock Pickup" href="../blocked_unlock_pickup/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/obstructed_maze.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Obstructed Maze - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../playground/">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="obstructed-maze">
 
+<h1>Obstructed Maze<a class="headerlink" href="#obstructed-maze" title="Permalink to this headline">#</a></h1>
 
+<p>A blue ball is hidden in one of the 4 corners of a 3x3 maze. Doors
 
+are locked, doors are obstructed by a ball and keys are hidden in
 
+boxes.</p>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../dist_shift2/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">Dist Shift2</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../blocked_unlock_pickup/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Blocked Unlock Pickup</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 335 - 0
environments/playground/index.html
View File 

@@ -0,0 +1,335 @@
 
+<!doctype html>
 
+<html class="no-js">
 
+  <head><meta charset="utf-8"/>
 
+    <meta name="viewport" content="width=device-width,initial-scale=1"/>
 
+    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
+<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="404" href="../../404/" /><link rel="prev" title="Go To Object" href="../go_to_object/" />
 
+        <link rel="canonical" href="https://fenggu.me/environments/playground.html" />
 
+
 
+    <link rel="shortcut icon" href="../../_static/minigrid-white.png"/><meta name="generator" content="sphinx-4.2.0, furo 2022.06.21"/>
 
+        <title>Playground - MiniGrid Documentation</title>
 
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
+    <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css" />
 
+    
+    
+
 
+
 
+<style>
 
+  body {
 
+    --color-code-background: #f8f8f8;
 
+  --color-code-foreground: black;
 
+  
+  }
 
+  @media not print {
 
+    body[data-theme="dark"] {
 
+      --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+    }
 
+    @media (prefers-color-scheme: dark) {
 
+      body:not([data-theme="light"]) {
 
+        --color-code-background: #202020;
 
+  --color-code-foreground: #d0d0d0;
 
+  
+      }
 
+    }
 
+  }
 
+</style></head>
 
+  <body>
 
+    
+    <script>
 
+      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 
+    </script>
 
+    
+
 
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 
+  <symbol id="svg-toc" viewBox="0 0 24 24">
 
+    <title>Contents</title>
 
+    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 
+      <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"/>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-menu" viewBox="0 0 24 24">
 
+    <title>Menu</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 
+      <line x1="3" y1="12" x2="21" y2="12"></line>
 
+      <line x1="3" y1="6" x2="21" y2="6"></line>
 
+      <line x1="3" y1="18" x2="21" y2="18"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 
+    <title>Expand</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 
+      <polyline points="9 18 15 12 9 6"></polyline>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun" viewBox="0 0 24 24">
 
+    <title>Light mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 
+      <circle cx="12" cy="12" r="5"></circle>
 
+      <line x1="12" y1="1" x2="12" y2="3"></line>
 
+      <line x1="12" y1="21" x2="12" y2="23"></line>
 
+      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 
+      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 
+      <line x1="1" y1="12" x2="3" y2="12"></line>
 
+      <line x1="21" y1="12" x2="23" y2="12"></line>
 
+      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 
+      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-moon" viewBox="0 0 24 24">
 
+    <title>Dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
 
+      <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" />
 
+    </svg>
 
+  </symbol>
 
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
 
+    <title>Auto light/dark mode</title>
 
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
 
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
 
+      <circle cx="12" cy="12" r="9" />
 
+      <path d="M13 12h5" />
 
+      <path d="M13 15h4" />
 
+      <path d="M13 18h1" />
 
+      <path d="M13 9h4" />
 
+      <path d="M13 6h1" />
 
+    </svg>
 
+  </symbol>
 
+</svg>
 
+
 
+<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 
+<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 
+<label class="overlay sidebar-overlay" for="__navigation">
 
+  <div class="visually-hidden">Hide navigation sidebar</div>
 
+</label>
 
+<label class="overlay toc-overlay" for="__toc">
 
+  <div class="visually-hidden">Hide table of contents sidebar</div>
 
+</label>
 
+
 
+
 
+
 
+<div class="page">
 
+  <header class="mobile-header">
 
+    <div class="header-left">
 
+      <label class="nav-overlay-icon" for="__navigation">
 
+        <div class="visually-hidden">Toggle site navigation sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
 
+      </label>
 
+    </div>
 
+    <div class="header-center">
 
+      <a href="../../"><div class="brand">MiniGrid Documentation</div></a>
 
+    </div>
 
+    <div class="header-right">
 
+      <div class="theme-toggle-container theme-toggle-header">
 
+        <button class="theme-toggle">
 
+          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+        </button>
 
+      </div>
 
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
 
+        <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+      </label>
 
+    </div>
 
+  </header>
 
+  <aside class="sidebar-drawer">
 
+    <div class="sidebar-container">
 
+      
+      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../">
 
+  
+  <div class="sidebar-logo-container">
 
+    <img class="sidebar-logo only-light" src="../../_static/img/minigrid.png" alt="Light Logo"/>
 
+    <img class="sidebar-logo only-dark" src="../../_static/img/minigrid-white.png" alt="Dark Logo"/>
 
+  </div>
 
+  
+  <span class="sidebar-brand-text">MiniGrid Documentation</span>
 
+  
+</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
 
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
 
+  <input type="hidden" name="check_keywords" value="yes">
 
+  <input type="hidden" name="area" value="default">
 
+</form>
 
+<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
 
+  <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/installation/">Installation</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/basic_usage/">Basic Usage</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../api/wrappers/">Wrappers</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../content/pubs/">List of publications</a></li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 
+<ul class="current">
 
+<li class="toctree-l1"><a class="reference internal" href="../design/">General Structure</a></li>
 
+<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Included environments</a><input checked="" 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 child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
 
+<li class="toctree-l2"><a class="reference internal" href="../empty/">Empty</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../four_rooms/">Four Rooms</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../door_key/">Door Key</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../multi_room/">Multi Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../fetch/">Fetch</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_door/">Go To Door</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../put_near/">Put Near</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../red_blue_doors/">Red Blue Doors</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../memory_s7/">Memory S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../locked_room/">Locked Room</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../key_corridor_s6_r3/">Key Corridor S6 R3</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock/">Unlock</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../unlock_pickup/">Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../blocked_unlock_pickup/">Blocked Unlock Pickup</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../obstructed_maze/">Obstructed Maze</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dist_shift2/">Dist Shift2</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../lava_gap_s7/">Lava Gap S7</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../simple_crossing_s11_n5/">Simple Crossing S11 N5</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../dynamic/">Dynamic</a></li>
 
+<li class="toctree-l2"><a class="reference internal" href="../go_to_object/">Go To Object</a></li>
 
+<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Playground</a></li>
 
+</ul>
 
+</li>
 
+</ul>
 
+<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 
+<ul>
 
+<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
 
+<li class="toctree-l1"><a class="reference external" href="https://farama.org/donations">Donate</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="../../404/">Contribute to the Docs</a></li>
 
+</ul>
 
+
 
+</div>
 
+</div>
 
+
 
+      </div>
 
+      
+    </div>
 
+  </aside>
 
+  <div class="main">
 
+    <div class="content">
 
+      <div class="article-container">
 
+        <a href="#" class="back-to-top muted-link">
 
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
 
+            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
 
+          </svg>
 
+          <span>Back to top</span>
 
+        </a>
 
+        <div class="content-icon-container">
 
+          <div class="theme-toggle-container theme-toggle-content">
 
+            <button class="theme-toggle">
 
+              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
 
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
 
+              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
 
+              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
 
+            </button>
 
+          </div>
 
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
 
+            <div class="visually-hidden">Toggle table of contents sidebar</div>
 
+            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
 
+          </label>
 
+        </div>
 
+        <article role="main">
 
+          <section id="playground">
 
+<h1>Playground<a class="headerlink" href="#playground" title="Permalink to this headline">#</a></h1>
 
+<p>Environment with multiple rooms and random objects.
 
+This environment has no specific goals or rewards.</p>
 
+</section>
 
+
 
+        </article>
 
+      </div>
 
+      <footer>
 
+        
+        <div class="related-pages">
 
+          <a class="next-page" href="../../404/">
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Next</span>
 
+                </div>
 
+                <div class="title">404</div>
 
+              </div>
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+            </a>
 
+          <a class="prev-page" href="../go_to_object/">
 
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
 
+              <div class="page-info">
 
+                <div class="context">
 
+                  <span>Previous</span>
 
+                </div>
 
+                
+                <div class="title">Go To Object</div>
 
+                
+              </div>
 
+            </a>
 
+        </div>
 
+        <div class="bottom-of-page">
 
+          <div class="left-details">
 
+            <div class="copyright">
 
+                Copyright &#169; 2022
 
+            </div>
 
+            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
+            
+            <a href="https://github.com/pradyunsg/furo">Furo</a>
 
+            
+          </div>
 
+          <div class="right-details">
 
+            <div class="icons">
 
+              
+            </div>
 
+          </div>
 
+        </div>
 
+        
+      </footer>
 
+    </div>
 
+    <aside class="toc-drawer no-toc">
 
+      
+      
+      
+    </aside>
 
+  </div>
 
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
 
+    <script src="../../_static/jquery.js"></script>
 
+    <script src="../../_static/underscore.js"></script>
 
+    <script src="../../_static/doctools.js"></script>
 
+    <script src="../../_static/scripts/furo.js"></script>
 
+    
+
 
+<script>
 
+    (() => {
 
+        if (!localStorage.getItem("shownCookieAlert")) {
 
+            const boxElem = document.createElement("div");
 
+            boxElem.classList.add("cookie_alert");
 
+            const containerElem = document.createElement("div");
 
+            containerElem.classList.add("cookie_container");
 
+            const textElem = document.createElement("p");
 
+            textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
 
+                                Google Analytics</a> to collect statistics. You can disable it by blocking
 
+                                the JavaScript coming from www.google-analytics.com.`;
 
+                                containerElem.appendChild(textElem);
 
+            const closeBtn = document.createElement("button");
 
+            closeBtn.innerHTML = `<?xml version="1.0" ?><svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-linejoin:round;stroke-width:2px;}</style></defs><title/><g id="cross"><line class="cls-1" x1="7" x2="25" y1="7" y2="25"/><line class="cls-1" x1="7" x2="25" y1="25" y2="7"/></g></svg>`
 
+            closeBtn.onclick = () => {
 
+                localStorage.setItem("shownCookieAlert", "true");
 
+                boxElem.style.display = "none";
 
+            }
 
+            containerElem.appendChild(closeBtn);
 
+            boxElem.appendChild(containerElem);
 
+            document.body.appendChild(boxElem);
 
+        }
 
+    })()
 
+
 
+</script>
 
+
 
+<!-- Google tag (gtag.js) -->
 
+<script async src="https://www.googletagmanager.com/gtag/js?id=G-JGXSLW7N06"></script>
 
+<script>
 
+  window.dataLayer = window.dataLayer || [];
 
+  function gtag(){dataLayer.push(arguments);}
 
+  gtag('js', new Date());
 
+
 
+  gtag('config', 'G-JGXSLW7N06');
 
+</script></body>
 
+</html>

+ 0 - 0
environments/put_near/index.html
View File


Some files were not shown because too many files changed in this diff