Deploying to gh-pages from @ e8d51e0 🚀

instadeepai · Sep 8, 2023 · 9e6800c · 9e6800c
1 parent 528415f
commit 9e6800c
Show file tree

Hide file tree

Showing 48 changed files with 132 additions and 92 deletions.
diff --git a/api/env/index.html b/api/env/index.html
@@ -1981,7 +1981,7 @@ <h3 id="jumanji.env.Environment.__exit__" class="doc doc-heading">
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

diff --git a/api/wrappers/index.html b/api/wrappers/index.html
@@ -1783,6 +1783,46 @@ <h4 id="jumanji.wrappers.Wrapper.action_spec" class="doc doc-heading">
 
 
 
+<h4 id="jumanji.wrappers.Wrapper.reward_spec" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">reward_spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Array</span></code>
+
+
+<a href="#jumanji.wrappers.Wrapper.reward_spec" class="headerlink" title="Permanent link">#</a></h4>
+
+    <div class="doc doc-contents ">
+
+      <p>Returns the reward spec.</p>
+
+    </div>
+
+  </div>
+
+
+
+  <div class="doc doc-object doc-method">
+
+
+
+<h4 id="jumanji.wrappers.Wrapper.discount_spec" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">discount_spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BoundedArray</span></code>
+
+
+<a href="#jumanji.wrappers.Wrapper.discount_spec" class="headerlink" title="Permanent link">#</a></h4>
+
+    <div class="doc doc-contents ">
+
+      <p>Returns the discount spec.</p>
+
+    </div>
+
+  </div>
+
+
+
+  <div class="doc doc-object doc-method">
+
+
+
 <h4 id="jumanji.wrappers.Wrapper.render" class="doc doc-heading">
 <code class="highlight language-python"><span class="n">render</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">:</span> <span class="o">~</span><span class="n">State</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span></code>
 
@@ -2199,7 +2239,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">0x7f59af6ef700</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">0x7f59af6efee0</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">0x7f78e2dd9700</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">0x7f78e2dd9ee0</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>
@@ -2233,14 +2273,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 0x7f59af6ef700&gt;</code></td>
+        <td><code>&lt;function sum at 0x7f78e2dd9700&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 0x7f59af6efee0&gt;</code></td>
+        <td><code>&lt;function amax at 0x7f78e2dd9ee0&gt;</code></td>
       </tr>
   </tbody>
 </table>
@@ -3049,7 +3089,7 @@ <h3 id="jumanji.wrappers.jumanji_to_gym_obs" class="doc doc-heading">
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

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

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

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

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

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

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

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

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

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

diff --git a/environments/minesweeper/index.html b/environments/minesweeper/index.html
@@ -1542,7 +1542,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

diff --git a/environments/mmst/index.html b/environments/mmst/index.html
@@ -1573,7 +1573,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

diff --git a/environments/multi_cvrp/index.html b/environments/multi_cvrp/index.html
@@ -1541,7 +1541,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

diff --git a/environments/robot_warehouse/index.html b/environments/robot_warehouse/index.html
@@ -1541,7 +1541,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

diff --git a/environments/rubiks_cube/index.html b/environments/rubiks_cube/index.html
@@ -1574,7 +1574,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>

diff --git a/environments/snake/index.html b/environments/snake/index.html
@@ -1528,7 +1528,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2023-09-07
+      2023-09-08
 
   </small>
 </div>