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
Branch: gh-pages
Branches Tags
Gym-MiniGrid
/
_modules
/
minigrid
/
wrappers
/
index.html

index.html 137 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596 
  1. <!doctype html>
    2. 

  2. <html class="no-js" lang="en" data-content_root="../../../">
    3. 

  3.   <head><meta charset="utf-8"/>
    4. 

  4.     <meta name="viewport" content="width=device-width,initial-scale=1"/>
    5. 

  5.     <meta name="color-scheme" content="light dark">
    6. 

  6.     <meta name="description" content="Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.">
    7. 

  7.     <meta property="og:title" content="MiniGrid Documentation" />
    8. 

  8.     <meta property="og:type" content="website" />
    9. 

  9.     <meta property="og:description" content="Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid." />
    10. 

  10.     <meta property="og:url" content="https://minigrid.farama.org/_modules/minigrid/wrappers.html" /><meta property="og:image" content="https://minigrid.farama.org//_static/img/minigrid-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../genindex/" /><link rel="search" title="Search" href="../../../search/" />
    11. 

  11.         <link rel="canonical" href="https://minigrid.farama.org/_modules/minigrid/wrappers.html" />
    12. 

  12. 

  13.     <link rel="shortcut icon" href="../../../_static/minigrid-favicon.png"/><!-- Generated with Sphinx 7.2.6 and Furo 2023.08.19.dev1 -->
    14. 

  14.         <title>minigrid.wrappers - MiniGrid Documentation</title>
    15. 

  15.       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
    16. 

  16.     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=3e7f4c72" />
    17. 

  17.     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=49cbaffd" />
    18. 

  18.     
    19. 

  19.     
    20. 

  20. 

  21. 

  22. <style>
    23. 

  23.   body {
    24. 

  24.     --color-code-background: #f8f8f8;
    25. 

  25.   --color-code-foreground: black;
    26. 

  26.   
    27. 

  27.   }
    28. 

  28.   @media not print {
    29. 

  29.     body[data-theme="dark"] {
    30. 

  30.       --color-code-background: #202020;
    31. 

  31.   --color-code-foreground: #d0d0d0;
    32. 

  32.   
    33. 

  33.     }
    34. 

  34.     @media (prefers-color-scheme: dark) {
    35. 

  35.       body:not([data-theme="light"]) {
    36. 

  36.         --color-code-background: #202020;
    37. 

  37.   --color-code-foreground: #d0d0d0;
    38. 

  38.   
    39. 

  39.       }
    40. 

  40.     }
    41. 

  41.   }
    42. 

  42. </style></head>
    43. 

  43.   <body>
    44. 

  44.     <header class="farama-header" aria-label="Farama header">
    45. 

  45.       <div class="farama-header__container">
    46. 

  46.         <div class="farama-header__left--mobile">
    47. 

  47.           <label class="nav-overlay-icon" for="__navigation">
    48. 

  48.             <div class="visually-hidden">Toggle site navigation sidebar</div>
    49. 

  49.             <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
    50. 

  50.               <defs></defs>
    51. 

  51.               <line x1="0.5" y1="4" x2="23.5" y2="4"></line>
    52. 

  52.               <line x1="0.232" y1="12" x2="23.5" y2="12"></line>
    53. 

  53.               <line x1="0.232" y1="20" x2="23.5" y2="20"></line>
    54. 

  54.             </svg>
    55. 

  55.           </label>
    56. 

  56.         </div>
    57. 

  57.         <div class="farama-header__left farama-header__center--mobile">
    58. 

  58.           <a href="../../../">
    59. 

  59.               <img class="farama-header__logo only-light" src="../../../_static/img/minigrid.svg" alt="Light Logo"/>
    60. 

  60.               <img class="farama-header__logo only-dark" src="../../../_static/img/minigrid-white.svg" alt="Dark Logo"/>
    61. 

  61.             <span class="farama-header__title">MiniGrid Documentation</span>
    62. 

  62.           </a>
    63. 

  63.         </div>
    64. 

  64.         <div class="farama-header__right">
    65. 

  65.           <div class="farama-header-menu">
    66. 

  66.             <button class="farama-header-menu__btn" aria-label="Open Farama Menu" aria-expanded="false" aria-haspopup="true" aria-controls="farama-menu">
    67. 

  67.               <img class="farama-black-logo-invert" src="../../../_static/img/farama-logo-header.svg">
    68. 

  68.               <svg viewBox="0 0 24 24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
    69. 

  69.                 <polyline style="stroke-linecap: round; stroke-linejoin: round; fill: none; stroke-width: 2px;" points="1 7 12 18 23 7"></polyline>
    70. 

  70.               </svg>
    71. 

  71.             </button>
    72. 

  72.             <div class="farama-header-menu-container farama-hidden" aria-hidden="true" id="farama-menu">
    73. 

  73.               <div class="farama-header-menu__header">
    74. 

  74.                 <a href="https://farama.org">
    75. 

  75.                   <img class="farama-header-menu__logo farama-white-logo-invert" src="../../../_static/img/farama_solid_white.svg" alt="Farama Foundation logo">
    76. 

  76.                   <span>Farama Foundation</span>
    77. 

  77.                 </a>
    78. 

  78.                 <div class="farama-header-menu-header__right">
    79. 

  79.                   <button id="farama-close-menu">
    80. 

  80.                     <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor"
    81. 

  81.                       stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="icon-close">
    82. 

  82.                       <line x1="3" y1="21" x2="21" y2="3"></line>
    83. 

  83.                       <line x1="3" y1="3" x2="21" y2="21"></line>
    84. 

  84.                     </svg>
    85. 

  85.                   </button>
    86. 

  86.                 </div>
    87. 

  87.               </div>
    88. 

  88.               <div class="farama-header-menu__body">
    89. 

  89.                 <!-- Response from farama.org/api/projects.json -->
    90. 

  90.               </div>
    91. 

  91.             </div>
    92. 

  92.           </div>
    93. 

  93.         </div>
    94. 

  94.       </div>
    95. 

  95.     </header>
    96. 

  96. 

  97.     
    98. 

  98.     <script>
    99. 

  99.       document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    100. 

  100.     </script>
    101. 

  101.     
    102. 

  102. 

  103. <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
    104. 

  104.   <symbol id="svg-toc" viewBox="0 0 24 24">
    105. 

  105.     <title>Contents</title>
    106. 

  106.     <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
    107. 

  107.       <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"/>
    108. 

  108.     </svg>
    109. 

  109.   </symbol>
    110. 

  110.   <symbol id="svg-menu" viewBox="0 0 24 24">
    111. 

  111.     <title>Menu</title>
    112. 

  112.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
    113. 

  113.       stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
    114. 

  114.       <line x1="3" y1="12" x2="21" y2="12"></line>
    115. 

  115.       <line x1="3" y1="6" x2="21" y2="6"></line>
    116. 

  116.       <line x1="3" y1="18" x2="21" y2="18"></line>
    117. 

  117.     </svg>
    118. 

  118.   </symbol>
    119. 

  119.   <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    120. 

  120.     <title>Expand</title>
    121. 

  121.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
    122. 

  122.       stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
    123. 

  123.       <polyline points="9 18 15 12 9 6"></polyline>
    124. 

  124.     </svg>
    125. 

  125.   </symbol>
    126. 

  126.   <symbol id="svg-sun" viewBox="0 0 24 24">
    127. 

  127.     <title>Light mode</title>
    128. 

  128.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
    129. 

  129.       stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
    130. 

  130.       <circle cx="12" cy="12" r="5"></circle>
    131. 

  131.       <line x1="12" y1="1" x2="12" y2="3"></line>
    132. 

  132.       <line x1="12" y1="21" x2="12" y2="23"></line>
    133. 

  133.       <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
    134. 

  134.       <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
    135. 

  135.       <line x1="1" y1="12" x2="3" y2="12"></line>
    136. 

  136.       <line x1="21" y1="12" x2="23" y2="12"></line>
    137. 

  137.       <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
    138. 

  138.       <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    139. 

  139.     </svg>
    140. 

  140.   </symbol>
    141. 

  141.   <symbol id="svg-moon" viewBox="0 0 24 24">
    142. 

  142.     <title>Dark mode</title>
    143. 

  143.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
    144. 

  144.       stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
    145. 

  145.       <path stroke="none" d="M0 0h24v24H0z" fill="none" />
    146. 

  146.       <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" />
    147. 

  147.     </svg>
    148. 

  148.   </symbol>
    149. 

  149.   <symbol id="svg-sun-half" viewBox="0 0 24 24">
    150. 

  150.     <title>Auto light/dark mode</title>
    151. 

  151.     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
    152. 

  152.       stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
    153. 

  153.       <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
    154. 

  154.       <circle cx="12" cy="12" r="9" />
    155. 

  155.       <path d="M13 12h5" />
    156. 

  156.       <path d="M13 15h4" />
    157. 

  157.       <path d="M13 18h1" />
    158. 

  158.       <path d="M13 9h4" />
    159. 

  159.       <path d="M13 6h1" />
    160. 

  160.     </svg>
    161. 

  161.   </symbol>
    162. 

  162. </svg>
    163. 

  163. 

  164. <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
    165. 

  165. <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
    166. 

  166. <label class="overlay sidebar-overlay" for="__navigation">
    167. 

  167.   <div class="visually-hidden">Hide navigation sidebar</div>
    168. 

  168. </label>
    169. 

  169. <label class="overlay toc-overlay" for="__toc">
    170. 

  170.   <div class="visually-hidden">Hide table of contents sidebar</div>
    171. 

  171. </label>
    172. 

  172. 

  173. <div class="page">
    174. 

  174.   <!--<header class="mobile-header">
    175. 

  175.     <div class="header-left">
    176. 

  176.       <label class="nav-overlay-icon" for="__navigation">
    177. 

  177.         <div class="visually-hidden">Toggle site navigation sidebar</div>
    178. 

  178.         <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
    179. 

  179.       </label>
    180. 

  180.     </div>
    181. 

  181.     <div class="header-center">
    182. 

  182.       <a href="../../../"><div class="brand">MiniGrid Documentation</div></a>
    183. 

  183.     </div>
    184. 

  184.     <div class="header-right">
    185. 

  185.       <div class="theme-toggle-container theme-toggle-header">
    186. 

  186.         <button class="theme-toggle">
    187. 

  187.           <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
    188. 

  188.           <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
    189. 

  189.           <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
    190. 

  190.           <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
    191. 

  191.         </button>
    192. 

  192.       </div>
    193. 

  193.       <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
    194. 

  194.         <div class="visually-hidden">Toggle table of contents sidebar</div>
    195. 

  195.         <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
    196. 

  196.       </label>
    197. 

  197.     </div>
    198. 

  198.   </header>-->
    199. 

  199.   <aside class="sidebar-drawer">
    200. 

  200.     <div class="sidebar-container">
    201. 

  201.       
    202. 

  202.       <div class="sidebar-sticky"><a class="farama-sidebar__title" href="../../../">
    203. 

  203.       <img class="farama-header__logo only-light" src="../../../_static/img/minigrid.svg" alt="Light Logo"/>
    204. 

  204.       <img class="farama-header__logo only-dark" src="../../../_static/img/minigrid-white.svg" alt="Dark Logo"/>
    205. 

  205.     <span class="farama-header__title">MiniGrid Documentation</span>
    206. 

  206.   </a><form class="sidebar-search-container" method="get" action="../../../search/" role="search">
    207. 

  207.   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
    208. 

  208.   <input type="hidden" name="check_keywords" value="yes">
    209. 

  209.   <input type="hidden" name="area" value="default">
    210. 

  210. </form>
    211. 

  211. <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
    212. 

  212.   <p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
    213. 

  213. <ul>
    214. 

  214. <li class="toctree-l1"><a class="reference internal" href="../../../content/basic_usage/">Basic Usage</a></li>
    215. 

  215. <li class="toctree-l1"><a class="reference internal" href="../../../content/basic_usage/#installation">Installation</a></li>
    216. 

  216. <li class="toctree-l1"><a class="reference internal" href="../../../content/publications/">List of Publications</a></li>
    217. 

  217. <li class="toctree-l1"><a class="reference internal" href="../../../content/create_env_tutorial/">Tutorial on Creating Environments</a></li>
    218. 

  218. <li class="toctree-l1"><a class="reference internal" href="../../../content/training/">Training Minigrid Environments</a></li>
    219. 

  219. </ul>
    220. 

  220. <p class="caption" role="heading"><span class="caption-text">Wrappers</span></p>
    221. 

  221. <ul>
    222. 

  222. <li class="toctree-l1 has-children"><a class="reference internal" href="../../../api/wrapper/">Wrapper</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Wrapper</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
    223. 

  223. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/">Action Bonus</a></li>
    224. 

  224. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#dict-observation-space">Dict Observation Space</a></li>
    225. 

  225. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#direction-obs">Direction Obs</a></li>
    226. 

  226. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#flatobs">FlatObs</a></li>
    227. 

  227. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#fully-obs">Fully Obs</a></li>
    228. 

  228. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#image-observation">Image Observation</a></li>
    229. 

  229. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#no-death">No Death</a></li>
    230. 

  230. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#observation">Observation</a></li>
    231. 

  231. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#one-hot-partial-obs">One Hot Partial Obs</a></li>
    232. 

  232. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#reseed">Reseed</a></li>
    233. 

  233. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#rgb-img-obs">RGB Img Obs</a></li>
    234. 

  234. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#rgb-partial-img-obs">RGB Partial Img Obs</a></li>
    235. 

  235. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#position-bonus">Position Bonus</a></li>
    236. 

  236. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#stochastic-action">Stochastic Action</a></li>
    237. 

  237. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#symbolic-obs">Symbolic Obs</a></li>
    238. 

  238. <li class="toctree-l2"><a class="reference internal" href="../../../api/wrappers/#view-size">View Size</a></li>
    239. 

  239. </ul>
    240. 

  240. </li>
    241. 

  241. </ul>
    242. 

  242. <p class="caption" role="heading"><span class="caption-text">Environments</span></p>
    243. 

  243. <ul>
    244. 

  244. <li class="toctree-l1 has-children"><a class="reference internal" href="../../../environments/minigrid/">Minigrid Environments</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Minigrid Environments</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/BlockedUnlockPickupEnv/">Blocked Unlock Pickup</a></li>
    246. 

  246. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/CrossingEnv/">Crossing</a></li>
    247. 

  247. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/DistShiftEnv/">Dist Shift</a></li>
    248. 

  248. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/DoorKeyEnv/">Door Key</a></li>
    249. 

  249. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/DynamicObstaclesEnv/">Dynamic Obstacles</a></li>
    250. 

  250. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/EmptyEnv/">Empty</a></li>
    251. 

  251. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/FetchEnv/">Fetch</a></li>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/FourRoomsEnv/">Four Rooms</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/GoToDoorEnv/">Go To Door</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/GoToObjectEnv/">Go To Object</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/KeyCorridorEnv/">Key Corridor</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/LavaGapEnv/">Lava Gap</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/LockedRoomEnv/">Locked Room</a></li>
    258. 

  258. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/MemoryEnv/">Memory</a></li>
    259. 

  259. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/MultiRoomEnv/">Multi Room</a></li>
    260. 

  260. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/ObstructedMaze_1Dlhb/">Obstructed Maze Dlhb</a></li>
    261. 

  261. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/ObstructedMaze_Full/">Obstructed Maze Full</a></li>
    262. 

  262. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/PlaygroundEnv/">Playground</a></li>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/PutNearEnv/">Put Near</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/RedBlueDoorEnv/">Red Blue Door</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/UnlockEnv/">Unlock</a></li>
    266. 

  266. <li class="toctree-l2"><a class="reference internal" href="../../../environments/minigrid/UnlockPickupEnv/">Unlock Pickup</a></li>
    267. 

  267. </ul>
    268. 

  268. </li>
    269. 

  269. <li class="toctree-l1 has-children"><a class="reference internal" href="../../../environments/babyai/">BabyAI Environments</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of BabyAI Environments</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
    270. 

  270. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToRedBallGrey/">Go To Red Ball Grey</a></li>
    271. 

  271. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToRedBall/">Go To Red Ball</a></li>
    272. 

  272. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToRedBallNoDists/">Go To Red Ball No Dists</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToObj/">Go To Obj</a></li>
    274. 

  274. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToLocal/">Go To Local</a></li>
    275. 

  275. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoTo/">Go To</a></li>
    276. 

  276. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToImpUnlock/">Go To Imp Unlock</a></li>
    277. 

  277. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToSeq/">Go To Seq</a></li>
    278. 

  278. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToRedBlueBall/">Go To Red Blue Ball</a></li>
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToDoor/">Go To Door</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/GoToObjDoor/">Go To Obj Door</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/Open/">Open</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/OpenRedDoor/">Open Red Door</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/OpenDoor/">Open Door</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/OpenTwoDoors/">Open Two Doors</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/OpenDoorsOrder/">Open Doors Order</a></li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/Pickup/">Pickup</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/UnblockPickup/">Unblock Pickup</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/PickupLoc/">Pickup Loc</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/PickupDist/">Pickup Dist</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/PickupAbove/">Pickup Above</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/PutNextLocal/">Put Next Local</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/PutNext/">Put Next</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/Unlock/">Unlock</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/UnlockLocal/">Unlock Local</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/KeyInBox/">Key In Box</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/UnlockPickup/">Unlock Pickup</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/BlockedUnlockPickup/">Blocked Unlock Pickup</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/UnlockToUnlock/">Unlock To Unlock</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/ActionObjDoor/">Action Obj Door</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/FindObjS5/">Find Obj</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/KeyCorridor/">Key Corridor</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/OneRoomS8/">One Room</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/MoveTwoAcross/">Move Two Across</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/Synth/">Synth</a></li>
    305. 

  305. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/SynthLoc/">Synth Loc</a></li>
    306. 

  306. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/SynthSeq/">Synth Seq</a></li>
    307. 

  307. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/MiniBossLevel/">Mini Boss Level</a></li>
    308. 

  308. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/BossLevel/">Boss Level</a></li>
    309. 

  309. <li class="toctree-l2"><a class="reference internal" href="../../../environments/babyai/BossLevelNoUnlock/">Boss Level No Unlock</a></li>
    310. 

  310. </ul>
    311. 

  311. </li>
    312. 

  312. </ul>
    313. 

  313. <p class="caption" role="heading"><span class="caption-text">Development</span></p>
    314. 

  314. <ul>
    315. 

  315. <li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
    316. 

  316. <li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/MiniGrid">Github</a></li>
    317. 

  317. </ul>
    318. 

  318. 

  319. </div>
    320. 

  320. </div>
    321. 

  321. 

  322.       </div>
    323. 

  323.       
    324. 

  324.     </div>
    325. 

  325.   </aside>
    326. 

  326.   <div class="main-container">
    327. 

  327. 

  328.     
    329. 

  329. 

  330.     
    331. 

  331. 

  332.     <div class="main">
    333. 

  333.       <div class="content">
    334. 

  334.         <div class="article-container">
    335. 

  335.           <a href="#" class="back-to-top muted-link">
    336. 

  336.             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
    337. 

  337.               <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
    338. 

  338.             </svg>
    339. 

  339.             <span>Back to top</span>
    340. 

  340.           </a>
    341. 

  341.           <div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
    342. 

  342.               <button class="theme-toggle" title="Toggle color theme">
    343. 

  343.                 <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
    344. 

  344.                 <svg class="theme-icon-when-auto">
    345. 

  345.                   <use href="#svg-sun-half"></use>
    346. 

  346.                 </svg>
    347. 

  347.                 <svg class="theme-icon-when-dark">
    348. 

  348.                   <use href="#svg-moon"></use>
    349. 

  349.                 </svg>
    350. 

  350.                 <svg class="theme-icon-when-light">
    351. 

  351.                   <use href="#svg-sun"></use>
    352. 

  352.                 </svg>
    353. 

  353.               </button>
    354. 

  354.             </div>
    355. 

  355.             <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
    356. 

  356.               <div class="visually-hidden">Toggle table of contents sidebar</div>
    357. 

  357.               <i class="icon"><svg>
    358. 

  358.                   <use href="#svg-toc"></use>
    359. 

  359.                 </svg></i>
    360. 

  360.             </label>
    361. 

  361.           </div>
    362. 

  362.           <article role="main">
    363. 

  363.             
    364. 

  364.             <h1>Source code for minigrid.wrappers</h1><div class="highlight"><pre>
    365. 

  365. <span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
    366. 

  366. 

  367. <span class="kn">import</span> <span class="nn">math</span>
    368. 

  368. <span class="kn">import</span> <span class="nn">operator</span>
    369. 

  369. <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">reduce</span>
    370. 

  370. <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
    371. 

  371. 

  372. <span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
    373. 

  373. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
    374. 

  374. <span class="kn">from</span> <span class="nn">gymnasium</span> <span class="kn">import</span> <span class="n">logger</span><span class="p">,</span> <span class="n">spaces</span>
    375. 

  375. <span class="kn">from</span> <span class="nn">gymnasium.core</span> <span class="kn">import</span> <span class="n">ActionWrapper</span><span class="p">,</span> <span class="n">ObservationWrapper</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">Wrapper</span>
    376. 

  376. 

  377. <span class="kn">from</span> <span class="nn">minigrid.core.constants</span> <span class="kn">import</span> <span class="n">COLOR_TO_IDX</span><span class="p">,</span> <span class="n">OBJECT_TO_IDX</span><span class="p">,</span> <span class="n">STATE_TO_IDX</span>
    378. 

  378. <span class="kn">from</span> <span class="nn">minigrid.core.world_object</span> <span class="kn">import</span> <span class="n">Goal</span>
    379. 

  379. 

  380. 

  381. <div class="viewcode-block" id="ReseedWrapper">
    382. 

  382. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.ReseedWrapper">[docs]</a>
    383. 

  383. <span class="k">class</span> <span class="nc">ReseedWrapper</span><span class="p">(</span><span class="n">Wrapper</span><span class="p">):</span>
    384. 

  384. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    385. 

  385. <span class="sd">    Wrapper to always regenerate an environment with the same set of seeds.</span>
    386. 

  386. <span class="sd">    This can be used to force an environment to always keep the same</span>
    387. 

  387. <span class="sd">    configuration when reset.</span>
    388. 

  388. 

  389. <span class="sd">    Example:</span>
    390. 

  390. <span class="sd">        &gt;&gt;&gt; import minigrid</span>
    391. 

  391. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    392. 

  392. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import ReseedWrapper</span>
    393. 

  393. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    394. 

  394. <span class="sd">        &gt;&gt;&gt; _ = env.reset(seed=123)</span>
    395. 

  395. <span class="sd">        &gt;&gt;&gt; [env.np_random.integers(10) for i in range(10)]</span>
    396. 

  396. <span class="sd">        [0, 6, 5, 0, 9, 2, 2, 1, 3, 1]</span>
    397. 

  397. <span class="sd">        &gt;&gt;&gt; env = ReseedWrapper(env, seeds=[0, 1], seed_idx=0)</span>
    398. 

  398. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset()</span>
    399. 

  399. <span class="sd">        &gt;&gt;&gt; [env.np_random.integers(10) for i in range(10)]</span>
    400. 

  400. <span class="sd">        [8, 6, 5, 2, 3, 0, 0, 0, 1, 8]</span>
    401. 

  401. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset()</span>
    402. 

  402. <span class="sd">        &gt;&gt;&gt; [env.np_random.integers(10) for i in range(10)]</span>
    403. 

  403. <span class="sd">        [4, 5, 7, 9, 0, 1, 8, 9, 2, 3]</span>
    404. 

  404. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset()</span>
    405. 

  405. <span class="sd">        &gt;&gt;&gt; [env.np_random.integers(10) for i in range(10)]</span>
    406. 

  406. <span class="sd">        [8, 6, 5, 2, 3, 0, 0, 0, 1, 8]</span>
    407. 

  407. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset()</span>
    408. 

  408. <span class="sd">        &gt;&gt;&gt; [env.np_random.integers(10) for i in range(10)]</span>
    409. 

  409. <span class="sd">        [4, 5, 7, 9, 0, 1, 8, 9, 2, 3]</span>
    410. 

  410. <span class="sd">    &quot;&quot;&quot;</span>
    411. 

  411. 

  412.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">seeds</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,),</span> <span class="n">seed_idx</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
    413. 

  413. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper that always regenerate an environment with the same set of seeds.</span>
    414. 

  414. 

  415. <span class="sd">        Args:</span>
    416. 

  416. <span class="sd">            env: The environment to apply the wrapper</span>
    417. 

  417. <span class="sd">            seeds: A list of seed to be applied to the env</span>
    418. 

  418. <span class="sd">            seed_idx: Index of the initial seed in seeds</span>
    419. 

  419. <span class="sd">        &quot;&quot;&quot;</span>
    420. 

  420.         <span class="bp">self</span><span class="o">.</span><span class="n">seeds</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">seeds</span><span class="p">)</span>
    421. 

  421.         <span class="bp">self</span><span class="o">.</span><span class="n">seed_idx</span> <span class="o">=</span> <span class="n">seed_idx</span>
    422. 

  422.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    423. 

  423. 

  424.     <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span>
    425. 

  425.         <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    426. 

  426.     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
    427. 

  427.         <span class="k">if</span> <span class="n">seed</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    428. 

  428.             <span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
    429. 

  429.                 <span class="s2">&quot;A seed has been passed to `ReseedWrapper.reset` which is ignored.&quot;</span>
    430. 

  430.             <span class="p">)</span>
    431. 

  431.         <span class="n">seed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">seeds</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">seed_idx</span><span class="p">]</span>
    432. 

  432.         <span class="bp">self</span><span class="o">.</span><span class="n">seed_idx</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seed_idx</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">seeds</span><span class="p">)</span>
    433. 

  433.         <span class="k">return</span> <span class="bp">self</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="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span></div>
    434. 

  434. 

  435. 

  436. 

  437. <div class="viewcode-block" id="ActionBonus">
    438. 

  438. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.ActionBonus">[docs]</a>
    439. 

  439. <span class="k">class</span> <span class="nc">ActionBonus</span><span class="p">(</span><span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">):</span>
    440. 

  440. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    441. 

  441. <span class="sd">    Wrapper which adds an exploration bonus.</span>
    442. 

  442. <span class="sd">    This is a reward to encourage exploration of less</span>
    443. 

  443. <span class="sd">    visited (state,action) pairs.</span>
    444. 

  444. 

  445. <span class="sd">    Example:</span>
    446. 

  446. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    447. 

  447. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import ActionBonus</span>
    448. 

  448. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    449. 

  449. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=0)</span>
    450. 

  450. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env.step(1)</span>
    451. 

  451. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    452. 

  452. <span class="sd">        0</span>
    453. 

  453. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env.step(1)</span>
    454. 

  454. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    455. 

  455. <span class="sd">        0</span>
    456. 

  456. <span class="sd">        &gt;&gt;&gt; env_bonus = ActionBonus(env)</span>
    457. 

  457. <span class="sd">        &gt;&gt;&gt; _, _ = env_bonus.reset(seed=0)</span>
    458. 

  458. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env_bonus.step(1)</span>
    459. 

  459. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    460. 

  460. <span class="sd">        1.0</span>
    461. 

  461. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env_bonus.step(1)</span>
    462. 

  462. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    463. 

  463. <span class="sd">        1.0</span>
    464. 

  464. <span class="sd">    &quot;&quot;&quot;</span>
    465. 

  465. 

  466.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
    467. 

  467. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper that adds an exploration bonus to less visited (state,action) pairs.</span>
    468. 

  468. 

  469. <span class="sd">        Args:</span>
    470. 

  470. <span class="sd">            env: The environment to apply the wrapper</span>
    471. 

  471. <span class="sd">        &quot;&quot;&quot;</span>
    472. 

  472.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    473. 

  473.         <span class="bp">self</span><span class="o">.</span><span class="n">counts</span> <span class="o">=</span> <span class="p">{}</span>
    474. 

  474. 

  475.     <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
    476. 

  476. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Steps through the environment with `action`.&quot;&quot;&quot;</span>
    477. 

  477.         <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
    478. 

  478. 

  479.         <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span>
    480. 

  480.         <span class="n">tup</span> <span class="o">=</span> <span class="p">(</span><span class="nb">tuple</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">),</span> <span class="n">env</span><span class="o">.</span><span class="n">agent_dir</span><span class="p">,</span> <span class="n">action</span><span class="p">)</span>
    481. 

  481. 

  482.         <span class="c1"># Get the count for this (s,a) pair</span>
    483. 

  483.         <span class="n">pre_count</span> <span class="o">=</span> <span class="mi">0</span>
    484. 

  484.         <span class="k">if</span> <span class="n">tup</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">:</span>
    485. 

  485.             <span class="n">pre_count</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">[</span><span class="n">tup</span><span class="p">]</span>
    486. 

  486. 

  487.         <span class="c1"># Update the count for this (s,a) pair</span>
    488. 

  488.         <span class="n">new_count</span> <span class="o">=</span> <span class="n">pre_count</span> <span class="o">+</span> <span class="mi">1</span>
    489. 

  489.         <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">[</span><span class="n">tup</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_count</span>
    490. 

  490. 

  491.         <span class="n">bonus</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">math</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">new_count</span><span class="p">)</span>
    492. 

  492.         <span class="n">reward</span> <span class="o">+=</span> <span class="n">bonus</span>
    493. 

  493. 

  494.         <span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span></div>
    495. 

  495. 

  496. 

  497. 

  498. <div class="viewcode-block" id="PositionBonus">
    499. 

  499. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.PositionBonus">[docs]</a>
    500. 

  500. <span class="k">class</span> <span class="nc">PositionBonus</span><span class="p">(</span><span class="n">Wrapper</span><span class="p">):</span>
    501. 

  501. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    502. 

  502. <span class="sd">    Adds an exploration bonus based on which positions</span>
    503. 

  503. <span class="sd">    are visited on the grid.</span>
    504. 

  504. 

  505. <span class="sd">    Note:</span>
    506. 

  506. <span class="sd">        This wrapper was previously called ``StateBonus``.</span>
    507. 

  507. 

  508. <span class="sd">    Example:</span>
    509. 

  509. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    510. 

  510. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import PositionBonus</span>
    511. 

  511. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    512. 

  512. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=0)</span>
    513. 

  513. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env.step(1)</span>
    514. 

  514. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    515. 

  515. <span class="sd">        0</span>
    516. 

  516. <span class="sd">        &gt;&gt;&gt; _, reward, _, _, _ = env.step(1)</span>
    517. 

  517. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    518. 

  518. <span class="sd">        0</span>
    519. 

  519. <span class="sd">        &gt;&gt;&gt; env_bonus = PositionBonus(env)</span>
    520. 

  520. <span class="sd">        &gt;&gt;&gt; obs, _ = env_bonus.reset(seed=0)</span>
    521. 

  521. <span class="sd">        &gt;&gt;&gt; obs, reward, terminated, truncated, info = env_bonus.step(1)</span>
    522. 

  522. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    523. 

  523. <span class="sd">        1.0</span>
    524. 

  524. <span class="sd">        &gt;&gt;&gt; obs, reward, terminated, truncated, info = env_bonus.step(1)</span>
    525. 

  525. <span class="sd">        &gt;&gt;&gt; print(reward)</span>
    526. 

  526. <span class="sd">        0.7071067811865475</span>
    527. 

  527. <span class="sd">    &quot;&quot;&quot;</span>
    528. 

  528. 

  529.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
    530. 

  530. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper that adds an exploration bonus to less visited positions.</span>
    531. 

  531. 

  532. <span class="sd">        Args:</span>
    533. 

  533. <span class="sd">            env: The environment to apply the wrapper</span>
    534. 

  534. <span class="sd">        &quot;&quot;&quot;</span>
    535. 

  535.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    536. 

  536.         <span class="bp">self</span><span class="o">.</span><span class="n">counts</span> <span class="o">=</span> <span class="p">{}</span>
    537. 

  537. 

  538.     <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
    539. 

  539. <span class="w">        </span><span class="sd">&quot;&quot;&quot;Steps through the environment with `action`.&quot;&quot;&quot;</span>
    540. 

  540.         <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
    541. 

  541. 

  542.         <span class="c1"># Tuple based on which we index the counts</span>
    543. 

  543.         <span class="c1"># We use the position after an update</span>
    544. 

  544.         <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span>
    545. 

  545.         <span class="n">tup</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">)</span>
    546. 

  546. 

  547.         <span class="c1"># Get the count for this key</span>
    548. 

  548.         <span class="n">pre_count</span> <span class="o">=</span> <span class="mi">0</span>
    549. 

  549.         <span class="k">if</span> <span class="n">tup</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">:</span>
    550. 

  550.             <span class="n">pre_count</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">[</span><span class="n">tup</span><span class="p">]</span>
    551. 

  551. 

  552.         <span class="c1"># Update the count for this key</span>
    553. 

  553.         <span class="n">new_count</span> <span class="o">=</span> <span class="n">pre_count</span> <span class="o">+</span> <span class="mi">1</span>
    554. 

  554.         <span class="bp">self</span><span class="o">.</span><span class="n">counts</span><span class="p">[</span><span class="n">tup</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_count</span>
    555. 

  555. 

  556.         <span class="n">bonus</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">math</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">new_count</span><span class="p">)</span>
    557. 

  557.         <span class="n">reward</span> <span class="o">+=</span> <span class="n">bonus</span>
    558. 

  558. 

  559.         <span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span></div>
    560. 

  560. 

  561. 

  562. 

  563. <div class="viewcode-block" id="ImgObsWrapper">
    564. 

  564. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.ImgObsWrapper">[docs]</a>
    565. 

  565. <span class="k">class</span> <span class="nc">ImgObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    566. 

  566. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    567. 

  567. <span class="sd">    Use the image as the only observation output, no language/mission.</span>
    568. 

  568. 

  569. <span class="sd">    Example:</span>
    570. 

  570. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    571. 

  571. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import ImgObsWrapper</span>
    572. 

  572. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    573. 

  573. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    574. 

  574. <span class="sd">        &gt;&gt;&gt; obs.keys()</span>
    575. 

  575. <span class="sd">        dict_keys([&#39;image&#39;, &#39;direction&#39;, &#39;mission&#39;])</span>
    576. 

  576. <span class="sd">        &gt;&gt;&gt; env = ImgObsWrapper(env)</span>
    577. 

  577. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    578. 

  578. <span class="sd">        &gt;&gt;&gt; obs.shape</span>
    579. 

  579. <span class="sd">        (7, 7, 3)</span>
    580. 

  580. <span class="sd">    &quot;&quot;&quot;</span>
    581. 

  581. 

  582.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
    583. 

  583. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper that makes image the only observation.</span>
    584. 

  584. 

  585. <span class="sd">        Args:</span>
    586. 

  586. <span class="sd">            env: The environment to apply the wrapper</span>
    587. 

  587. <span class="sd">        &quot;&quot;&quot;</span>
    588. 

  588.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    589. 

  589.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span>
    590. 

  590. 

  591.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    592. 

  592.         <span class="k">return</span> <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span></div>
    593. 

  593. 

  594. 

  595. 

  596. <div class="viewcode-block" id="OneHotPartialObsWrapper">
    597. 

  597. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.OneHotPartialObsWrapper">[docs]</a>
    598. 

  598. <span class="k">class</span> <span class="nc">OneHotPartialObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    599. 

  599. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    600. 

  600. <span class="sd">    Wrapper to get a one-hot encoding of a partially observable</span>
    601. 

  601. <span class="sd">    agent view as observation.</span>
    602. 

  602. 

  603. <span class="sd">    Example:</span>
    604. 

  604. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    605. 

  605. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import OneHotPartialObsWrapper</span>
    606. 

  606. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    607. 

  607. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    608. 

  608. <span class="sd">        &gt;&gt;&gt; obs[&quot;image&quot;][0, :, :]</span>
    609. 

  609. <span class="sd">        array([[2, 5, 0],</span>
    610. 

  610. <span class="sd">               [2, 5, 0],</span>
    611. 

  611. <span class="sd">               [2, 5, 0],</span>
    612. 

  612. <span class="sd">               [2, 5, 0],</span>
    613. 

  613. <span class="sd">               [2, 5, 0],</span>
    614. 

  614. <span class="sd">               [2, 5, 0],</span>
    615. 

  615. <span class="sd">               [2, 5, 0]], dtype=uint8)</span>
    616. 

  616. <span class="sd">        &gt;&gt;&gt; env = OneHotPartialObsWrapper(env)</span>
    617. 

  617. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    618. 

  618. <span class="sd">        &gt;&gt;&gt; obs[&quot;image&quot;][0, :, :]</span>
    619. 

  619. <span class="sd">        array([[0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    620. 

  620. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    621. 

  621. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    622. 

  622. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    623. 

  623. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    624. 

  624. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0],</span>
    625. 

  625. <span class="sd">               [0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0]],</span>
    626. 

  626. <span class="sd">              dtype=uint8)</span>
    627. 

  627. <span class="sd">    &quot;&quot;&quot;</span>
    628. 

  628. 

  629.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">tile_size</span><span class="o">=</span><span class="mi">8</span><span class="p">):</span>
    630. 

  630. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper that makes the image observation a one-hot encoding of a partially observable agent view.</span>
    631. 

  631. 

  632. <span class="sd">        Args:</span>
    633. 

  633. <span class="sd">            env: The environment to apply the wrapper</span>
    634. 

  634. <span class="sd">        &quot;&quot;&quot;</span>
    635. 

  635.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    636. 

  636. 

  637.         <span class="bp">self</span><span class="o">.</span><span class="n">tile_size</span> <span class="o">=</span> <span class="n">tile_size</span>
    638. 

  638. 

  639.         <span class="n">obs_shape</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
    640. 

  640. 

  641.         <span class="c1"># Number of bits per cell</span>
    642. 

  642.         <span class="n">num_bits</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">OBJECT_TO_IDX</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">COLOR_TO_IDX</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">STATE_TO_IDX</span><span class="p">)</span>
    643. 

  643. 

  644.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    645. 

  645.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">obs_shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">obs_shape</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">num_bits</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span>
    646. 

  646.         <span class="p">)</span>
    647. 

  647.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    648. 

  648.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    649. 

  649.         <span class="p">)</span>
    650. 

  650. 

  651.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    652. 

  652.         <span class="n">img</span> <span class="o">=</span> <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span>
    653. 

  653.         <span class="n">out</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">)</span>
    654. 

  654. 

  655.         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">img</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
    656. 

  656.             <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">img</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
    657. 

  657.                 <span class="nb">type</span> <span class="o">=</span> <span class="n">img</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span>
    658. 

  658.                 <span class="n">color</span> <span class="o">=</span> <span class="n">img</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="mi">1</span><span class="p">]</span>
    659. 

  659.                 <span class="n">state</span> <span class="o">=</span> <span class="n">img</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
    660. 

  660. 

  661.                 <span class="n">out</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="nb">type</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
    662. 

  662.                 <span class="n">out</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">OBJECT_TO_IDX</span><span class="p">)</span> <span class="o">+</span> <span class="n">color</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
    663. 

  663.                 <span class="n">out</span><span class="p">[</span><span class="n">i</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">OBJECT_TO_IDX</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">COLOR_TO_IDX</span><span class="p">)</span> <span class="o">+</span> <span class="n">state</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
    664. 

  664. 

  665.         <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">obs</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">out</span><span class="p">}</span></div>
    666. 

  666. 

  667. 

  668. 

  669. <div class="viewcode-block" id="RGBImgObsWrapper">
    670. 

  670. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.RGBImgObsWrapper">[docs]</a>
    671. 

  671. <span class="k">class</span> <span class="nc">RGBImgObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    672. 

  672. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    673. 

  673. <span class="sd">    Wrapper to use fully observable RGB image as observation,</span>
    674. 

  674. <span class="sd">    This can be used to have the agent to solve the gridworld in pixel space.</span>
    675. 

  675. 

  676. <span class="sd">    Example:</span>
    677. 

  677. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    678. 

  678. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    679. 

  679. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import RGBImgObsWrapper</span>
    680. 

  680. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Empty-5x5-v0&quot;)</span>
    681. 

  681. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    682. 

  682. <span class="sd">        &gt;&gt;&gt; plt.imshow(obs[&#39;image&#39;])  # doctest: +SKIP</span>
    683. 

  683. <span class="sd">        ![NoWrapper](../figures/lavacrossing_NoWrapper.png)</span>
    684. 

  684. <span class="sd">        &gt;&gt;&gt; env = RGBImgObsWrapper(env)</span>
    685. 

  685. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    686. 

  686. <span class="sd">        &gt;&gt;&gt; plt.imshow(obs[&#39;image&#39;])  # doctest: +SKIP</span>
    687. 

  687. <span class="sd">        ![RGBImgObsWrapper](../figures/lavacrossing_RGBImgObsWrapper.png)</span>
    688. 

  688. <span class="sd">    &quot;&quot;&quot;</span>
    689. 

  689. 

  690.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">tile_size</span><span class="o">=</span><span class="mi">8</span><span class="p">):</span>
    691. 

  691.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    692. 

  692. 

  693.         <span class="bp">self</span><span class="o">.</span><span class="n">tile_size</span> <span class="o">=</span> <span class="n">tile_size</span>
    694. 

  694. 

  695.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    696. 

  696.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
    697. 

  697.             <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span>
    698. 

  698.             <span class="n">shape</span><span class="o">=</span><span class="p">(</span>
    699. 

  699.                 <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span><span class="o">.</span><span class="n">width</span> <span class="o">*</span> <span class="n">tile_size</span><span class="p">,</span>
    700. 

  700.                 <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span><span class="o">.</span><span class="n">height</span> <span class="o">*</span> <span class="n">tile_size</span><span class="p">,</span>
    701. 

  701.                 <span class="mi">3</span><span class="p">,</span>
    702. 

  702.             <span class="p">),</span>
    703. 

  703.             <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">,</span>
    704. 

  704.         <span class="p">)</span>
    705. 

  705. 

  706.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    707. 

  707.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    708. 

  708.         <span class="p">)</span>
    709. 

  709. 

  710.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    711. 

  711.         <span class="n">rgb_img</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_frame</span><span class="p">(</span>
    712. 

  712.             <span class="n">highlight</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span><span class="o">.</span><span class="n">highlight</span><span class="p">,</span> <span class="n">tile_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tile_size</span>
    713. 

  713.         <span class="p">)</span>
    714. 

  714. 

  715.         <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">obs</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">rgb_img</span><span class="p">}</span></div>
    716. 

  716. 

  717. 

  718. 

  719. <div class="viewcode-block" id="RGBImgPartialObsWrapper">
    720. 

  720. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.RGBImgPartialObsWrapper">[docs]</a>
    721. 

  721. <span class="k">class</span> <span class="nc">RGBImgPartialObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    722. 

  722. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    723. 

  723. <span class="sd">    Wrapper to use partially observable RGB image as observation.</span>
    724. 

  724. <span class="sd">    This can be used to have the agent to solve the gridworld in pixel space.</span>
    725. 

  725. 

  726. <span class="sd">    Example:</span>
    727. 

  727. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    728. 

  728. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    729. 

  729. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import RGBImgObsWrapper, RGBImgPartialObsWrapper</span>
    730. 

  730. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    731. 

  731. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    732. 

  732. <span class="sd">        &gt;&gt;&gt; plt.imshow(obs[&quot;image&quot;])  # doctest: +SKIP</span>
    733. 

  733. <span class="sd">        ![NoWrapper](../figures/lavacrossing_NoWrapper.png)</span>
    734. 

  734. <span class="sd">        &gt;&gt;&gt; env_obs = RGBImgObsWrapper(env)</span>
    735. 

  735. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    736. 

  736. <span class="sd">        &gt;&gt;&gt; plt.imshow(obs[&quot;image&quot;])  # doctest: +SKIP</span>
    737. 

  737. <span class="sd">        ![RGBImgObsWrapper](../figures/lavacrossing_RGBImgObsWrapper.png)</span>
    738. 

  738. <span class="sd">        &gt;&gt;&gt; env_obs = RGBImgPartialObsWrapper(env)</span>
    739. 

  739. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    740. 

  740. <span class="sd">        &gt;&gt;&gt; plt.imshow(obs[&quot;image&quot;])  # doctest: +SKIP</span>
    741. 

  741. <span class="sd">        ![RGBImgPartialObsWrapper](../figures/lavacrossing_RGBImgPartialObsWrapper.png)</span>
    742. 

  742. <span class="sd">    &quot;&quot;&quot;</span>
    743. 

  743. 

  744.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">tile_size</span><span class="o">=</span><span class="mi">8</span><span class="p">):</span>
    745. 

  745.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    746. 

  746. 

  747.         <span class="c1"># Rendering attributes for observations</span>
    748. 

  748.         <span class="bp">self</span><span class="o">.</span><span class="n">tile_size</span> <span class="o">=</span> <span class="n">tile_size</span>
    749. 

  749. 

  750.         <span class="n">obs_shape</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
    751. 

  751.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    752. 

  752.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
    753. 

  753.             <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span>
    754. 

  754.             <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">obs_shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">tile_size</span><span class="p">,</span> <span class="n">obs_shape</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="n">tile_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span>
    755. 

  755.             <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">,</span>
    756. 

  756.         <span class="p">)</span>
    757. 

  757. 

  758.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    759. 

  759.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    760. 

  760.         <span class="p">)</span>
    761. 

  761. 

  762.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    763. 

  763.         <span class="n">rgb_img_partial</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_frame</span><span class="p">(</span><span class="n">tile_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tile_size</span><span class="p">,</span> <span class="n">agent_pov</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    764. 

  764. 

  765.         <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">obs</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">rgb_img_partial</span><span class="p">}</span></div>
    766. 

  766. 

  767. 

  768. 

  769. <div class="viewcode-block" id="FullyObsWrapper">
    770. 

  770. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.FullyObsWrapper">[docs]</a>
    771. 

  771. <span class="k">class</span> <span class="nc">FullyObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    772. 

  772. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    773. 

  773. <span class="sd">    Fully observable gridworld using a compact grid encoding instead of the agent view.</span>
    774. 

  774. 

  775. <span class="sd">    Example:</span>
    776. 

  776. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    777. 

  777. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    778. 

  778. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import FullyObsWrapper</span>
    779. 

  779. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    780. 

  780. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    781. 

  781. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    782. 

  782. <span class="sd">        (7, 7, 3)</span>
    783. 

  783. <span class="sd">        &gt;&gt;&gt; env_obs = FullyObsWrapper(env)</span>
    784. 

  784. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    785. 

  785. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    786. 

  786. <span class="sd">        (11, 11, 3)</span>
    787. 

  787. <span class="sd">    &quot;&quot;&quot;</span>
    788. 

  788. 

  789.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
    790. 

  790.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    791. 

  791. 

  792.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    793. 

  793.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
    794. 

  794.             <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span>
    795. 

  795.             <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">height</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span>  <span class="c1"># number of cells</span>
    796. 

  796.             <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">,</span>
    797. 

  797.         <span class="p">)</span>
    798. 

  798. 

  799.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    800. 

  800.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    801. 

  801.         <span class="p">)</span>
    802. 

  802. 

  803.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    804. 

  804.         <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span>
    805. 

  805.         <span class="n">full_grid</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span>
    806. 

  806.         <span class="n">full_grid</span><span class="p">[</span><span class="n">env</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">[</span><span class="mi">0</span><span class="p">]][</span><span class="n">env</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span>
    807. 

  807.             <span class="p">[</span><span class="n">OBJECT_TO_IDX</span><span class="p">[</span><span class="s2">&quot;agent&quot;</span><span class="p">],</span> <span class="n">COLOR_TO_IDX</span><span class="p">[</span><span class="s2">&quot;red&quot;</span><span class="p">],</span> <span class="n">env</span><span class="o">.</span><span class="n">agent_dir</span><span class="p">]</span>
    808. 

  808.         <span class="p">)</span>
    809. 

  809. 

  810.         <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">obs</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">full_grid</span><span class="p">}</span></div>
    811. 

  811. 

  812. 

  813. 

  814. <div class="viewcode-block" id="DictObservationSpaceWrapper">
    815. 

  815. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.DictObservationSpaceWrapper">[docs]</a>
    816. 

  816. <span class="k">class</span> <span class="nc">DictObservationSpaceWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    817. 

  817. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    818. 

  818. <span class="sd">    Transforms the observation space (that has a textual component) to a fully numerical observation space,</span>
    819. 

  819. <span class="sd">    where the textual instructions are replaced by arrays representing the indices of each word in a fixed vocabulary.</span>
    820. 

  820. 

  821. <span class="sd">    This wrapper is not applicable to BabyAI environments, given that these have their own language component.</span>
    822. 

  822. 

  823. <span class="sd">    Example:</span>
    824. 

  824. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    825. 

  825. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    826. 

  826. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import DictObservationSpaceWrapper</span>
    827. 

  827. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    828. 

  828. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    829. 

  829. <span class="sd">        &gt;&gt;&gt; obs[&#39;mission&#39;]</span>
    830. 

  830. <span class="sd">        &#39;avoid the lava and get to the green goal square&#39;</span>
    831. 

  831. <span class="sd">        &gt;&gt;&gt; env_obs = DictObservationSpaceWrapper(env)</span>
    832. 

  832. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    833. 

  833. <span class="sd">        &gt;&gt;&gt; obs[&#39;mission&#39;][:10]</span>
    834. 

  834. <span class="sd">        [19, 31, 17, 36, 20, 38, 31, 2, 15, 35]</span>
    835. 

  835. <span class="sd">    &quot;&quot;&quot;</span>
    836. 

  836. 

  837.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">max_words_in_mission</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">word_dict</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    838. 

  838. <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
    839. 

  839. <span class="sd">        max_words_in_mission is the length of the array to represent a mission, value 0 for missing words</span>
    840. 

  840. <span class="sd">        word_dict is a dictionary of words to use (keys=words, values=indices from 1 to &lt; max_words_in_mission),</span>
    841. 

  841. <span class="sd">                  if None, use the Minigrid language</span>
    842. 

  842. <span class="sd">        &quot;&quot;&quot;</span>
    843. 

  843.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    844. 

  844. 

  845.         <span class="k">if</span> <span class="n">word_dict</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    846. 

  846.             <span class="n">word_dict</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_minigrid_words</span><span class="p">()</span>
    847. 

  847. 

  848.         <span class="bp">self</span><span class="o">.</span><span class="n">max_words_in_mission</span> <span class="o">=</span> <span class="n">max_words_in_mission</span>
    849. 

  849.         <span class="bp">self</span><span class="o">.</span><span class="n">word_dict</span> <span class="o">=</span> <span class="n">word_dict</span>
    850. 

  850. 

  851.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    852. 

  852.             <span class="p">{</span>
    853. 

  853.                 <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">],</span>
    854. 

  854.                 <span class="s2">&quot;direction&quot;</span><span class="p">:</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">4</span><span class="p">),</span>
    855. 

  855.                 <span class="s2">&quot;mission&quot;</span><span class="p">:</span> <span class="n">spaces</span><span class="o">.</span><span class="n">MultiDiscrete</span><span class="p">(</span>
    856. 

  856.                     <span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">word_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">())]</span> <span class="o">*</span> <span class="n">max_words_in_mission</span>
    857. 

  857.                 <span class="p">),</span>
    858. 

  858.             <span class="p">}</span>
    859. 

  859.         <span class="p">)</span>
    860. 

  860. 

  861.     <span class="nd">@staticmethod</span>
    862. 

  862.     <span class="k">def</span> <span class="nf">get_minigrid_words</span><span class="p">():</span>
    863. 

  863.         <span class="n">colors</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;red&quot;</span><span class="p">,</span> <span class="s2">&quot;green&quot;</span><span class="p">,</span> <span class="s2">&quot;blue&quot;</span><span class="p">,</span> <span class="s2">&quot;yellow&quot;</span><span class="p">,</span> <span class="s2">&quot;purple&quot;</span><span class="p">,</span> <span class="s2">&quot;grey&quot;</span><span class="p">]</span>
    864. 

  864.         <span class="n">objects</span> <span class="o">=</span> <span class="p">[</span>
    865. 

  865.             <span class="s2">&quot;unseen&quot;</span><span class="p">,</span>
    866. 

  866.             <span class="s2">&quot;empty&quot;</span><span class="p">,</span>
    867. 

  867.             <span class="s2">&quot;wall&quot;</span><span class="p">,</span>
    868. 

  868.             <span class="s2">&quot;floor&quot;</span><span class="p">,</span>
    869. 

  869.             <span class="s2">&quot;box&quot;</span><span class="p">,</span>
    870. 

  870.             <span class="s2">&quot;key&quot;</span><span class="p">,</span>
    871. 

  871.             <span class="s2">&quot;ball&quot;</span><span class="p">,</span>
    872. 

  872.             <span class="s2">&quot;door&quot;</span><span class="p">,</span>
    873. 

  873.             <span class="s2">&quot;goal&quot;</span><span class="p">,</span>
    874. 

  874.             <span class="s2">&quot;agent&quot;</span><span class="p">,</span>
    875. 

  875.             <span class="s2">&quot;lava&quot;</span><span class="p">,</span>
    876. 

  876.         <span class="p">]</span>
    877. 

  877. 

  878.         <span class="n">verbs</span> <span class="o">=</span> <span class="p">[</span>
    879. 

  879.             <span class="s2">&quot;pick&quot;</span><span class="p">,</span>
    880. 

  880.             <span class="s2">&quot;avoid&quot;</span><span class="p">,</span>
    881. 

  881.             <span class="s2">&quot;get&quot;</span><span class="p">,</span>
    882. 

  882.             <span class="s2">&quot;find&quot;</span><span class="p">,</span>
    883. 

  883.             <span class="s2">&quot;put&quot;</span><span class="p">,</span>
    884. 

  884.             <span class="s2">&quot;use&quot;</span><span class="p">,</span>
    885. 

  885.             <span class="s2">&quot;open&quot;</span><span class="p">,</span>
    886. 

  886.             <span class="s2">&quot;go&quot;</span><span class="p">,</span>
    887. 

  887.             <span class="s2">&quot;fetch&quot;</span><span class="p">,</span>
    888. 

  888.             <span class="s2">&quot;reach&quot;</span><span class="p">,</span>
    889. 

  889.             <span class="s2">&quot;unlock&quot;</span><span class="p">,</span>
    890. 

  890.             <span class="s2">&quot;traverse&quot;</span><span class="p">,</span>
    891. 

  891.         <span class="p">]</span>
    892. 

  892. 

  893.         <span class="n">extra_words</span> <span class="o">=</span> <span class="p">[</span>
    894. 

  894.             <span class="s2">&quot;up&quot;</span><span class="p">,</span>
    895. 

  895.             <span class="s2">&quot;the&quot;</span><span class="p">,</span>
    896. 

  896.             <span class="s2">&quot;a&quot;</span><span class="p">,</span>
    897. 

  897.             <span class="s2">&quot;at&quot;</span><span class="p">,</span>
    898. 

  898.             <span class="s2">&quot;,&quot;</span><span class="p">,</span>
    899. 

  899.             <span class="s2">&quot;square&quot;</span><span class="p">,</span>
    900. 

  900.             <span class="s2">&quot;and&quot;</span><span class="p">,</span>
    901. 

  901.             <span class="s2">&quot;then&quot;</span><span class="p">,</span>
    902. 

  902.             <span class="s2">&quot;to&quot;</span><span class="p">,</span>
    903. 

  903.             <span class="s2">&quot;of&quot;</span><span class="p">,</span>
    904. 

  904.             <span class="s2">&quot;rooms&quot;</span><span class="p">,</span>
    905. 

  905.             <span class="s2">&quot;near&quot;</span><span class="p">,</span>
    906. 

  906.             <span class="s2">&quot;opening&quot;</span><span class="p">,</span>
    907. 

  907.             <span class="s2">&quot;must&quot;</span><span class="p">,</span>
    908. 

  908.             <span class="s2">&quot;you&quot;</span><span class="p">,</span>
    909. 

  909.             <span class="s2">&quot;matching&quot;</span><span class="p">,</span>
    910. 

  910.             <span class="s2">&quot;end&quot;</span><span class="p">,</span>
    911. 

  911.             <span class="s2">&quot;hallway&quot;</span><span class="p">,</span>
    912. 

  912.             <span class="s2">&quot;object&quot;</span><span class="p">,</span>
    913. 

  913.             <span class="s2">&quot;from&quot;</span><span class="p">,</span>
    914. 

  914.             <span class="s2">&quot;room&quot;</span><span class="p">,</span>
    915. 

  915.             <span class="s2">&quot;maze&quot;</span><span class="p">,</span>
    916. 

  916.         <span class="p">]</span>
    917. 

  917. 

  918.         <span class="n">all_words</span> <span class="o">=</span> <span class="n">colors</span> <span class="o">+</span> <span class="n">objects</span> <span class="o">+</span> <span class="n">verbs</span> <span class="o">+</span> <span class="n">extra_words</span>
    919. 

  919.         <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_words</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">all_words</span><span class="p">))</span>
    920. 

  920.         <span class="k">return</span> <span class="p">{</span><span class="n">word</span><span class="p">:</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">word</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">all_words</span><span class="p">)}</span>
    921. 

  921. 

  922.     <span class="k">def</span> <span class="nf">string_to_indices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">string</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
    923. 

  923. <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
    924. 

  924. <span class="sd">        Convert a string to a list of indices.</span>
    925. 

  925. <span class="sd">        &quot;&quot;&quot;</span>
    926. 

  926.         <span class="n">indices</span> <span class="o">=</span> <span class="p">[]</span>
    927. 

  927.         <span class="c1"># adding space before and after commas</span>
    928. 

  928.         <span class="n">string</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot;,&quot;</span><span class="p">,</span> <span class="s2">&quot; , &quot;</span><span class="p">)</span>
    929. 

  929.         <span class="k">for</span> <span class="n">word</span> <span class="ow">in</span> <span class="n">string</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>
    930. 

  930.             <span class="k">if</span> <span class="n">word</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">word_dict</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
    931. 

  931.                 <span class="n">indices</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">word_dict</span><span class="p">[</span><span class="n">word</span><span class="p">]</span> <span class="o">+</span> <span class="n">offset</span><span class="p">)</span>
    932. 

  932.             <span class="k">else</span><span class="p">:</span>
    933. 

  933.                 <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unknown word: </span><span class="si">{</span><span class="n">word</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    934. 

  934.         <span class="k">return</span> <span class="n">indices</span>
    935. 

  935. 

  936.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    937. 

  937.         <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">string_to_indices</span><span class="p">(</span><span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">])</span>
    938. 

  938.         <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">])</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_words_in_mission</span>
    939. 

  939.         <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">]</span> <span class="o">+=</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_words_in_mission</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">]))</span>
    940. 

  940. 

  941.         <span class="k">return</span> <span class="n">obs</span></div>
    942. 

  942. 

  943. 

  944. 

  945. <div class="viewcode-block" id="FlatObsWrapper">
    946. 

  946. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.FlatObsWrapper">[docs]</a>
    947. 

  947. <span class="k">class</span> <span class="nc">FlatObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    948. 

  948. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    949. 

  949. <span class="sd">    Encode mission strings using a one-hot scheme,</span>
    950. 

  950. <span class="sd">    and combine these with observed images into one flat array.</span>
    951. 

  951. 

  952. <span class="sd">    This wrapper is not applicable to BabyAI environments, given that these have their own language component.</span>
    953. 

  953. 

  954. <span class="sd">    Example:</span>
    955. 

  955. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    956. 

  956. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    957. 

  957. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import FlatObsWrapper</span>
    958. 

  958. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    959. 

  959. <span class="sd">        &gt;&gt;&gt; env_obs = FlatObsWrapper(env)</span>
    960. 

  960. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    961. 

  961. <span class="sd">        &gt;&gt;&gt; obs.shape</span>
    962. 

  962. <span class="sd">        (2835,)</span>
    963. 

  963. <span class="sd">    &quot;&quot;&quot;</span>
    964. 

  964. 

  965.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">maxStrLen</span><span class="o">=</span><span class="mi">96</span><span class="p">):</span>
    966. 

  966.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    967. 

  967. 

  968.         <span class="bp">self</span><span class="o">.</span><span class="n">maxStrLen</span> <span class="o">=</span> <span class="n">maxStrLen</span>
    969. 

  969.         <span class="bp">self</span><span class="o">.</span><span class="n">numCharCodes</span> <span class="o">=</span> <span class="mi">28</span>
    970. 

  970. 

  971.         <span class="n">imgSpace</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span>
    972. 

  972.         <span class="n">imgSize</span> <span class="o">=</span> <span class="n">reduce</span><span class="p">(</span><span class="n">operator</span><span class="o">.</span><span class="n">mul</span><span class="p">,</span> <span class="n">imgSpace</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
    973. 

  973. 

  974.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    975. 

  975.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
    976. 

  976.             <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span>
    977. 

  977.             <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">imgSize</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">numCharCodes</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">maxStrLen</span><span class="p">,),</span>
    978. 

  978.             <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">,</span>
    979. 

  979.         <span class="p">)</span>
    980. 

  980. 

  981.         <span class="bp">self</span><span class="o">.</span><span class="n">cachedStr</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span>
    982. 

  982. 

  983.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    984. 

  984.         <span class="n">image</span> <span class="o">=</span> <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span>
    985. 

  985.         <span class="n">mission</span> <span class="o">=</span> <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;mission&quot;</span><span class="p">]</span>
    986. 

  986. 

  987.         <span class="c1"># Cache the last-encoded mission string</span>
    988. 

  988.         <span class="k">if</span> <span class="n">mission</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cachedStr</span><span class="p">:</span>
    989. 

  989.             <span class="k">assert</span> <span class="p">(</span>
    990. 

  990.                 <span class="nb">len</span><span class="p">(</span><span class="n">mission</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">maxStrLen</span>
    991. 

  991.             <span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;mission string too long (</span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">mission</span><span class="p">)</span><span class="si">}</span><span class="s2"> chars)&quot;</span>
    992. 

  992.             <span class="n">mission</span> <span class="o">=</span> <span class="n">mission</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
    993. 

  993. 

  994.             <span class="n">strArray</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
    995. 

  995.                 <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">maxStrLen</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">numCharCodes</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;float32&quot;</span>
    996. 

  996.             <span class="p">)</span>
    997. 

  997. 

  998.             <span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">ch</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">mission</span><span class="p">):</span>
    999. 

  999.                 <span class="k">if</span> <span class="n">ch</span> <span class="o">&gt;=</span> <span class="s2">&quot;a&quot;</span> <span class="ow">and</span> <span class="n">ch</span> <span class="o">&lt;=</span> <span class="s2">&quot;z&quot;</span><span class="p">:</span>
    1000. 

  1000.                     <span class="n">chNo</span> <span class="o">=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">ch</span><span class="p">)</span> <span class="o">-</span> <span class="nb">ord</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span>
    1001. 

  1001.                 <span class="k">elif</span> <span class="n">ch</span> <span class="o">==</span> <span class="s2">&quot; &quot;</span><span class="p">:</span>
    1002. 

  1002.                     <span class="n">chNo</span> <span class="o">=</span> <span class="nb">ord</span><span class="p">(</span><span class="s2">&quot;z&quot;</span><span class="p">)</span> <span class="o">-</span> <span class="nb">ord</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>
    1003. 

  1003.                 <span class="k">elif</span> <span class="n">ch</span> <span class="o">==</span> <span class="s2">&quot;,&quot;</span><span class="p">:</span>
    1004. 

  1004.                     <span class="n">chNo</span> <span class="o">=</span> <span class="nb">ord</span><span class="p">(</span><span class="s2">&quot;z&quot;</span><span class="p">)</span> <span class="o">-</span> <span class="nb">ord</span><span class="p">(</span><span class="s2">&quot;a&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">2</span>
    1005. 

  1005.                 <span class="k">else</span><span class="p">:</span>
    1006. 

  1006.                     <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
    1007. 

  1007.                         <span class="sa">f</span><span class="s2">&quot;Character </span><span class="si">{</span><span class="n">ch</span><span class="si">}</span><span class="s2"> is not available in mission string.&quot;</span>
    1008. 

  1008.                     <span class="p">)</span>
    1009. 

  1009.                 <span class="k">assert</span> <span class="n">chNo</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">numCharCodes</span><span class="p">,</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> : </span><span class="si">%d</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ch</span><span class="p">,</span> <span class="n">chNo</span><span class="p">)</span>
    1010. 

  1010.                 <span class="n">strArray</span><span class="p">[</span><span class="n">idx</span><span class="p">,</span> <span class="n">chNo</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
    1011. 

  1011. 

  1012.             <span class="bp">self</span><span class="o">.</span><span class="n">cachedStr</span> <span class="o">=</span> <span class="n">mission</span>
    1013. 

  1013.             <span class="bp">self</span><span class="o">.</span><span class="n">cachedArray</span> <span class="o">=</span> <span class="n">strArray</span>
    1014. 

  1014. 

  1015.         <span class="n">obs</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="n">image</span><span class="o">.</span><span class="n">flatten</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">cachedArray</span><span class="o">.</span><span class="n">flatten</span><span class="p">()))</span>
    1016. 

  1016. 

  1017.         <span class="k">return</span> <span class="n">obs</span></div>
    1018. 

  1018. 

  1019. 

  1020. 

  1021. <div class="viewcode-block" id="ViewSizeWrapper">
    1022. 

  1022. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.ViewSizeWrapper">[docs]</a>
    1023. 

  1023. <span class="k">class</span> <span class="nc">ViewSizeWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    1024. 

  1024. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    1025. 

  1025. <span class="sd">    Wrapper to customize the agent field of view size.</span>
    1026. 

  1026. <span class="sd">    This cannot be used with fully observable wrappers.</span>
    1027. 

  1027. 

  1028. <span class="sd">    Example:</span>
    1029. 

  1029. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    1030. 

  1030. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import ViewSizeWrapper</span>
    1031. 

  1031. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    1032. 

  1032. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    1033. 

  1033. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    1034. 

  1034. <span class="sd">        (7, 7, 3)</span>
    1035. 

  1035. <span class="sd">        &gt;&gt;&gt; env_obs = ViewSizeWrapper(env, agent_view_size=5)</span>
    1036. 

  1036. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    1037. 

  1037. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    1038. 

  1038. <span class="sd">        (5, 5, 3)</span>
    1039. 

  1039. <span class="sd">    &quot;&quot;&quot;</span>
    1040. 

  1040. 

  1041.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">agent_view_size</span><span class="o">=</span><span class="mi">7</span><span class="p">):</span>
    1042. 

  1042.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    1043. 

  1043. 

  1044.         <span class="k">assert</span> <span class="n">agent_view_size</span> <span class="o">%</span> <span class="mi">2</span> <span class="o">==</span> <span class="mi">1</span>
    1045. 

  1045.         <span class="k">assert</span> <span class="n">agent_view_size</span> <span class="o">&gt;=</span> <span class="mi">3</span>
    1046. 

  1046. 

  1047.         <span class="bp">self</span><span class="o">.</span><span class="n">agent_view_size</span> <span class="o">=</span> <span class="n">agent_view_size</span>
    1048. 

  1048. 

  1049.         <span class="c1"># Compute observation space with specified view size</span>
    1050. 

  1050.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    1051. 

  1051.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">agent_view_size</span><span class="p">,</span> <span class="n">agent_view_size</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span>
    1052. 

  1052.         <span class="p">)</span>
    1053. 

  1053. 

  1054.         <span class="c1"># Override the environment&#39;s observation spaceexit</span>
    1055. 

  1055.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    1056. 

  1056.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    1057. 

  1057.         <span class="p">)</span>
    1058. 

  1058. 

  1059.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    1060. 

  1060.         <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">unwrapped</span>
    1061. 

  1061. 

  1062.         <span class="n">grid</span><span class="p">,</span> <span class="n">vis_mask</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">gen_obs_grid</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">agent_view_size</span><span class="p">)</span>
    1063. 

  1063. 

  1064.         <span class="c1"># Encode the partially observable view into a numpy array</span>
    1065. 

  1065.         <span class="n">image</span> <span class="o">=</span> <span class="n">grid</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">vis_mask</span><span class="p">)</span>
    1066. 

  1066. 

  1067.         <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">obs</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">image</span><span class="p">}</span></div>
    1068. 

  1068. 

  1069. 

  1070. 

  1071. <div class="viewcode-block" id="DirectionObsWrapper">
    1072. 

  1072. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.DirectionObsWrapper">[docs]</a>
    1073. 

  1073. <span class="k">class</span> <span class="nc">DirectionObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    1074. 

  1074. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    1075. 

  1075. <span class="sd">    Provides the slope/angular direction to the goal with the observations as modeled by (y2 - y2 )/( x2 - x1)</span>
    1076. 

  1076. <span class="sd">    type = {slope , angle}</span>
    1077. 

  1077. 

  1078. <span class="sd">    Example:</span>
    1079. 

  1079. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    1080. 

  1080. <span class="sd">        &gt;&gt;&gt; import matplotlib.pyplot as plt</span>
    1081. 

  1081. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import DirectionObsWrapper</span>
    1082. 

  1082. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    1083. 

  1083. <span class="sd">        &gt;&gt;&gt; env_obs = DirectionObsWrapper(env, type=&quot;slope&quot;)</span>
    1084. 

  1084. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    1085. 

  1085. <span class="sd">        &gt;&gt;&gt; obs[&#39;goal_direction&#39;]</span>
    1086. 

  1086. <span class="sd">        1.0</span>
    1087. 

  1087. <span class="sd">    &quot;&quot;&quot;</span>
    1088. 

  1088. 

  1089.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;slope&quot;</span><span class="p">):</span>
    1090. 

  1090.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    1091. 

  1091.         <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">:</span> <span class="nb">tuple</span> <span class="o">=</span> <span class="kc">None</span>
    1092. 

  1092.         <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="nb">type</span>
    1093. 

  1093. 

  1094.     <span class="k">def</span> <span class="nf">reset</span><span class="p">(</span>
    1095. 

  1095.         <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    1096. 

  1096.     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
    1097. 

  1097.         <span class="n">obs</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
    1098. 

  1098. 

  1099.         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">:</span>
    1100. 

  1100.             <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span> <span class="o">=</span> <span class="p">[</span>
    1101. 

  1101.                 <span class="n">x</span> <span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">grid</span><span class="p">)</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">Goal</span><span class="p">)</span>
    1102. 

  1102.             <span class="p">]</span>
    1103. 

  1103.             <span class="c1"># in case there are multiple goals , needs to be handled for other env types</span>
    1104. 

  1104.             <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
    1105. 

  1105.                 <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span> <span class="o">=</span> <span class="p">(</span>
    1106. 

  1106.                     <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">height</span><span class="p">),</span>
    1107. 

  1107.                     <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span>
    1108. 

  1108.                 <span class="p">)</span>
    1109. 

  1109. 

  1110.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation</span><span class="p">(</span><span class="n">obs</span><span class="p">),</span> <span class="n">info</span>
    1111. 

  1111. 

  1112.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    1113. 

  1113.         <span class="n">slope</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">divide</span><span class="p">(</span>
    1114. 

  1114.             <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
    1115. 

  1115.             <span class="bp">self</span><span class="o">.</span><span class="n">goal_position</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span>
    1116. 

  1116.         <span class="p">)</span>
    1117. 

  1117. 

  1118.         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s2">&quot;angle&quot;</span><span class="p">:</span>
    1119. 

  1119.             <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;goal_direction&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arctan</span><span class="p">(</span><span class="n">slope</span><span class="p">)</span>
    1120. 

  1120.         <span class="k">else</span><span class="p">:</span>
    1121. 

  1121.             <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;goal_direction&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">slope</span>
    1122. 

  1122. 

  1123.         <span class="k">return</span> <span class="n">obs</span></div>
    1124. 

  1124. 

  1125. 

  1126. 

  1127. <div class="viewcode-block" id="SymbolicObsWrapper">
    1128. 

  1128. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.SymbolicObsWrapper">[docs]</a>
    1129. 

  1129. <span class="k">class</span> <span class="nc">SymbolicObsWrapper</span><span class="p">(</span><span class="n">ObservationWrapper</span><span class="p">):</span>
    1130. 

  1130. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    1131. 

  1131. <span class="sd">    Fully observable grid with a symbolic state representation.</span>
    1132. 

  1132. <span class="sd">    The symbol is a triple of (X, Y, IDX), where X and Y are</span>
    1133. 

  1133. <span class="sd">    the coordinates on the grid, and IDX is the id of the object.</span>
    1134. 

  1134. 

  1135. <span class="sd">    Example:</span>
    1136. 

  1136. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    1137. 

  1137. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import SymbolicObsWrapper</span>
    1138. 

  1138. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS11N5-v0&quot;)</span>
    1139. 

  1139. <span class="sd">        &gt;&gt;&gt; obs, _ = env.reset()</span>
    1140. 

  1140. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    1141. 

  1141. <span class="sd">        (7, 7, 3)</span>
    1142. 

  1142. <span class="sd">        &gt;&gt;&gt; env_obs = SymbolicObsWrapper(env)</span>
    1143. 

  1143. <span class="sd">        &gt;&gt;&gt; obs, _ = env_obs.reset()</span>
    1144. 

  1144. <span class="sd">        &gt;&gt;&gt; obs[&#39;image&#39;].shape</span>
    1145. 

  1145. <span class="sd">        (11, 11, 3)</span>
    1146. 

  1146. <span class="sd">    &quot;&quot;&quot;</span>
    1147. 

  1147. 

  1148.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
    1149. 

  1149.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    1150. 

  1150. 

  1151.         <span class="n">new_image_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span>
    1152. 

  1152.             <span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
    1153. 

  1153.             <span class="n">high</span><span class="o">=</span><span class="nb">max</span><span class="p">(</span><span class="n">OBJECT_TO_IDX</span><span class="o">.</span><span class="n">values</span><span class="p">()),</span>
    1154. 

  1154.             <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">height</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span>  <span class="c1"># number of cells</span>
    1155. 

  1155.             <span class="n">dtype</span><span class="o">=</span><span class="s2">&quot;uint8&quot;</span><span class="p">,</span>
    1156. 

  1156.         <span class="p">)</span>
    1157. 

  1157.         <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span>
    1158. 

  1158.             <span class="p">{</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">spaces</span><span class="p">,</span> <span class="s2">&quot;image&quot;</span><span class="p">:</span> <span class="n">new_image_space</span><span class="p">}</span>
    1159. 

  1159.         <span class="p">)</span>
    1160. 

  1160. 

  1161.     <span class="k">def</span> <span class="nf">observation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
    1162. 

  1162.         <span class="n">objects</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span>
    1163. 

  1163.             <span class="p">[</span><span class="n">OBJECT_TO_IDX</span><span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">type</span><span class="p">]</span> <span class="k">if</span> <span class="n">o</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="o">-</span><span class="mi">1</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">grid</span><span class="p">]</span>
    1164. 

  1164.         <span class="p">)</span>
    1165. 

  1165.         <span class="n">agent_pos</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">agent_pos</span>
    1166. 

  1166.         <span class="n">ncol</span><span class="p">,</span> <span class="n">nrow</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">height</span>
    1167. 

  1167.         <span class="n">grid</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">mgrid</span><span class="p">[:</span><span class="n">ncol</span><span class="p">,</span> <span class="p">:</span><span class="n">nrow</span><span class="p">]</span>
    1168. 

  1168.         <span class="n">_objects</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="n">objects</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">nrow</span><span class="p">,</span> <span class="n">ncol</span><span class="p">),</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
    1169. 

  1169. 

  1170.         <span class="n">grid</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">grid</span><span class="p">,</span> <span class="n">_objects</span><span class="p">])</span>
    1171. 

  1171.         <span class="n">grid</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">transpose</span><span class="p">(</span><span class="n">grid</span><span class="p">,</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
    1172. 

  1172.         <span class="n">grid</span><span class="p">[</span><span class="n">agent_pos</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">agent_pos</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">OBJECT_TO_IDX</span><span class="p">[</span><span class="s2">&quot;agent&quot;</span><span class="p">]</span>
    1173. 

  1173.         <span class="n">obs</span><span class="p">[</span><span class="s2">&quot;image&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">grid</span>
    1174. 

  1174. 

  1175.         <span class="k">return</span> <span class="n">obs</span></div>
    1176. 

  1176. 

  1177. 

  1178. 

  1179. <div class="viewcode-block" id="StochasticActionWrapper">
    1180. 

  1180. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.StochasticActionWrapper">[docs]</a>
    1181. 

  1181. <span class="k">class</span> <span class="nc">StochasticActionWrapper</span><span class="p">(</span><span class="n">ActionWrapper</span><span class="p">):</span>
    1182. 

  1182. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    1183. 

  1183. <span class="sd">    Add stochasticity to the actions</span>
    1184. 

  1184. 

  1185. <span class="sd">    If a random action is provided, it is returned with probability `1 - prob`.</span>
    1186. 

  1186. <span class="sd">    Else, a random action is sampled from the action space.</span>
    1187. 

  1187. <span class="sd">    &quot;&quot;&quot;</span>
    1188. 

  1188. 

  1189.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">prob</span><span class="o">=</span><span class="mf">0.9</span><span class="p">,</span> <span class="n">random_action</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    1190. 

  1190.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    1191. 

  1191.         <span class="bp">self</span><span class="o">.</span><span class="n">prob</span> <span class="o">=</span> <span class="n">prob</span>
    1192. 

  1192.         <span class="bp">self</span><span class="o">.</span><span class="n">random_action</span> <span class="o">=</span> <span class="n">random_action</span>
    1193. 

  1193. 

  1194.     <span class="k">def</span> <span class="nf">action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
    1195. 

  1195. <span class="w">        </span><span class="sd">&quot;&quot;&quot; &quot;&quot;&quot;</span>
    1196. 

  1196.         <span class="k">if</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">uniform</span><span class="p">()</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">prob</span><span class="p">:</span>
    1197. 

  1197.             <span class="k">return</span> <span class="n">action</span>
    1198. 

  1198.         <span class="k">else</span><span class="p">:</span>
    1199. 

  1199.             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">random_action</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    1200. 

  1200.                 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">np_random</span><span class="o">.</span><span class="n">integers</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span>
    1201. 

  1201.             <span class="k">else</span><span class="p">:</span>
    1202. 

  1202.                 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">random_action</span></div>
    1203. 

  1203. 

  1204. 

  1205. 

  1206. <div class="viewcode-block" id="NoDeath">
    1207. 

  1207. <a class="viewcode-back" href="../../../api/wrappers/#minigrid.wrappers.NoDeath">[docs]</a>
    1208. 

  1208. <span class="k">class</span> <span class="nc">NoDeath</span><span class="p">(</span><span class="n">Wrapper</span><span class="p">):</span>
    1209. 

  1209. <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
    1210. 

  1210. <span class="sd">    Wrapper to prevent death in specific cells (e.g., lava cells).</span>
    1211. 

  1211. <span class="sd">    Instead of dying, the agent will receive a negative reward.</span>
    1212. 

  1212. 

  1213. <span class="sd">    Example:</span>
    1214. 

  1214. <span class="sd">        &gt;&gt;&gt; import gymnasium as gym</span>
    1215. 

  1215. <span class="sd">        &gt;&gt;&gt; from minigrid.wrappers import NoDeath</span>
    1216. 

  1216. <span class="sd">        &gt;&gt;&gt;</span>
    1217. 

  1217. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-LavaCrossingS9N1-v0&quot;)</span>
    1218. 

  1218. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=2)</span>
    1219. 

  1219. <span class="sd">        &gt;&gt;&gt; _, _, _, _, _ = env.step(1)</span>
    1220. 

  1220. <span class="sd">        &gt;&gt;&gt; _, reward, term, *_ = env.step(2)</span>
    1221. 

  1221. <span class="sd">        &gt;&gt;&gt; reward, term</span>
    1222. 

  1222. <span class="sd">        (0, True)</span>
    1223. 

  1223. <span class="sd">        &gt;&gt;&gt;</span>
    1224. 

  1224. <span class="sd">        &gt;&gt;&gt; env = NoDeath(env, no_death_types=(&quot;lava&quot;,), death_cost=-1.0)</span>
    1225. 

  1225. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=2)</span>
    1226. 

  1226. <span class="sd">        &gt;&gt;&gt; _, _, _, _, _ = env.step(1)</span>
    1227. 

  1227. <span class="sd">        &gt;&gt;&gt; _, reward, term, *_ = env.step(2)</span>
    1228. 

  1228. <span class="sd">        &gt;&gt;&gt; reward, term</span>
    1229. 

  1229. <span class="sd">        (-1.0, False)</span>
    1230. 

  1230. <span class="sd">        &gt;&gt;&gt;</span>
    1231. 

  1231. <span class="sd">        &gt;&gt;&gt;</span>
    1232. 

  1232. <span class="sd">        &gt;&gt;&gt; env = gym.make(&quot;MiniGrid-Dynamic-Obstacles-5x5-v0&quot;)</span>
    1233. 

  1233. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=2)</span>
    1234. 

  1234. <span class="sd">        &gt;&gt;&gt; _, reward, term, *_ = env.step(2)</span>
    1235. 

  1235. <span class="sd">        &gt;&gt;&gt; reward, term</span>
    1236. 

  1236. <span class="sd">        (-1, True)</span>
    1237. 

  1237. <span class="sd">        &gt;&gt;&gt;</span>
    1238. 

  1238. <span class="sd">        &gt;&gt;&gt; env = NoDeath(env, no_death_types=(&quot;ball&quot;,), death_cost=-1.0)</span>
    1239. 

  1239. <span class="sd">        &gt;&gt;&gt; _, _ = env.reset(seed=2)</span>
    1240. 

  1240. <span class="sd">        &gt;&gt;&gt; _, reward, term, *_ = env.step(2)</span>
    1241. 

  1241. <span class="sd">        &gt;&gt;&gt; reward, term</span>
    1242. 

  1242. <span class="sd">        (-2.0, False)</span>
    1243. 

  1243. <span class="sd">    &quot;&quot;&quot;</span>
    1244. 

  1244. 

  1245.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span> <span class="n">no_death_types</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span> <span class="n">death_cost</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1.0</span><span class="p">):</span>
    1246. 

  1246. <span class="w">        </span><span class="sd">&quot;&quot;&quot;A wrapper to prevent death in specific cells.</span>
    1247. 

  1247. 

  1248. <span class="sd">        Args:</span>
    1249. 

  1249. <span class="sd">            env: The environment to apply the wrapper</span>
    1250. 

  1250. <span class="sd">            no_death_types: List of strings to identify death cells</span>
    1251. 

  1251. <span class="sd">            death_cost: The negative reward received in death cells</span>
    1252. 

  1252. 

  1253. <span class="sd">        &quot;&quot;&quot;</span>
    1254. 

  1254.         <span class="k">assert</span> <span class="s2">&quot;goal&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">no_death_types</span><span class="p">,</span> <span class="s2">&quot;goal cannot be a death cell&quot;</span>
    1255. 

  1255. 

  1256.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
    1257. 

  1257.         <span class="bp">self</span><span class="o">.</span><span class="n">death_cost</span> <span class="o">=</span> <span class="n">death_cost</span>
    1258. 

  1258.         <span class="bp">self</span><span class="o">.</span><span class="n">no_death_types</span> <span class="o">=</span> <span class="n">no_death_types</span>
    1259. 

  1259. 

  1260.     <span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
    1261. 

  1261.         <span class="c1"># In Dynamic-Obstacles, obstacles move after the agent moves,</span>
    1262. 

  1262.         <span class="c1"># so we need to check for collision before self.env.step()</span>
    1263. 

  1263.         <span class="n">front_cell</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">front_pos</span><span class="p">)</span>
    1264. 

  1264.         <span class="n">going_to_death</span> <span class="o">=</span> <span class="p">(</span>
    1265. 

  1265.             <span class="n">action</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">actions</span><span class="o">.</span><span class="n">forward</span>
    1266. 

  1266.             <span class="ow">and</span> <span class="n">front_cell</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
    1267. 

  1267.             <span class="ow">and</span> <span class="n">front_cell</span><span class="o">.</span><span class="n">type</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">no_death_types</span>
    1268. 

  1268.         <span class="p">)</span>
    1269. 

  1269. 

  1270.         <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
    1271. 

  1271. 

  1272.         <span class="c1"># We also check if the agent stays in death cells (e.g., lava)</span>
    1273. 

  1273.         <span class="c1"># without moving</span>
    1274. 

  1274.         <span class="n">current_cell</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">agent_pos</span><span class="p">)</span>
    1275. 

  1275.         <span class="n">in_death</span> <span class="o">=</span> <span class="n">current_cell</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">current_cell</span><span class="o">.</span><span class="n">type</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">no_death_types</span>
    1276. 

  1276. 

  1277.         <span class="k">if</span> <span class="n">terminated</span> <span class="ow">and</span> <span class="p">(</span><span class="n">going_to_death</span> <span class="ow">or</span> <span class="n">in_death</span><span class="p">):</span>
    1278. 

  1278.             <span class="n">terminated</span> <span class="o">=</span> <span class="kc">False</span>
    1279. 

  1279.             <span class="n">reward</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">death_cost</span>
    1280. 

  1280. 

  1281.         <span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span></div>
    1282. 

  1282. 

  1283. </pre></div>
    1284. 

  1284.           </article>
    1285. 

  1285.         </div>
    1286. 

  1286.         <footer>
    1287. 

  1287.           
    1288. 

  1288.           <div class="related-pages">
    1289. 

  1289.             
    1290. 

  1290.             
    1291. 

  1291.           </div>
    1292. 

  1292.           <div class="bottom-of-page">
    1293. 

  1293.             <div class="left-details">
    1294. 

  1294.               <div class="copyright">
    1295. 

  1295.                 Copyright &#169; 2023 Farama Foundation
    1296. 

  1296.               </div>
    1297. 

  1297.               <!--
    1298. 

  1298.             Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
    1299. 

  1299.             
    1300. 

  1300.             <a href="https://github.com/pradyunsg/furo">Furo</a>
    1301. 

  1301.             -->
    1302. 

  1302.             </div>
    1303. 

  1303.             <div class="right-details">
    1304. 

  1304.               <div class="icons">
    1305. 

  1305.                 <a class="muted-link" href="https://github.com/Farama-Foundation/Minigrid/"
    1306. 

  1306.                   aria-label="On GitHub">
    1307. 

  1307.                   <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
    1308. 

  1308.                     <path fill-rule="evenodd"
    1309. 

  1309.                       d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">
    1310. 

  1310.                     </path>
    1311. 

  1311.                   </svg>
    1312. 

  1312.                 </a>
    1313. 

  1313.               </div>
    1314. 

  1314.             </div>
    1315. 

  1315.           </div>
    1316. 

  1316.           
    1317. 

  1317.         </footer>
    1318. 

  1318.       </div>
    1319. 

  1319.       <aside class="toc-drawer no-toc">
    1320. 

  1320.         
    1321. 

  1321.         
    1322. 

  1322.         
    1323. 

  1323.       </aside>
    1324. 

  1324.     </div>
    1325. 

  1325.   </div>
    1326. 

  1326. </div>
    1327. 

  1327.     <script>
    1328. 

  1328.       const toggleMenu = () => {
    1329. 

  1329.         const menuBtn = document.querySelector(".farama-header-menu__btn");
    1330. 

  1330.         const menuContainer = document.querySelector(".farama-header-menu-container");
    1331. 

  1331.         if (document.querySelector(".farama-header-menu").classList.contains("active")) {
    1332. 

  1332.           menuBtn.setAttribute("aria-expanded", "false");
    1333. 

  1333.           menuContainer.setAttribute("aria-hidden", "true");
    1334. 

  1334.         } else {
    1335. 

  1335.           menuBtn.setAttribute("aria-expanded", "true");
    1336. 

  1336.           menuContainer.setAttribute("aria-hidden", "false");
    1337. 

  1337.         }
    1338. 

  1338.         document.querySelector(".farama-header-menu").classList.toggle("active");
    1339. 

  1339.       }
    1340. 

  1340. 

  1341.       document.querySelector(".farama-header-menu__btn").addEventListener("click", toggleMenu);
    1342. 

  1342.       document.getElementById("farama-close-menu").addEventListener("click", toggleMenu);
    1343. 

  1343.     </script>
    1344. 

  1344. 

  1345.     
    1346. 

  1346.     <script async src="https://www.googletagmanager.com/gtag/js?id=G-FBXJQQLXKD"></script>
    1347. 

  1347.       <script>
    1348. 

  1348.         const enableGtag = () => {
    1349. 

  1349.           window.dataLayer = window.dataLayer || [];
    1350. 

  1350.           function gtag(){dataLayer.push(arguments);}
    1351. 

  1351.           gtag('js', new Date());
    1352. 

  1352.           gtag('config', 'G-FBXJQQLXKD');
    1353. 

  1353.         }
    1354. 

  1354.         (() => {
    1355. 

  1355.             if (!localStorage.getItem("acceptedCookieAlert")) {
    1356. 

  1356.                 const boxElem = document.createElement("div");
    1357. 

  1357.                 boxElem.classList.add("cookie-alert");
    1358. 

  1358.                 const containerElem = document.createElement("div");
    1359. 

  1359.                 containerElem.classList.add("cookie-alert__container");
    1360. 

  1360.                 const textElem = document.createElement("p");
    1361. 

  1361.                 textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
    1362. 

  1362.                                     Google Analytics</a> to collect statistics.`;
    1363. 

  1363.                                     containerElem.appendChild(textElem);
    1364. 

  1364. 

  1365.                 const declineBtn = Object.assign(document.createElement("button"),
    1366. 

  1366.                   {
    1367. 

  1367.                     innerText: "Deny",
    1368. 

  1368.                     className: "farama-btn cookie-alert__button",
    1369. 

  1369.                     id: "cookie-alert__decline",
    1370. 

  1370.                   }
    1371. 

  1371.                 );
    1372. 

  1372.                 declineBtn.addEventListener("click", () => {
    1373. 

  1373.                   localStorage.setItem("acceptedCookieAlert", false);
    1374. 

  1374.                   boxElem.remove();
    1375. 

  1375.                 });
    1376. 

  1376. 

  1377.                 const acceptBtn = Object.assign(document.createElement("button"),
    1378. 

  1378.                   {
    1379. 

  1379.                     innerText: "Allow",
    1380. 

  1380.                     className: "farama-btn cookie-alert__button",
    1381. 

  1381.                     id: "cookie-alert__accept",
    1382. 

  1382.                   }
    1383. 

  1383.                 );
    1384. 

  1384.                 acceptBtn.addEventListener("click", () => {
    1385. 

  1385.                   localStorage.setItem("acceptedCookieAlert", true);
    1386. 

  1386.                   boxElem.remove();
    1387. 

  1387.                   enableGtag();
    1388. 

  1388.                 });
    1389. 

  1389. 

  1390.                 containerElem.appendChild(declineBtn);
    1391. 

  1391.                 containerElem.appendChild(acceptBtn);
    1392. 

  1392.                 boxElem.appendChild(containerElem);
    1393. 

  1393.                 document.body.appendChild(boxElem);
    1394. 

  1394.             } else if (localStorage.getItem("acceptedCookieAlert") === "true") {
    1395. 

  1395.               enableGtag();
    1396. 

  1396.             }
    1397. 

  1397.         })()
    1398. 

  1398.       </script>
    1399. 

  1399. 

  1400.     <script src="../../../_static/documentation_options.js?v=7fa42598"></script>
    1401. 

  1401.     <script src="../../../_static/doctools.js?v=888ff710"></script>
    1402. 

  1402.     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    1403. 

  1403.     <script src="../../../_static/scripts/furo.js?v=7660844c"></script>
    1404. 

  1404.     
    1405. 

  1405.     <script>
    1406. 

  1406. 

  1407.       const createProjectsList = (projects, displayImages) => {
    1408. 

  1408.         const ulElem = Object.assign(document.createElement('ul'),
    1409. 

  1409.           {
    1410. 

  1410.             className:'farama-header-menu-list',
    1411. 

  1411.           }
    1412. 

  1412.         )
    1413. 

  1413.         for (let project of projects) {
    1414. 

  1414.           const liElem = document.createElement("li");
    1415. 

  1415.           const aElem = Object.assign(document.createElement("a"),
    1416. 

  1416.             {
    1417. 

  1417.               href: project.link
    1418. 

  1418.             }
    1419. 

  1419.           );
    1420. 

  1420.           liElem.appendChild(aElem);
    1421. 

  1421.           if (displayImages) {
    1422. 

  1422.             const imgElem = Object.assign(document.createElement("img"),
    1423. 

  1423.               {
    1424. 

  1424.                 src: project.image ? imagesBasepath + project.image : imagesBasepath + "/farama_black.svg",
    1425. 

  1425.                 alt: `${project.name} logo`,
    1426. 

  1426.                 className: "farama-black-logo-invert"
    1427. 

  1427.               }
    1428. 

  1428.             );
    1429. 

  1429.             aElem.appendChild(imgElem);
    1430. 

  1430.           }
    1431. 

  1431.           aElem.appendChild(document.createTextNode(project.name));
    1432. 

  1432.           ulElem.appendChild(liElem);
    1433. 

  1433.         }
    1434. 

  1434.         return ulElem;
    1435. 

  1435.       }
    1436. 

  1436. 

  1437.       // Create menu with Farama projects by using the API at farama.org/api/projects.json
    1438. 

  1438.       const createCORSRequest = (method, url) => {
    1439. 

  1439.         let xhr = new XMLHttpRequest();
    1440. 

  1440.         xhr.responseType = 'json';
    1441. 

  1441. 

  1442.         if ("withCredentials" in xhr) {
    1443. 

  1443.           xhr.open(method, url, true);
    1444. 

  1444.         } else if (typeof XDomainRequest != "undefined") {
    1445. 

  1445.           // IE8 & IE9
    1446. 

  1446.           xhr = new XDomainRequest();
    1447. 

  1447.           xhr.open(method, url);
    1448. 

  1448.         } else {
    1449. 

  1449.           // CORS not supported.
    1450. 

  1450.           xhr = null;
    1451. 

  1451.         }
    1452. 

  1452.         return xhr;
    1453. 

  1453.       };
    1454. 

  1454. 

  1455.       const url = 'https://farama.org/api/projects.json';
    1456. 

  1456.       const imagesBasepath = "https://farama.org/assets/images"
    1457. 

  1457.       const method = 'GET';
    1458. 

  1458.       let xhr = createCORSRequest(method, url);
    1459. 

  1459. 

  1460.       xhr.onload = () => {
    1461. 

  1461.         const jsonResponse = xhr.response;
    1462. 

  1462.         const sections = {
    1463. 

  1463.           "Core Projects": [],
    1464. 

  1464.           "Mature Projects": {
    1465. 

  1465.             "Documentation": [],
    1466. 

  1466.             "Repositories": [],
    1467. 

  1467.           },
    1468. 

  1468.           "Incubating Projects": {
    1469. 

  1469.             "Documentation": [],
    1470. 

  1470.             "Repositories": [],
    1471. 

  1471.           },
    1472. 

  1472.           "Foundation": [
    1473. 

  1473.             {
    1474. 

  1474.               name: "About",
    1475. 

  1475.               link: "https://farama.org/about"
    1476. 

  1476.             },
    1477. 

  1477.             {
    1478. 

  1478.               name: "Standards",
    1479. 

  1479.               link: "https://farama.org/project_standards",
    1480. 

  1480.             },
    1481. 

  1481.             {
    1482. 

  1482.               name: "Donate",
    1483. 

  1483.               link: "https://farama.org/donations"
    1484. 

  1484.             }
    1485. 

  1485.           ]
    1486. 

  1486.         }
    1487. 

  1487. 

  1488.         // Categorize projects
    1489. 

  1489.         Object.keys(jsonResponse).forEach(key => {
    1490. 

  1490.           projectJson = jsonResponse[key];
    1491. 

  1491.           if (projectJson.website !== null) {
    1492. 

  1492.             projectJson.link = projectJson.website;
    1493. 

  1493.           } else {
    1494. 

  1494.             projectJson.link = projectJson.github;
    1495. 

  1495.           }
    1496. 

  1496.           if (projectJson.type === "core") {
    1497. 

  1497.             sections["Core Projects"].push(projectJson)
    1498. 

  1498.           } else if (projectJson.type == "mature") {
    1499. 

  1499.             if (projectJson.website !== null) {
    1500. 

  1500.               sections["Mature Projects"]["Documentation"].push(projectJson)
    1501. 

  1501.             } else {
    1502. 

  1502.               sections["Mature Projects"]["Repositories"].push(projectJson)
    1503. 

  1503.             }
    1504. 

  1504.           } else {
    1505. 

  1505.             if (projectJson.website !== null) {
    1506. 

  1506.               sections["Incubating Projects"]["Documentation"].push(projectJson)
    1507. 

  1507.             } else {
    1508. 

  1508.               sections["Incubating Projects"]["Repositories"].push(projectJson)
    1509. 

  1509.             }
    1510. 

  1510.           }
    1511. 

  1511.         })
    1512. 

  1512. 

  1513.         const menuContainer = document.querySelector(".farama-header-menu__body");
    1514. 

  1514. 

  1515.         Object.keys(sections).forEach((key, i) => {
    1516. 

  1516.           const sectionElem = Object.assign(
    1517. 

  1517.             document.createElement('div'), {
    1518. 

  1518.               className:'farama-header-menu__section',
    1519. 

  1519.             }
    1520. 

  1520.           )
    1521. 

  1521.           sectionElem.appendChild(Object.assign(document.createElement('span'),
    1522. 

  1522.             {
    1523. 

  1523.               className:'farama-header-menu__section-title' ,
    1524. 

  1524.               innerText: key
    1525. 

  1525.             }
    1526. 

  1526.           ))
    1527. 

  1527.           // is not a list
    1528. 

  1528.           if (sections[key].constructor !== Array) {
    1529. 

  1529.             const subSections = sections[key];
    1530. 

  1530.             const subSectionContainerElem = Object.assign(
    1531. 

  1531.                 document.createElement('div'), {
    1532. 

  1532.                   className:'farama-header-menu__subsections-container',
    1533. 

  1533.                   style: 'display: flex'
    1534. 

  1534.                 }
    1535. 

  1535.             )
    1536. 

  1536.             Object.keys(subSections).forEach((subKey, i) => {
    1537. 

  1537.               const subSectionElem = Object.assign(
    1538. 

  1538.                 document.createElement('div'), {
    1539. 

  1539.                   className:'farama-header-menu__subsection',
    1540. 

  1540.                 }
    1541. 

  1541.               )
    1542. 

  1542.               subSectionElem.appendChild(Object.assign(document.createElement('span'),
    1543. 

  1543.                 {
    1544. 

  1544.                   className:'farama-header-menu__subsection-title' ,
    1545. 

  1545.                   innerText: subKey
    1546. 

  1546.                 }
    1547. 

  1547.               ))
    1548. 

  1548.               const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
    1549. 

  1549.               subSectionElem.appendChild(ulElem);
    1550. 

  1550.               subSectionContainerElem.appendChild(subSectionElem);
    1551. 

  1551.             })
    1552. 

  1552.             sectionElem.appendChild(subSectionContainerElem);
    1553. 

  1553.           } else {
    1554. 

  1554.             const projects = sections[key];
    1555. 

  1555.             const ulElem = createProjectsList(projects, true);
    1556. 

  1556.             sectionElem.appendChild(ulElem);
    1557. 

  1557.           }
    1558. 

  1558.           menuContainer.appendChild(sectionElem)
    1559. 

  1559.         });
    1560. 

  1560.       }
    1561. 

  1561. 

  1562.       xhr.onerror = function() {
    1563. 

  1563.         console.error("Unable to load projects");
    1564. 

  1564.       };
    1565. 

  1565. 

  1566.       xhr.send();
    1567. 

  1567.     </script>
    1568. 

  1568. 

  1569.     
    1570. 

  1570.     <script>
    1571. 

  1571.       const versioningConfig = {
    1572. 

  1572.         githubUser: 'Farama-Foundation',
    1573. 

  1573.         githubRepo: 'Minigrid',
    1574. 

  1574.       };
    1575. 

  1575.       fetch('/main/_static/versioning/versioning_menu.html').then(response => {
    1576. 

  1576.         if (response.status === 200) {
    1577. 

  1577.             response.text().then(text => {
    1578. 

  1578.                 const container = document.createElement("div");
    1579. 

  1579.                 container.innerHTML = text;
    1580. 

  1580.                 document.querySelector("body").appendChild(container);
    1581. 

  1581.                 // innerHtml doenst evaluate scripts, we need to add them dynamically
    1582. 

  1582.                 Array.from(container.querySelectorAll("script")).forEach(oldScript => {
    1583. 

  1583.                     const newScript = document.createElement("script");
    1584. 

  1584.                     Array.from(oldScript.attributes).forEach(attr => newScript.setAttribute(attr.name, attr.value));
    1585. 

  1585.                     newScript.appendChild(document.createTextNode(oldScript.innerHTML));
    1586. 

  1586.                     oldScript.parentNode.replaceChild(newScript, oldScript);
    1587. 

  1587.                 });
    1588. 

  1588.             });
    1589. 

  1589.         } else {
    1590. 

  1590.             console.warn("Unable to load versioning menu", response);
    1591. 

  1591.         }
    1592. 

  1592.       });
    1593. 

  1593.     </script>
    1594. 

  1594. 

  1595.     </body>
    1596. 

  1596. </html>
    1597.