Skip to content

Commit

Permalink
Deploying to gh-pages from @ 6cd8323 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ffelten committed May 3, 2024
1 parent e48cc9d commit 74e051c
Show file tree
Hide file tree
Showing 35 changed files with 145 additions and 110 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7ceb4aaaefed7bfb4d66af48c1aae153
config: 63a8af9b3368f5f776b1597bc8fb05ae
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
3 changes: 1 addition & 2 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,6 @@
<li class="toctree-l2"><a class="reference internal" href="/environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="/environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -397,7 +396,7 @@ <h2>The requested page could not be found.<a class="headerlink" href="#the-reque



<script src="/_static/documentation_options.js?v=697c8f77"></script>
<script src="/_static/documentation_options.js?v=58a8cf74"></script>
<script src="/_static/doctools.js?v=9a2dae69"></script>
<script src="/_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="/_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions README/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,6 @@
<li class="toctree-l2"><a class="reference internal" href="../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -414,7 +413,7 @@ <h2>Build the Documentation<a class="headerlink" href="#build-the-documentation"



<script src="../_static/documentation_options.js?v=697c8f77"></script>
<script src="../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@
<li class="toctree-l2"><a class="reference internal" href="../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -367,7 +366,7 @@ <h1>All modules for which code is available</h1>



<script src="../_static/documentation_options.js?v=697c8f77"></script>
<script src="../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions _modules/momaland/utils/aec_wrappers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -506,7 +505,7 @@ <h1>Source code for momaland.utils.aec_wrappers</h1><div class="highlight"><pre>



<script src="../../../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions _modules/momaland/utils/conversions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -538,7 +537,7 @@ <h1>Source code for momaland.utils.conversions</h1><div class="highlight"><pre>



<script src="../../../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions _modules/momaland/utils/env/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -432,7 +431,7 @@ <h1>Source code for momaland.utils.env</h1><div class="highlight"><pre>



<script src="../../../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
3 changes: 1 addition & 2 deletions _modules/momaland/utils/parallel_wrappers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -597,7 +596,7 @@ <h1>Source code for momaland.utils.parallel_wrappers</h1><div class="highlight">



<script src="../../../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.0.2',
VERSION: '0.1.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'dirhtml',
Expand Down
13 changes: 6 additions & 7 deletions api/aec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -311,8 +310,8 @@
<h1>AEC<a class="headerlink" href="#aec" title="Link to this heading"></a></h1>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>
<p>Similar to <a class="reference external" href="https://pettingzoo.farama.org">PettingZoo</a>, the MOMAland API models environments as simple Python <code class="docutils literal notranslate"><span class="pre">env</span></code> classes. Creating environment instances and interacting with them is very simple - here’s an example using the “momultiwalker_v0” environment:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">momaland.envs.momultiwalker</span> <span class="kn">import</span> <span class="n">momultiwalker_v0</span> <span class="k">as</span> <span class="n">_env</span>
<p>Similar to <a class="reference external" href="https://pettingzoo.farama.org">PettingZoo</a>, the MOMAland API models environments as simple Python <code class="docutils literal notranslate"><span class="pre">env</span></code> classes. Creating environment instances and interacting with them is very simple - here’s an example using the “momultiwalker_stability_v0” environment:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">momaland.envs.momultiwalker_stability</span> <span class="kn">import</span> <span class="n">momultiwalker_stability_v0</span> <span class="k">as</span> <span class="n">_env</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<span class="c1"># .env() function will return an AEC environment, as per PZ standard</span>
Expand All @@ -335,9 +334,9 @@ <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a>
<span class="c1"># Making the vector reward a scalar reward to shift to single-objective multi-agent (aka PettingZoo)</span>
<span class="c1"># We can assign different weights to the objectives of each agent.</span>
<span class="n">weights</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">&quot;walker_0&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">]),</span>
<span class="s2">&quot;walker_1&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">]),</span>
<span class="s2">&quot;walker_2&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.6</span><span class="p">]),</span>
<span class="s2">&quot;walker_0&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">]),</span>
<span class="s2">&quot;walker_1&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">]),</span>
<span class="s2">&quot;walker_2&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">]),</span>
<span class="p">}</span>
<span class="n">env</span> <span class="o">=</span> <span class="n">LinearizeReward</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">weights</span><span class="p">)</span>
</pre></div>
Expand Down Expand Up @@ -677,7 +676,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶



<script src="../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
7 changes: 3 additions & 4 deletions api/parallel/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,6 @@
<li class="toctree-l2"><a class="reference internal" href="../../environments/mogem_mining/">MO-GemMining</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/moingenious/">MO-Ingenious</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/moitem_gathering/">MO-ItemGathering</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/momultiwalker/">MO-Multiwalker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/momultiwalker_stability/">MO-MultiwalkerStability</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mopistonball/">MO-Pistonball</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mosame_game/">MO-SameGame</a></li>
Expand Down Expand Up @@ -312,13 +311,13 @@ <h1>Parallel<a class="headerlink" href="#parallel" title="Link to this heading">
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>
<p>Parallel environments can be interacted with as follows:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">momaland.envs.momultiwalker</span> <span class="kn">import</span> <span class="n">momultiwalker_v0</span> <span class="k">as</span> <span class="n">_env</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">momaland.envs.momultiwalker_stability</span> <span class="kn">import</span> <span class="n">momultiwalker_stability_v0</span> <span class="k">as</span> <span class="n">_env</span>

<span class="c1"># .parallel_env() function will return a Parallel environment, as per PZ standard</span>
<span class="n">parallel_env</span> <span class="o">=</span> <span class="n">_env</span><span class="o">.</span><span class="n">parallel_env</span><span class="p">(</span><span class="n">render_mode</span><span class="o">=</span><span class="s2">&quot;human&quot;</span><span class="p">)</span>

<span class="c1"># optionally, you can scalarize the reward with weights</span>
<span class="n">parallel_env</span> <span class="o">=</span> <span class="n">momaland</span><span class="o">.</span><span class="n">LinearReward</span><span class="p">(</span><span class="n">parallel_env</span><span class="p">,</span> <span class="n">weight</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.6</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">,</span> <span class="mf">0.2</span><span class="p">]))</span>
<span class="n">parallel_env</span> <span class="o">=</span> <span class="n">momaland</span><span class="o">.</span><span class="n">LinearReward</span><span class="p">(</span><span class="n">parallel_env</span><span class="p">,</span> <span class="n">weight</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">0.7</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">]))</span>

<span class="n">observations</span><span class="p">,</span> <span class="n">infos</span> <span class="o">=</span> <span class="n">parallel_env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
<span class="k">while</span> <span class="n">parallel_env</span><span class="o">.</span><span class="n">agents</span><span class="p">:</span>
Expand Down Expand Up @@ -621,7 +620,7 @@ <h2>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶



<script src="../../_static/documentation_options.js?v=697c8f77"></script>
<script src="../../_static/documentation_options.js?v=58a8cf74"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/scripts/furo.js?v=7660844c"></script>
Expand Down
Loading

0 comments on commit 74e051c

Please sign in to comment.