Deploying to gh-pages from @ 33cc748 🚀

instadeepai · Oct 25, 2024 · e49ac2d · e49ac2d
1 parent e298b2f
commit e49ac2d
Show file tree

Hide file tree

Showing 56 changed files with 189 additions and 256 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-05-11
+      2024-10-25
 
   </small>
 </div>

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

diff --git a/api/environments/cleaner/index.html b/api/environments/cleaner/index.html
@@ -1401,13 +1401,6 @@
     __init__()
   </a>
 
-</li>
-
-          <li class="md-nav__item">
-  <a href="#jumanji.environments.routing.cleaner.env.Cleaner.__repr__" class="md-nav__link">
-    __repr__()
-  </a>
-
 </li>
 
           <li class="md-nav__item">
@@ -1429,20 +1422,6 @@
     render()
   </a>
 
-</li>
-
-          <li class="md-nav__item">
-  <a href="#jumanji.environments.routing.cleaner.env.Cleaner.animate" class="md-nav__link">
-    animate()
-  </a>
-
-</li>
-
-          <li class="md-nav__item">
-  <a href="#jumanji.environments.routing.cleaner.env.Cleaner.close" class="md-nav__link">
-    close()
-  </a>
-
 </li>
 
       </ul>
@@ -1877,18 +1856,6 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.__init__" class="doc do
     </tr>
   </thead>
   <tbody>
-      <tr>
-        <td><code>num_agents</code></td>
-        <td></td>
-        <td><p>number of agents. Defaults to 3.</p></td>
-        <td><em>required</em></td>
-      </tr>
-      <tr>
-        <td><code>time_limit</code></td>
-        <td><code>Optional[int]</code></td>
-        <td><p>max number of steps in an episode. Defaults to <code>num_rows * num_cols</code>.</p></td>
-        <td><code>None</code></td>
-      </tr>
       <tr>
         <td><code>generator</code></td>
         <td><code>Optional[jumanji.environments.routing.cleaner.generator.Generator]</code></td>
@@ -1898,10 +1865,9 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.__init__" class="doc do
         <td><code>None</code></td>
       </tr>
       <tr>
-        <td><code>viewer</code></td>
-        <td><code>Optional[jumanji.viewer.Viewer[jumanji.environments.routing.cleaner.types.State]]</code></td>
-        <td><p><code>Viewer</code> used for rendering. Defaults to <code>CleanerViewer</code> with "human" render
-mode.</p></td>
+        <td><code>time_limit</code></td>
+        <td><code>Optional[int]</code></td>
+        <td><p>max number of steps in an episode. Defaults to <code>num_rows * num_cols</code>.</p></td>
         <td><code>None</code></td>
       </tr>
       <tr>
@@ -1910,6 +1876,13 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.__init__" class="doc do
         <td><p>the penalty returned at each timestep in the reward.</p></td>
         <td><code>0.5</code></td>
       </tr>
+      <tr>
+        <td><code>viewer</code></td>
+        <td><code>Optional[jumanji.viewer.Viewer[jumanji.environments.routing.cleaner.types.State]]</code></td>
+        <td><p><code>Viewer</code> used for rendering. Defaults to <code>CleanerViewer</code> with "human" render
+mode.</p></td>
+        <td><code>None</code></td>
+      </tr>
   </tbody>
 </table>
     </div>
@@ -1922,28 +1895,6 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.__init__" class="doc do
 
 
 
-<h3 id="jumanji.environments.routing.cleaner.env.Cleaner.__repr__" class="doc doc-heading">
-<code class="highlight language-python"><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span></code>
-
-  <span class="doc doc-properties">
-      <small class="doc doc-property doc-property-special"><code>special</code></small>
-  </span>
-
-<a href="#jumanji.environments.routing.cleaner.env.Cleaner.__repr__" class="headerlink" title="Permanent link">#</a></h3>
-
-    <div class="doc doc-contents ">
-
-
-    </div>
-
-  </div>
-
-
-
-  <div class="doc doc-object doc-method">
-
-
-
 <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.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">PRNGKeyArray</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">cleaner</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">State</span><span class="p">,</span> <span class="n">jumanji</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">TimeStep</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">cleaner</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Observation</span><span class="p">]]</span></code>
 
@@ -2101,95 +2052,6 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.render" class="doc doc-
 
 
 
