Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1f38fe6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@clement-bonnet
clement-bonnet committed Mar 21, 2024
1 parent b10c93e commit 9ed2627
Show file tree
Hide file tree
Showing 56 changed files with 2,337 additions and 2,131 deletions.
276 changes: 145 additions & 131 deletions api/env/index.html
View file

Large diffs are not rendered by default.

206 changes: 107 additions & 99 deletions api/environments/bin_pack/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1256,22 +1256,22 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.__init__" class="md-nav__link">
__init__()
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="md-nav__link">
observation_spec
</a>

</li>

<li class="md-nav__item">
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="md-nav__link">
observation_spec()
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="md-nav__link">
action_spec
</a>

</li>

<li class="md-nav__item">
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="md-nav__link">
action_spec()
<a href="#jumanji.environments.packing.bin_pack.env.BinPack.__init__" class="md-nav__link">
__init__()
</a>

</li>
Expand Down Expand Up @@ -1756,7 +1756,7 @@ <h2 id="jumanji.environments.packing.bin_pack.env.BinPack" class="doc doc-headin
<span class="n">key</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">PRNGKey</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">state</span><span class="p">,</span> <span class="n">timestep</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">jit</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">)(</span><span class="n">key</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">state</span><span class="p">)</span>
<span class="n">action</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">action_spec</span><span class="p">()</span><span class="o">.</span><span class="n">generate_value</span><span class="p">()</span>
<span class="n">action</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">action_spec</span><span class="o">.</span><span class="n">generate_value</span><span class="p">()</span>
<span class="n">state</span><span class="p">,</span> <span class="n">timestep</span> <span class="o">=</span> <span class="n">jax</span><span class="o">.</span><span class="n">jit</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">)(</span><span class="n">state</span><span class="p">,</span> <span class="n">action</span><span class="p">)</span>
<span class="n">env</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">state</span><span class="p">)</span>
</code></pre></div></td></tr></table></div>
Expand All @@ -1771,6 +1771,105 @@ <h2 id="jumanji.environments.packing.bin_pack.env.BinPack" class="doc doc-headin



<div class="doc doc-object doc-attribute">



<h3 id="jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="doc doc-heading">
<code class="highlight language-python"><span class="n">observation_spec</span><span class="p">:</span> <span class="n">jumanji</span><span class="o">.</span><span class="n">specs</span><span class="o">.</span><span class="n">Spec</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">packing</span><span class="o">.</span><span class="n">bin_pack</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Observation</span><span class="p">]</span></code>

<span class="doc doc-properties">
<small class="doc doc-property doc-property-cached"><code>cached</code></small>
<small class="doc doc-property doc-property-property"><code>property</code></small>
<small class="doc doc-property doc-property-writable"><code>writable</code></small>
</span>

<a href="#jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="headerlink" title="Permanent link">#</a></h3>

<div class="doc doc-contents ">

<p>Specifications of the observation of the <code>BinPack</code> environment.</p>

<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Spec for the `Observation` whose fields are</code></td>
<td><ul>
<li>ems:<ul>
<li>if normalize_dimensions:
tree of BoundedArray (float) of shape (obs_num_ems,).</li>
<li>else:
tree of BoundedArray (int32) of shape (obs_num_ems,).</li>
</ul>
</li>
<li>ems_mask: BoundedArray (bool) of shape (obs_num_ems,).</li>
<li>items:<ul>
<li>if normalize_dimensions:
tree of BoundedArray (float) of shape (max_num_items,).</li>
<li>else:
tree of BoundedArray (int32) of shape (max_num_items,).</li>
</ul>
</li>
<li>items_mask: BoundedArray (bool) of shape (max_num_items,).</li>
<li>items_placed: BoundedArray (bool) of shape (max_num_items,).</li>
<li>action_mask: BoundedArray (bool) of shape (obs_num_ems, max_num_items).</li>
</ul></td>
</tr>
</tbody>
</table> </div>

</div>



<div class="doc doc-object doc-attribute">



<h3 id="jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="doc doc-heading">
<code class="highlight language-python"><span class="n">action_spec</span><span class="p">:</span> <span class="n">MultiDiscreteArray</span></code>

<span class="doc doc-properties">
<small class="doc doc-property doc-property-cached"><code>cached</code></small>
<small class="doc doc-property doc-property-property"><code>property</code></small>
<small class="doc doc-property doc-property-writable"><code>writable</code></small>
</span>

<a href="#jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="headerlink" title="Permanent link">#</a></h3>

<div class="doc doc-contents ">

<p>Specifications of the action expected by the <code>BinPack</code> environment.</p>

<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>MultiDiscreteArray (int32) of shape (obs_num_ems, max_num_items).
- ems_id</code></td>
<td><p>int between 0 and obs_num_ems - 1 (included).
- item_id: int between 0 and max_num_items - 1 (included).</p></td>
</tr>
</tbody>
</table> </div>

</div>






Expand Down Expand Up @@ -1865,97 +1964,6 @@ <h3 id="jumanji.environments.packing.bin_pack.env.BinPack.__init__" class="doc d



<h3 id="jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="doc doc-heading">
<code class="highlight language-python"><span class="n">observation_spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">jumanji</span><span class="o">.</span><span class="n">specs</span><span class="o">.</span><span class="n">Spec</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">packing</span><span class="o">.</span><span class="n">bin_pack</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Observation</span><span class="p">]</span></code>


