Deploying to gh-pages from @ ce8b873 🚀

instadeepai · Mar 8, 2024 · 1c89e7d · 1c89e7d
1 parent 6c47111
commit 1c89e7d
Show file tree

Hide file tree

Showing 52 changed files with 156 additions and 100 deletions.
diff --git a/api/env/index.html b/api/env/index.html
@@ -2045,7 +2045,7 @@ <h3 id="jumanji.env.Environment.__exit__" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/bin_pack/index.html b/api/environments/bin_pack/index.html
@@ -2098,7 +2098,7 @@ <h3 id="jumanji.environments.packing.bin_pack.env.BinPack.close" class="doc doc-
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/cleaner/index.html b/api/environments/cleaner/index.html
@@ -2131,7 +2131,7 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.close" class="doc doc-h
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/connector/index.html b/api/environments/connector/index.html
@@ -1922,7 +1922,7 @@ <h3 id="jumanji.environments.routing.connector.env.Connector.action_spec" class=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/cvrp/index.html b/api/environments/cvrp/index.html
@@ -1952,7 +1952,7 @@ <h3 id="jumanji.environments.routing.cvrp.env.CVRP.action_spec" class="doc doc-h
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/game_2048/index.html b/api/environments/game_2048/index.html
@@ -1916,7 +1916,7 @@ <h3 id="jumanji.environments.logic.game_2048.env.Game2048.step" class="doc doc-h
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/graph_coloring/index.html b/api/environments/graph_coloring/index.html
@@ -1913,7 +1913,7 @@ <h3 id="jumanji.environments.logic.graph_coloring.env.GraphColoring.action_spec"
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/job_shop/index.html b/api/environments/job_shop/index.html
@@ -1943,7 +1943,7 @@ <h3 id="jumanji.environments.packing.job_shop.env.JobShop.action_spec" class="do
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/knapsack/index.html b/api/environments/knapsack/index.html
@@ -1936,7 +1936,7 @@ <h3 id="jumanji.environments.packing.knapsack.env.Knapsack.action_spec" class="d
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/macvrp/index.html b/api/environments/macvrp/index.html
@@ -1812,7 +1812,7 @@ <h3 id="jumanji.environments.routing.multi_cvrp.env.MultiCVRP.action_spec" class
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/maze/index.html b/api/environments/maze/index.html
@@ -1934,7 +1934,7 @@ <h3 id="jumanji.environments.routing.maze.env.Maze.step" class="doc doc-heading"
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/minesweeper/index.html b/api/environments/minesweeper/index.html
@@ -1947,7 +1947,7 @@ <h3 id="jumanji.environments.logic.minesweeper.env.Minesweeper.action_spec" clas
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/mmst/index.html b/api/environments/mmst/index.html
@@ -2030,7 +2030,7 @@ <h3 id="jumanji.environments.routing.mmst.env.MMST.render" class="doc doc-headin
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/pac_man/index.html b/api/environments/pac_man/index.html
@@ -2008,7 +2008,7 @@ <h3 id="jumanji.environments.routing.pac_man.env.PacMan.render" class="doc doc-h
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/rubiks_cube/index.html b/api/environments/rubiks_cube/index.html
@@ -1928,7 +1928,7 @@ <h3 id="jumanji.environments.logic.rubiks_cube.env.RubiksCube.action_spec" class
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/rware/index.html b/api/environments/rware/index.html
@@ -1872,7 +1872,7 @@ <h3 id="jumanji.environments.routing.robot_warehouse.env.RobotWarehouse.action_s
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/snake/index.html b/api/environments/snake/index.html
@@ -1950,7 +1950,7 @@ <h3 id="jumanji.environments.routing.snake.env.Snake.action_spec" class="doc doc
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/sokoban/index.html b/api/environments/sokoban/index.html
@@ -2006,7 +2006,7 @@ <h3 id="jumanji.environments.routing.sokoban.env.Sokoban.render" class="doc doc-
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/sudoku/index.html b/api/environments/sudoku/index.html
@@ -1884,7 +1884,7 @@ <h3 id="jumanji.environments.logic.sudoku.env.Sudoku.action_spec" class="doc doc
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/tetris/index.html b/api/environments/tetris/index.html
@@ -1924,7 +1924,7 @@ <h3 id="jumanji.environments.packing.tetris.env.Tetris.action_spec" class="doc d
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/environments/tsp/index.html b/api/environments/tsp/index.html
@@ -1942,7 +1942,7 @@ <h3 id="jumanji.environments.routing.tsp.env.TSP.action_spec" class="doc doc-hea
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/types/index.html b/api/types/index.html
@@ -2517,7 +2517,7 @@ <h3 id="jumanji.types.get_valid_dtype" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/api/wrappers/index.html b/api/wrappers/index.html
@@ -2303,7 +2303,7 @@ <h3 id="jumanji.wrappers.MultiToSingleWrapper" class="doc doc-heading">
 
 
 <h4 id="jumanji.wrappers.MultiToSingleWrapper.__init__" class="doc doc-heading">
