Skip to content

Commit

Permalink
Move interfaces to core
Browse files Browse the repository at this point in the history
  • Loading branch information
Zachary Marion committed Dec 29, 2018
1 parent f599602 commit d6e5593
Show file tree
Hide file tree
Showing 39 changed files with 338 additions and 380 deletions.
Binary file modified docs/.doctrees/api/agents.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/core.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/games.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_modules/agents/human_agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@
<div itemprop="articleBody">

<h1>Source code for agents.human_agent</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">.agent</span> <span class="k">import</span> <span class="n">Agent</span>
<span></span><span class="kn">from</span> <span class="nn">gameai.core</span> <span class="k">import</span> <span class="n">Agent</span>


<div class="viewcode-block" id="HumanAgent"><a class="viewcode-back" href="../../api/agents.html#agents.HumanAgent">[docs]</a><span class="k">class</span> <span class="nc">HumanAgent</span><span class="p">(</span><span class="n">Agent</span><span class="p">):</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/agents/mcts_agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,14 +151,14 @@

<h1>Source code for agents.mcts_agent</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">gameai.algorithms</span> <span class="k">import</span> <span class="n">MCTS</span>
<span class="kn">from</span> <span class="nn">.trainable_agent</span> <span class="k">import</span> <span class="n">TrainableAgent</span>
<span class="kn">from</span> <span class="nn">gameai.core</span> <span class="k">import</span> <span class="n">TrainableAgent</span>