<a href="#jumanji.environments.packing.bin_pack.env.BinPack.observation_spec" class="headerlink" title="Permanent link">#</a></h3>

<div class="doc doc-contents ">

<p>Specifications of the observation of the <code>BinPack</code> environment.</p>

<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Spec for the `Observation` whose fields are</code></td>
<td><ul>
<li>ems:<ul>
<li>if normalize_dimensions:
tree of BoundedArray (float) of shape (obs_num_ems,).</li>
<li>else:
tree of BoundedArray (int32) of shape (obs_num_ems,).</li>
</ul>
</li>
<li>ems_mask: BoundedArray (bool) of shape (obs_num_ems,).</li>
<li>items:<ul>
<li>if normalize_dimensions:
tree of BoundedArray (float) of shape (max_num_items,).</li>
<li>else:
tree of BoundedArray (int32) of shape (max_num_items,).</li>
</ul>
</li>
<li>items_mask: BoundedArray (bool) of shape (max_num_items,).</li>
<li>items_placed: BoundedArray (bool) of shape (max_num_items,).</li>
<li>action_mask: BoundedArray (bool) of shape (obs_num_ems, max_num_items).</li>
</ul></td>
</tr>
</tbody>
</table>
</div>

</div>



<div class="doc doc-object doc-method">



<h3 id="jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="doc doc-heading">
<code class="highlight language-python"><span class="n">action_spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">MultiDiscreteArray</span></code>


<a href="#jumanji.environments.packing.bin_pack.env.BinPack.action_spec" class="headerlink" title="Permanent link">#</a></h3>

<div class="doc doc-contents ">

<p>Specifications of the action expected by the <code>BinPack</code> environment.</p>

<p><strong>Returns:</strong></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>MultiDiscreteArray (int32) of shape (obs_num_ems, max_num_items).
- ems_id</code></td>
<td><p>int between 0 and obs_num_ems - 1 (included).
- item_id: int between 0 and max_num_items - 1 (included).</p></td>
</tr>
</tbody>
</table>
</div>

</div>



<div class="doc doc-object doc-method">



<h3 id="jumanji.environments.packing.bin_pack.env.BinPack.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">packing</span><span class="o">.</span><span class="n">bin_pack</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">packing</span><span class="o">.</span><span class="n">bin_pack</span><span class="o">.</span><span class="n">types</span><span class="o">.</span><span class="n">Observation</span><span class="p">]]</span></code>

Expand Down Expand Up @@ -2162,7 +2170,7 @@ <h3 id="jumanji.environments.packing.bin_pack.env.BinPack.close" class="doc doc-
<small>

Last update:
2024-03-19
2024-03-21

</small>
</div>
Expand Down
Loading

0 comments on commit 9ed2627

Please sign in to comment.