-<code class="highlight language-python"><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">Environment</span><span class="p">,</span> <span class="n">reward_aggregator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="o">&lt;</span><span class="n">function</span> <span class="nb">sum</span> <span class="n">at</span> <span class="mh">0x7fd62457a790</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">discount_aggregator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="o">&lt;</span><span class="n">function</span> <span class="n">amax</span> <span class="n">at</span> <span class="mh">0x7fd62457af70</span><span class="o">&gt;</span><span class="p">)</span></code>
+<code class="highlight language-python"><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">Environment</span><span class="p">,</span> <span class="n">reward_aggregator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="o">&lt;</span><span class="n">function</span> <span class="nb">sum</span> <span class="n">at</span> <span class="mh">0x7f2d8d729790</span><span class="o">&gt;</span><span class="p">,</span> <span class="n">discount_aggregator</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="o">&lt;</span><span class="n">function</span> <span class="n">amax</span> <span class="n">at</span> <span class="mh">0x7f2d8d729f70</span><span class="o">&gt;</span><span class="p">)</span></code>
 
   <span class="doc doc-properties">
       <small class="doc doc-property doc-property-special"><code>special</code></small>
@@ -2337,14 +2337,14 @@ <h4 id="jumanji.wrappers.MultiToSingleWrapper.__init__" class="doc doc-heading">
         <td><code>Callable</code></td>
         <td><p>a function to aggregate all agents rewards into a single scalar
 value, e.g. sum.</p></td>
-        <td><code>&lt;function sum at 0x7fd62457a790&gt;</code></td>
+        <td><code>&lt;function sum at 0x7f2d8d729790&gt;</code></td>
       </tr>
       <tr>
         <td><code>discount_aggregator</code></td>
         <td><code>Callable</code></td>
         <td><p>a function to aggregate all agents discounts into a single
 scalar value, e.g. max.</p></td>
-        <td><code>&lt;function amax at 0x7fd62457af70&gt;</code></td>
+        <td><code>&lt;function amax at 0x7f2d8d729f70&gt;</code></td>
       </tr>
   </tbody>
 </table>
@@ -2712,6 +2712,7 @@ <h3 id="jumanji.wrappers.AutoResetWrapper" class="doc doc-heading">
 the state, observation, and step_type are reset. The observation and step_type of the
 terminal TimeStep is reset to the reset observation and StepType.LAST, respectively.
 The reward, discount, and extras retrieved from the transition to the terminal state.
+NOTE: The observation from the terminal TimeStep is stored in timestep.extras["next_obs"].
 WARNING: do not <code>jax.vmap</code> the wrapped environment (e.g. do not use with the <code>VmapWrapper</code>),
 which would lead to inefficient computation due to both the <code>step</code> and <code>reset</code> functions
 being processed each time <code>step</code> is called. Please use the <code>VmapAutoResetWrapper</code> instead.</p>
@@ -2729,6 +2730,61 @@ <h3 id="jumanji.wrappers.AutoResetWrapper" class="doc doc-heading">
 
 
 
+  <div class="doc doc-object doc-method">
+
+
+
+<h4 id="jumanji.wrappers.AutoResetWrapper.reset" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="n">chex</span><span class="o">.</span><span class="n">PRNGKey</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">State</span><span class="p">,</span> <span class="n">TimeStep</span><span class="p">[</span><span class="n">Observation</span><span class="p">]]</span></code>
+
+
+<a href="#jumanji.wrappers.AutoResetWrapper.reset" class="headerlink" title="Permanent link">#</a></h4>
+
+    <div class="doc doc-contents ">
+
+      <p>Resets the environment to an initial state.</p>
+
+<p><strong>Parameters:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Description</th>
+      <th>Default</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+        <td><code>key</code></td>
+        <td><code>chex.PRNGKey</code></td>
+        <td><p>random key used to reset the environment.</p></td>
+        <td><em>required</em></td>
+      </tr>
+  </tbody>
+</table>
+<p><strong>Returns:</strong></p>
+<table>
+  <thead>
+    <tr>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>state</code></td>
+      <td><p>State object corresponding to the new state of the environment,
+timestep: TimeStep object corresponding the first timestep returned by the environment,</p></td>
+    </tr>
+  </tbody>
+</table>
+    </div>
+
+  </div>
+
+
+
   <div class="doc doc-object doc-method">
 
 
@@ -3153,7 +3209,7 @@ <h3 id="jumanji.wrappers.jumanji_to_gym_obs" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/bin_pack/index.html b/environments/bin_pack/index.html
@@ -1621,7 +1621,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/cleaner/index.html b/environments/cleaner/index.html
@@ -1614,7 +1614,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/connector/index.html b/environments/connector/index.html
@@ -1653,7 +1653,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/cvrp/index.html b/environments/cvrp/index.html
@@ -1632,7 +1632,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/game_2048/index.html b/environments/game_2048/index.html
@@ -1628,7 +1628,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/graph_coloring/index.html b/environments/graph_coloring/index.html
@@ -1631,7 +1631,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/job_shop/index.html b/environments/job_shop/index.html
@@ -1691,7 +1691,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/knapsack/index.html b/environments/knapsack/index.html
@@ -1619,7 +1619,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/maze/index.html b/environments/maze/index.html
@@ -1624,7 +1624,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>

diff --git a/environments/minesweeper/index.html b/environments/minesweeper/index.html
@@ -1606,7 +1606,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-03-05
+      2024-03-08
 
   </small>
 </div>
-Original file line number
+Diff line change
@@ Expand Up @@
       <small>
           Last update:
--03-05
+-03-08
       </small>
     </div>
@@ Expand Down @@