<div class="viewcode-block" id="MCTSAgent"><a class="viewcode-back" href="../../api/agents.html#agents.MCTSAgent">[docs]</a><span class="k">class</span> <span class="nc">MCTSAgent</span><span class="p">(</span><span class="n">TrainableAgent</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Agent that uses Monte Carlo Tree Search (MCTS) </span>

<span class="sd"> Attributes</span>
<span class="sd"> Attributes:</span>
<span class="sd"> mcts (MTCS): The mcts search class</span>
<span class="sd"> &#39;&#39;&#39;</span>

Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/agents/minimax_agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@

<h1>Source code for agents.minimax_agent</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">gameai.algorithms</span> <span class="k">import</span> <span class="n">Minimax</span>
<span class="kn">from</span> <span class="nn">.agent</span> <span class="k">import</span> <span class="n">Agent</span>
<span class="kn">from</span> <span class="nn">gameai.core</span> <span class="k">import</span> <span class="n">Agent</span>


<div class="viewcode-block" id="MinimaxAgent"><a class="viewcode-back" href="../../api/agents.html#agents.MinimaxAgent">[docs]</a><span class="k">class</span> <span class="nc">MinimaxAgent</span><span class="p">(</span><span class="n">Agent</span><span class="p">):</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/agents/random_agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
<h1>Source code for agents.random_agent</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">random</span> <span class="k">import</span> <span class="n">choice</span>

<span class="kn">from</span> <span class="nn">.agent</span> <span class="k">import</span> <span class="n">Agent</span>
<span class="kn">from</span> <span class="nn">gameai.core</span> <span class="k">import</span> <span class="n">Agent</span>


<div class="viewcode-block" id="RandomAgent"><a class="viewcode-back" href="../../api/agents.html#agents.RandomAgent">[docs]</a><span class="k">class</span> <span class="nc">RandomAgent</span><span class="p">(</span><span class="n">Agent</span><span class="p">):</span>
Expand Down
10 changes: 5 additions & 5 deletions docs/_modules/agents/agent.html → docs/_modules/core/agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>agents.agent &mdash; Game AI documentation</title>
<title>core.agent &mdash; Game AI documentation</title>



Expand Down Expand Up @@ -134,7 +134,7 @@

<li><a href="../index.html">Module code</a> &raquo;</li>

<li>agents.agent</li>
<li>core.agent</li>


<li class="wy-breadcrumbs-aside">
Expand All @@ -149,15 +149,15 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for agents.agent</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Agent"><a class="viewcode-back" href="../../api/agents.html#agents.Agent">[docs]</a><span></span><span class="k">class</span> <span class="nc">Agent</span><span class="p">:</span>
<h1>Source code for core.agent</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Agent"><a class="viewcode-back" href="../../api/core.html#core.Agent">[docs]</a><span></span><span class="k">class</span> <span class="nc">Agent</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> An agent class which exposes a method called action. Given a certain</span>
<span class="sd"> state of a game and the player that is playing, the agent retuns the</span>
<span class="sd"> best action it can find, given a certain heuristic or strategy</span>
<span class="sd"> &#39;&#39;&#39;</span>

<div class="viewcode-block" id="Agent.action"><a class="viewcode-back" href="../../api/agents.html#agents.Agent.action">[docs]</a> <span class="k">def</span> <span class="nf">action</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>
<div class="viewcode-block" id="Agent.action"><a class="viewcode-back" href="../../api/core.html#core.Agent.action">[docs]</a> <span class="k">def</span> <span class="nf">action</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="sd">&#39;&#39;&#39;</span>
<span class="sd"> Given a game, a state of the game, return an action</span>

Expand Down
26 changes: 13 additions & 13 deletions docs/_modules/games/game.html → docs/_modules/core/game.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>games.game &mdash; Game AI documentation</title>
<title>core.game &mdash; Game AI documentation</title>



Expand Down Expand Up @@ -134,7 +134,7 @@

<li><a href="../index.html">Module code</a> &raquo;</li>

<li>games.game</li>
<li>core.game</li>


<li class="wy-breadcrumbs-aside">
Expand All @@ -149,21 +149,21 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for games.game</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Game"><a class="viewcode-back" href="../../api/games.html#games.Game">[docs]</a><span></span><span class="k">class</span> <span class="nc">Game</span><span class="p">:</span>
<h1>Source code for core.game</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Game"><a class="viewcode-back" href="../../api/core.html#core.Game">[docs]</a><span></span><span class="k">class</span> <span class="nc">Game</span><span class="p">:</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Game class, which is extended to implement different types of adversarial,</span>
<span class="sd"> zero sum games. The class itself is stateless and all methods are actually</span>
<span class="sd"> static.</span>
<span class="sd"> &#39;&#39;&#39;</span>

<div class="viewcode-block" id="Game.initial_state"><a class="viewcode-back" href="../../api/games.html#games.Game.initial_state">[docs]</a> <span class="k">def</span> <span class="nf">initial_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<div class="viewcode-block" id="Game.initial_state"><a class="viewcode-back" href="../../api/core.html#core.Game.initial_state">[docs]</a> <span class="k">def</span> <span class="nf">initial_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Return the initial state of the game</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.action_space"><a class="viewcode-back" href="../../api/games.html#games.Game.action_space">[docs]</a> <span class="k">def</span> <span class="nf">action_space</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.action_space"><a class="viewcode-back" href="../../api/core.html#core.Game.action_space">[docs]</a> <span class="k">def</span> <span class="nf">action_space</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> For any given state returns a list of all possible valid actions</span>

Expand All @@ -172,7 +172,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.terminal"><a class="viewcode-back" href="../../api/games.html#games.Game.terminal">[docs]</a> <span class="k">def</span> <span class="nf">terminal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.terminal"><a class="viewcode-back" href="../../api/core.html#core.Game.terminal">[docs]</a> <span class="k">def</span> <span class="nf">terminal</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns whether a given state is terminal</span>

Expand All @@ -181,7 +181,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.flip_state"><a class="viewcode-back" href="../../api/games.html#games.Game.flip_state">[docs]</a> <span class="k">def</span> <span class="nf">flip_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.flip_state"><a class="viewcode-back" href="../../api/core.html#core.Game.flip_state">[docs]</a> <span class="k">def</span> <span class="nf">flip_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Invert the state of the board so that player 0 becomes player 1</span>

Expand All @@ -190,7 +190,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.winner"><a class="viewcode-back" href="../../api/games.html#games.Game.winner">[docs]</a> <span class="k">def</span> <span class="nf">winner</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.winner"><a class="viewcode-back" href="../../api/core.html#core.Game.winner">[docs]</a> <span class="k">def</span> <span class="nf">winner</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the winner of a game, or -1 if there is no winner</span>

Expand All @@ -199,7 +199,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.reward"><a class="viewcode-back" href="../../api/games.html#games.Game.reward">[docs]</a> <span class="k">def</span> <span class="nf">reward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">p</span><span class="p">):</span>
<div class="viewcode-block" id="Game.reward"><a class="viewcode-back" href="../../api/core.html#core.Game.reward">[docs]</a> <span class="k">def</span> <span class="nf">reward</span><span class="p">(</span><span class="bp">self</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="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns the reward for a given state</span>

Expand All @@ -209,7 +209,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.next_state"><a class="viewcode-back" href="../../api/games.html#games.Game.next_state">[docs]</a> <span class="k">def</span> <span class="nf">next_state</span><span class="p">(</span><span class="bp">self</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>
<div class="viewcode-block" id="Game.next_state"><a class="viewcode-back" href="../../api/core.html#core.Game.next_state">[docs]</a> <span class="k">def</span> <span class="nf">next_state</span><span class="p">(</span><span class="bp">self</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="sd">&#39;&#39;&#39;</span>
<span class="sd"> Given a state, action, and player id, return the state resulting from the</span>
<span class="sd"> player making that move</span>
Expand All @@ -221,7 +221,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>

<div class="viewcode-block" id="Game.to_readable_string"><a class="viewcode-back" href="../../api/games.html#games.Game.to_readable_string">[docs]</a> <span class="k">def</span> <span class="nf">to_readable_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.to_readable_string"><a class="viewcode-back" href="../../api/core.html#core.Game.to_readable_string">[docs]</a> <span class="k">def</span> <span class="nf">to_readable_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns a pretty-formatted representation of the board</span>

Expand All @@ -230,7 +230,7 @@ <h1>Source code for games.game</h1><div class="highlight"><pre>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">s</span><span class="p">)</span></div>

<div class="viewcode-block" id="Game.to_hash"><a class="viewcode-back" href="../../api/games.html#games.Game.to_hash">[docs]</a> <span class="k">def</span> <span class="nf">to_hash</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<div class="viewcode-block" id="Game.to_hash"><a class="viewcode-back" href="../../api/core.html#core.Game.to_hash">[docs]</a> <span class="k">def</span> <span class="nf">to_hash</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Returns a hash of the game state, which is necessary for some algorithms</span>
<span class="sd"> such as MCTS</span>
Expand Down

0 comments on commit d6e5593

Please sign in to comment.