Skip to content

Commit

Permalink
Add docs to minimax
Browse files Browse the repository at this point in the history
  • Loading branch information
Zachary Marion committed Dec 30, 2018
1 parent b4a5538 commit 484323e
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 5 deletions.
Binary file modified docs/.doctrees/api/algorithms.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
14 changes: 10 additions & 4 deletions docs/_modules/algorithms/minimax.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,17 +168,23 @@ <h1>Source code for algorithms.minimax</h1><div class="highlight"><pre>
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">]</span>
<span class="k">return</span> <span class="n">actions</span><span class="p">[</span><span class="n">rewards</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="nb">max</span><span class="p">(</span><span class="n">rewards</span><span class="p">))]</span>

<span class="k">def</span> <span class="nf">min_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="p">):</span>
<div class="viewcode-block" id="Minimax.min_play"><a class="viewcode-back" href="../../api/algorithms.html#algorithms.Minimax.min_play">[docs]</a> <span class="k">def</span> <span class="nf">min_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Return the smallest value out of all of the child states</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="n">actions</span> <span class="o">=</span> <span class="n">g</span><span class="o">.</span><span class="n">action_space</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="n">g</span><span class="o">.</span><span class="n">terminal</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">or</span> <span class="n">depth</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">horizon</span><span class="p">:</span>
<span class="k">return</span> <span class="n">g</span><span class="o">.</span><span class="n">reward</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">1</span><span class="o">-</span><span class="n">p</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">min</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">max_play</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="n">g</span><span class="o">.</span><span class="n">next_state</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">p</span><span class="p">),</span> <span class="mi">1</span><span class="o">-</span><span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">])</span>
<span class="k">return</span> <span class="nb">min</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">max_play</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="n">g</span><span class="o">.</span><span class="n">next_state</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">p</span><span class="p">),</span> <span class="mi">1</span><span class="o">-</span><span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">])</span></div>

<span class="k">def</span> <span class="nf">max_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="p">):</span>
<div class="viewcode-block" id="Minimax.max_play"><a class="viewcode-back" href="../../api/algorithms.html#algorithms.Minimax.max_play">[docs]</a> <span class="k">def</span> <span class="nf">max_play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Return the largest value out of all of the child states</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="n">actions</span> <span class="o">=</span> <span class="n">g</span><span class="o">.</span><span class="n">action_space</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="n">g</span><span class="o">.</span><span class="n">terminal</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">or</span> <span class="n">depth</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">horizon</span><span class="p">:</span>
<span class="k">return</span> <span class="n">g</span><span class="o">.</span><span class="n">reward</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">max</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">min_play</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="n">g</span><span class="o">.</span><span class="n">next_state</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">p</span><span class="p">),</span> <span class="mi">1</span><span class="o">-</span><span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">])</span></div>
<span class="k">return</span> <span class="nb">max</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">min_play</span><span class="p">(</span><span class="n">g</span><span class="p">,</span> <span class="n">g</span><span class="o">.</span><span class="n">next_state</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">a</span><span class="p">,</span> <span class="n">p</span><span class="p">),</span> <span class="mi">1</span><span class="o">-</span><span class="n">p</span><span class="p">,</span> <span class="n">depth</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">actions</span><span class="p">])</span></div></div>
</pre></div>

</div>
Expand Down
12 changes: 12 additions & 0 deletions docs/api/algorithms.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,18 @@ <h1>Algorithms<a class="headerlink" href="#algorithms" title="Permalink to this
</table>
</dd></dl>

<dl class="method">
<dt id="algorithms.Minimax.max_play">
<code class="descname">max_play</code><span class="sig-paren">(</span><em>g</em>, <em>s</em>, <em>p</em>, <em>depth</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/algorithms/minimax.html#Minimax.max_play"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algorithms.Minimax.max_play" title="Permalink to this definition"></a></dt>
<dd><p>Return the largest value out of all of the child states</p>
</dd></dl>

<dl class="method">
<dt id="algorithms.Minimax.min_play">
<code class="descname">min_play</code><span class="sig-paren">(</span><em>g</em>, <em>s</em>, <em>p</em>, <em>depth</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/algorithms/minimax.html#Minimax.min_play"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#algorithms.Minimax.min_play" title="Permalink to this definition"></a></dt>
<dd><p>Return the smallest value out of all of the child states</p>
</dd></dl>

</dd></dl>

</div>
Expand Down
4 changes: 4 additions & 0 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,8 @@ <h2 id="I">I</h2>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/algorithms.html#algorithms.Minimax.max_play">max_play() (algorithms.Minimax method)</a>
</li>
<li><a href="api/agents.html#agents.MCTSAgent.mcts">mcts (agents.MCTSAgent attribute)</a>
</li>
<li><a href="api/algorithms.html#algorithms.MCTS">MCTS (class in algorithms)</a>
Expand All @@ -253,6 +255,8 @@ <h2 id="M">M</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/algorithms.html#algorithms.Minimax.min_play">min_play() (algorithms.Minimax method)</a>
</li>
<li><a href="api/agents.html#agents.MinimaxAgent.minimax">minimax (agents.MinimaxAgent attribute)</a>
</li>
<li><a href="api/algorithms.html#algorithms.Minimax">Minimax (class in algorithms)</a>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.

0 comments on commit 484323e

Please sign in to comment.