-  <div class="doc doc-object doc-method">
-
-
-
-<h3 id="jumanji.environments.routing.cleaner.env.Cleaner.animate" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">animate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">states</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">cleaner</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">State</span><span class="p">],</span> <span class="n">interval</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">200</span><span class="p">,</span> <span class="n">save_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FuncAnimation</span></code>
-
-
-<a href="#jumanji.environments.routing.cleaner.env.Cleaner.animate" class="headerlink" title="Permanent link">#</a></h3>
-
-    <div class="doc doc-contents ">
-
-      <p>Creates an animated gif of the <code>Cleaner</code> environment based on the sequence of states.</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>states</code></td>
-        <td><code>Sequence[jumanji.environments.routing.cleaner.types.State]</code></td>
-        <td><p>sequence of environment states corresponding to consecutive timesteps.</p></td>
-        <td><em>required</em></td>
-      </tr>
-      <tr>
-        <td><code>interval</code></td>
-        <td><code>int</code></td>
-        <td><p>delay between frames in milliseconds, default to 200.</p></td>
-        <td><code>200</code></td>
-      </tr>
-      <tr>
-        <td><code>save_path</code></td>
-        <td><code>Optional[str]</code></td>
-        <td><p>the path where the animation file should be saved. If it is None, the plot
-will not be saved.</p></td>
-        <td><code>None</code></td>
-      </tr>
-  </tbody>
-</table>
-<p><strong>Returns:</strong></p>
-<table>
-  <thead>
-    <tr>
-      <th>Type</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><code>animation.FuncAnimation</code></td>
-      <td><p>the animation object that was created.</p></td>
-    </tr>
-  </tbody>
-</table>
-    </div>
-
-  </div>
-
-
-
-  <div class="doc doc-object doc-method">
-
-
-
-<h3 id="jumanji.environments.routing.cleaner.env.Cleaner.close" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">close</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
-
-
-<a href="#jumanji.environments.routing.cleaner.env.Cleaner.close" class="headerlink" title="Permanent link">#</a></h3>
-
-    <div class="doc doc-contents ">
-
-      <p>Perform any necessary cleanup.</p>
-<p>Environments will automatically :meth:<code>close()</code> themselves when
-garbage collected or when the program exits.</p>
-
-    </div>
-
-  </div>
-
-
-
 
 
   </div>
@@ -2203,7 +2065,7 @@ <h3 id="jumanji.environments.routing.cleaner.env.Cleaner.close" class="doc doc-h
   <small>
 
       Last update:
-      2024-05-11
+      2024-10-25
 
   </small>
 </div>

diff --git a/api/environments/connector/index.html b/api/environments/connector/index.html
@@ -1408,6 +1408,13 @@
     action_spec
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#jumanji.environments.routing.connector.env.Connector.__init__" class="md-nav__link">
+    __init__()
+  </a>
+
 </li>
 
           <li class="md-nav__item">
@@ -1821,6 +1828,70 @@ <h3 id="jumanji.environments.routing.connector.env.Connector.action_spec" class=
 
 
 
+  <div class="doc doc-object doc-method">
+
+
+
+<h3 id="jumanji.environments.routing.connector.env.Connector.__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">generator</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">connector</span><span class="o">.</span><span class="n">generator</span><span class="o">.</span><span class="n">Generator</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">reward_fn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">connector</span><span class="o">.</span><span class="n">reward</span><span class="o">.</span><span class="n">RewardFn</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">time_limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">50</span><span class="p">,</span> <span class="n">viewer</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">viewer</span><span class="o">.</span><span class="n">Viewer</span><span class="p">[</span><span class="n">jumanji</span><span class="o">.</span><span class="n">environments</span><span class="o">.</span><span class="n">routing</span><span class="o">.</span><span class="n">connector</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">State</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span></code>
+
+  <span class="doc doc-properties">
+      <small class="doc doc-property doc-property-special"><code>special</code></small>
+  </span>
+
+<a href="#jumanji.environments.routing.connector.env.Connector.__init__" class="headerlink" title="Permanent link">#</a></h3>
+
+    <div class="doc doc-contents ">
+
+      <p>Create the <code>Connector</code> environment.</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>generator</code></td>
+        <td><code>Optional[jumanji.environments.routing.connector.generator.Generator]</code></td>
+        <td><p><code>Generator</code> whose <code>__call__</code> instantiates an environment instance.
+Implemented options are [<code>UniformRandomGenerator</code>, <code>RandomWalkGenerator</code>].
+Defaults to <code>RandomWalkGenerator</code> with <code>grid_size=10</code> and <code>num_agents=10</code>.</p></td>
+        <td><code>None</code></td>
+      </tr>
+      <tr>
+        <td><code>reward_fn</code></td>
+        <td><code>Optional[jumanji.environments.routing.connector.reward.RewardFn]</code></td>
+        <td><p>class of type <code>RewardFn</code>, whose <code>__call__</code> is used as a reward function.
+Implemented options are [<code>DenseRewardFn</code>]. Defaults to <code>DenseRewardFn</code>.</p></td>
+        <td><code>None</code></td>
+      </tr>
+      <tr>
+        <td><code>time_limit</code></td>
+        <td><code>int</code></td>
+        <td><p>the number of steps allowed before an episode terminates. Defaults to 50.</p></td>
+        <td><code>50</code></td>
+      </tr>
+      <tr>
+        <td><code>viewer</code></td>
+        <td><code>Optional[jumanji.viewer.Viewer[jumanji.environments.routing.connector.types.State]]</code></td>
+        <td><p><code>Viewer</code> used for rendering. Defaults to <code>ConnectorViewer</code> with "human" render
+mode.</p></td>
+        <td><code>None</code></td>
+      </tr>
+  </tbody>
+</table>
+    </div>
+
+  </div>
+
+
+
   <div class="doc doc-object doc-method">
 
 
@@ -1994,7 +2065,7 @@ <h3 id="jumanji.environments.routing.connector.env.Connector.render" class="doc
   <small>
 
       Last update:
-      2024-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </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-05-11
+      2024-10-25
 
   </small>
 </div>