Deploying to gh-pages from @ 17353bf 🚀

instadeepai · Oct 28, 2024 · 2a88572 · 2a88572
1 parent e49ac2d
commit 2a88572
Show file tree

Hide file tree

Showing 55 changed files with 120 additions and 122 deletions.
diff --git a/api/env/index.html b/api/env/index.html
@@ -2123,7 +2123,7 @@ <h3 id="jumanji.env.Environment.__exit__" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/bin_pack/index.html b/api/environments/bin_pack/index.html
@@ -1727,20 +1727,18 @@ <h2 id="jumanji.environments.packing.bin_pack.env.BinPack" class="doc doc-headin
 <li>
 <p>state: <code>State</code></p>
 <ul>
-<li>coordinates: jax array (float) of shape (num_nodes + 1, 2)
-    the coordinates of each node and the depot.</li>
-<li>demands: jax array (int32) of shape (num_nodes + 1,)
-    the associated cost of each node and the depot (0.0 for the depot).</li>
-<li>position: jax array (int32)
-    the index of the last visited node.</li>
-<li>capacity: jax array (int32)
-    the current capacity of the vehicle.</li>
-<li>visited_mask: jax array (bool) of shape (num_nodes + 1,)
-    binary mask (False/True &lt;--&gt; not visited/visited).</li>
-<li>trajectory: jax array (int32) of shape (2 * num_nodes,)
-    identifiers of the nodes that have been visited (set to DEPOT_IDX if not filled yet).</li>
-<li>num_visits: int32
-    number of actions that have been taken (i.e., unique visits).</li>
+<li>container: space defined by 2 points, i.e. 6 coordinates.</li>
+<li>ems: empty maximal spaces (EMSs) in the container, each defined by 2 points
+    (6 coordinates).</li>
+<li>ems_mask: array of booleans that indicate the EMSs that are valid.</li>
+<li>items: defined by 3 attributes (x, y, z).</li>
+<li>items_mask: array of booleans that indicate the items that can be packed.</li>
+<li>items_placed: array of booleans that indicate the items that have been placed so far.</li>
+<li>items_location: locations of items in the container, defined by 3 coordinates (x, y, x).</li>
+<li>action_mask: array of booleans that indicate the valid actions,
+    i.e. EMSs and items that can be chosen.</li>
+<li>sorted_ems_indexes: EMS indexes that are sorted by decreasing volume order.</li>
+<li>key: random key used for auto-reset.</li>
 </ul>
 </li>
 </ul>
@@ -2170,7 +2168,7 @@ <h3 id="jumanji.environments.packing.bin_pack.env.BinPack.close" class="doc doc-
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/cleaner/index.html b/api/environments/cleaner/index.html
@@ -2065,7 +2065,7 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.render" class="doc doc-
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/connector/index.html b/api/environments/connector/index.html
@@ -2065,7 +2065,7 @@ <h3 id="jumanji.environments.routing.connector.env.Connector.render" class="doc
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/cvrp/index.html b/api/environments/cvrp/index.html
@@ -2024,7 +2024,7 @@ <h3 id="jumanji.environments.routing.cvrp.env.CVRP.step" class="doc doc-heading"
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/flat_pack/index.html b/api/environments/flat_pack/index.html
@@ -2017,7 +2017,7 @@ <h3 id="jumanji.environments.packing.flat_pack.env.FlatPack.step" class="doc doc
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

diff --git a/api/environments/graph_coloring/index.html b/api/environments/graph_coloring/index.html
@@ -1985,7 +1985,7 @@ <h3 id="jumanji.environments.logic.graph_coloring.env.GraphColoring.step" class=
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/job_shop/index.html b/api/environments/job_shop/index.html
@@ -2015,7 +2015,7 @@ <h3 id="jumanji.environments.packing.job_shop.env.JobShop.step" class="doc doc-h
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/knapsack/index.html b/api/environments/knapsack/index.html
@@ -2008,7 +2008,7 @@ <h3 id="jumanji.environments.packing.knapsack.env.Knapsack.step" class="doc doc-
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/macvrp/index.html b/api/environments/macvrp/index.html
@@ -1884,7 +1884,7 @@ <h3 id="jumanji.environments.routing.multi_cvrp.env.MultiCVRP.step" class="doc d
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

diff --git a/api/environments/minesweeper/index.html b/api/environments/minesweeper/index.html
@@ -2019,7 +2019,7 @@ <h3 id="jumanji.environments.logic.minesweeper.env.Minesweeper.step" class="doc
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

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

diff --git a/api/environments/rubiks_cube/index.html b/api/environments/rubiks_cube/index.html
@@ -2000,7 +2000,7 @@ <h3 id="jumanji.environments.logic.rubiks_cube.env.RubiksCube.step" class="doc d
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/rware/index.html b/api/environments/rware/index.html
@@ -1944,7 +1944,7 @@ <h3 id="jumanji.environments.routing.robot_warehouse.env.RobotWarehouse.step" cl
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/sliding_tile_puzzle/index.html b/api/environments/sliding_tile_puzzle/index.html
@@ -1872,7 +1872,7 @@ <h3 id="jumanji.environments.logic.sliding_tile_puzzle.env.SlidingTilePuzzle.ste
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/snake/index.html b/api/environments/snake/index.html
@@ -2022,7 +2022,7 @@ <h3 id="jumanji.environments.routing.snake.env.Snake.step" class="doc doc-headin
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

diff --git a/api/environments/sudoku/index.html b/api/environments/sudoku/index.html
@@ -1956,7 +1956,7 @@ <h3 id="jumanji.environments.logic.sudoku.env.Sudoku.step" class="doc doc-headin
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/tetris/index.html b/api/environments/tetris/index.html
@@ -1996,7 +1996,7 @@ <h3 id="jumanji.environments.packing.tetris.env.Tetris.step" class="doc doc-head
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

diff --git a/api/environments/tsp/index.html b/api/environments/tsp/index.html
@@ -2014,7 +2014,7 @@ <h3 id="jumanji.environments.routing.tsp.env.TSP.step" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

diff --git a/api/wrappers/index.html b/api/wrappers/index.html
@@ -2383,7 +2383,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">State</span><span class="p">,</span> <span class="n">ActionSpec</span><span class="p">,</span> <span class="n">Observation</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">0x7f1369104790</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">0x7f1369104f70</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">State</span><span class="p">,</span> <span class="n">ActionSpec</span><span class="p">,</span> <span class="n">Observation</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">0x7f8bb9049790</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">0x7f8bb9049f70</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>
@@ -2417,14 +2417,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 0x7f1369104790&gt;</code></td>
+        <td><code>&lt;function sum at 0x7f8bb9049790&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 0x7f1369104f70&gt;</code></td>
+        <td><code>&lt;function amax at 0x7f8bb9049f70&gt;</code></td>
       </tr>
   </tbody>
 </table>
@@ -3338,7 +3338,7 @@ <h3 id="jumanji.wrappers.jumanji_to_gym_obs" class="doc doc-heading">
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

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

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

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

diff --git a/environments/flat_pack/index.html b/environments/flat_pack/index.html
@@ -1687,7 +1687,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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

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

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

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

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

diff --git a/environments/minesweeper/index.html b/environments/minesweeper/index.html
@@ -1670,7 +1670,7 @@ <h2 id="registered-versions">Registered Versions 📖<a class="headerlink" href=
   <small>
 
       Last update:
-      2024-10-25
+      2024-10-28
 
   </small>
 </div>

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