Skip to content

Commit

Permalink
Deploying to gh-pages from @ be4f138 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
rradules committed Apr 12, 2024
1 parent 48bc2c8 commit 8fafedd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 80 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: 498e576a683f6837cc2b58ef1cf26259
config: cd63735b647fa34362bdf0a6ae39c71d
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
83 changes: 5 additions & 78 deletions environments/moingenious/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
Expand Down Expand Up @@ -289,7 +289,7 @@
</svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg>
<use href="#svg-toc"></use>
Expand All @@ -315,7 +315,7 @@ <h1>MO-Ingenious<a class="headerlink" href="#mo-ingenious" title="Link to this h
<td><p>Discrete(2880)</p></td>
</tr>
<tr class="row-even"><td><p>Observation Space</p></td>
<td><p>Dict(‘action_mask’: Box(0, 1, (2880,), int8), ‘observation’: Dict(‘board’: Box(0.0, 6.0, (11, 11), float32), ‘scores’: Box(0, 18, (6,), int32), ‘tiles’: Box(0, 6, (6, 2), int32)))</p></td>
<td><p>Dict(‘action_mask’: Box(0, 1, (2880,), int8), ‘observation’: Dict(‘board’: Box(0.0, 6.0, (11, 11), float32), ‘racks’: Box(0, 6, (6, 2), int32), ‘scores’: Box(0, 18, (2, 6), int32)))</p></td>
</tr>
<tr class="row-odd"><td><p>Reward Space</p></td>
<td><p>Box(0.0, 18.0, (6,), float32)</p></td>
Expand All @@ -326,55 +326,7 @@ <h1>MO-Ingenious<a class="headerlink" href="#mo-ingenious" title="Link to this h
</tbody>
</table>
</div>
<p>Ingenious board game.</p>
<p>Ingenious is a turn-based board game for multiple players. 2-4 players can play (default is 2), on a hexagonal
board with an edge length of 3-10 (default is 6). Each player has 2-6 (default is 6) tiles with colour symbols on
their rack (hand). In sequential order, players play one of their tiles onto the hexagonal board, with the goal
of establishing lines of matching symbols emerging from the placed tile. This allows the players to increase
their score in the respective colors, each color representing one of 2-6 (default is 6) objectives. New tiles are
randomly drawn, and the racks of other players with their currently available tiles are not observable (in the
default rules). When the board is filled, the original game rules define the winner as the player who has the
highest score in their lowest-scoring colour. This implementation exposes the colour scores themselves as
different objectives, allowing arbitrary utility functions to be defined over them.</p>
<section id="observation-space">
<h2>Observation Space<a class="headerlink" href="#observation-space" title="Link to this heading">#</a></h2>
<p>The observation is a dictionary which contains an <code class="docutils literal notranslate"><span class="pre">'observation'</span></code> element which is the usual RL observation described
below, and an <code class="docutils literal notranslate"><span class="pre">'action_mask'</span></code> which holds the legal moves, described in the Legal Actions Mask section below.
The main observation space is a dictionary containing the <code class="docutils literal notranslate"><span class="pre">'board'</span></code>, the <code class="docutils literal notranslate"><span class="pre">'tiles'</span></code>, and the <code class="docutils literal notranslate"><span class="pre">'scores'</span></code>. TODO describe. why do we return the scores of the player?</p>
</section>
<section id="legal-actions-mask">
<h2>Legal Actions Mask<a class="headerlink" href="#legal-actions-mask" title="Link to this heading">#</a></h2>
<p>The legal moves available to the current agent are found in the <code class="docutils literal notranslate"><span class="pre">action_mask</span></code> element of the dictionary observation.
The <code class="docutils literal notranslate"><span class="pre">action_mask</span></code> is a binary vector where each index of the vector represents whether the represented action is legal
or not; the action encoding is described in the Action Space section below.
The <code class="docutils literal notranslate"><span class="pre">action_mask</span></code> will be all zeros for any agent except the one whose turn it is. TODO is this true?</p>
</section>
<section id="action-space">
<h2>Action Space<a class="headerlink" href="#action-space" title="Link to this heading">#</a></h2>
<p>The action space is the set of integers from 0 to TODO describe action encoding here, with reference to web resource for hex encoding</p>
</section>
<section id="rewards">
<h2>Rewards<a class="headerlink" href="#rewards" title="Link to this heading">#</a></h2>
<p>The reward dimensions correspond to the 2-6 (default is 6) different colors that the players can score points for.</p>
</section>
<section id="starting-state">
<h2>Starting State<a class="headerlink" href="#starting-state" title="Link to this heading">#</a></h2>
<p>The game starts with an empty board, and each player with 2-6 (default is 6) randomly drawn tiles in their hand.</p>
</section>
<section id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Link to this heading">#</a></h2>
<ul class="simple">
<li><p>‘num_players’ (int): The number of players in the environment. Default: 2</p></li>
<li><p>‘init_draw’ (int): The number of tiles each player draws at the beginning of the game. Default: 6</p></li>
<li><p>‘num_colors’ (int): The number of colors in the game. Default: 6</p></li>
<li><p>‘board_size’ (int): The size of the board. Default: 6</p></li>
<li><p>‘limitation_score’ (int): Maximum score for any color Default: 18</p></li>
<li><p>‘render_mode’ (str): The rendering mode. Default: None</p></li>
</ul>
</section>
<section id="version-history">
<h2>Version History<a class="headerlink" href="#version-history" title="Link to this heading">#</a></h2>
</section>
<p>Environment for the Ingenious board game.</p>
</section>

</article>
Expand Down Expand Up @@ -422,33 +374,8 @@ <h2>Version History<a class="headerlink" href="#version-history" title="Link to

</footer>
</div>
<aside class="toc-drawer">

<aside class="toc-drawer no-toc">

<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">MO-Ingenious</a><ul>
<li><a class="reference internal" href="#observation-space">Observation Space</a></li>
<li><a class="reference internal" href="#legal-actions-mask">Legal Actions Mask</a></li>
<li><a class="reference internal" href="#action-space">Action Space</a></li>
<li><a class="reference internal" href="#rewards">Rewards</a></li>
<li><a class="reference internal" href="#starting-state">Starting State</a></li>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
<li><a class="reference internal" href="#version-history">Version History</a></li>
</ul>
</li>
</ul>

</div>
</div>
</div>


</aside>
Expand Down
Loading

0 comments on commit 8fafedd

Please sign in to comment.