Changelog and docs

h2r · Nov 3, 2021 · 1fdd239 · 1fdd239
1 parent 9f664f2
commit 1fdd239
Show file tree

Hide file tree

Showing 13 changed files with 325 additions and 43 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,9 +3,12 @@ Changelog
 
 Best viewed on `the website <https://h2r.github.io/pomdp-py/html/changelog.html>`_.
 
-Version 1.3.0.2 (pending)
+Version 1.3.1 (pending)
 -------------------------
-* bug fix in :py:mod:`~pomdp_py.representations.distribution.particles` (in :code:`add`)
+* Bug fix in :py:mod:`~pomdp_py.representations.distribution.particles` (in :code:`add`)
+* Added classes for tabular models :py:mod:`~pomdp_py.utils.templates.TabularTransitionModel`,
+  :py:mod:`~pomdp_py.utils.templates.TabularObservationModel`,
+  :py:mod:`~pomdp_py.utils.templates.TabularRewardModel`
 
 Version 1.3.0.1 (09/30/2021)
 ----------------------------

diff --git a/docs/_sphinx_src/index.rst b/docs/_sphinx_src/index.rst
@@ -23,6 +23,7 @@ The code is available `on github <https://github.com/h2r/pomdp-py>`_. We welcome
 Getting Started
 ---------------
 * :doc:`installation`
+* :doc:`What's New? <changelog>` (Changelog)
 * :doc:`Examples <examples>`:
 
   (1) :doc:`examples.tiger`: The Tiger domain shows how one could quickly implement a simple POMDP.
@@ -33,7 +34,6 @@ Getting Started
 * :doc:`existing_solvers`
 * :doc:`examples.external_solvers`
 * :doc:`Debugging Tools<api/pomdp_py.utils.debugging>`
-* :doc:`What's New? <changelog>`
 
 Further
 -------

diff --git a/docs/html/_modules/pomdp_py/utils/debugging.html b/docs/html/_modules/pomdp_py/utils/debugging.html
diff --git a/docs/html/_modules/pomdp_py/utils/templates.html b/docs/html/_modules/pomdp_py/utils/templates.html
diff --git a/docs/html/_sources/changelog.rst.txt b/docs/html/_sources/changelog.rst.txt
@@ -3,6 +3,13 @@ Changelog
 
 Best viewed on `the website <https://h2r.github.io/pomdp-py/html/changelog.html>`_.
 
+Version 1.3.1 (pending)
+-------------------------
+* Bug fix in :py:mod:`~pomdp_py.representations.distribution.particles` (in :code:`add`)
+* Added classes for tabular models :py:mod:`~pomdp_py.utils.templates.TabularTransitionModel`,
+  :py:mod:`~pomdp_py.utils.templates.TabularObservationModel`,
+  :py:mod:`~pomdp_py.utils.templates.TabularRewardModel`
+
 Version 1.3.0.1 (09/30/2021)
 ----------------------------
 

diff --git a/docs/html/_sources/index.rst.txt b/docs/html/_sources/index.rst.txt
@@ -23,6 +23,7 @@ The code is available `on github <https://github.com/h2r/pomdp-py>`_. We welcome
 Getting Started
 ---------------
 * :doc:`installation`
+* :doc:`What's New? <changelog>` (Changelog)
 * :doc:`Examples <examples>`:
 
   (1) :doc:`examples.tiger`: The Tiger domain shows how one could quickly implement a simple POMDP.
@@ -33,7 +34,6 @@ Getting Started
 * :doc:`existing_solvers`
 * :doc:`examples.external_solvers`
 * :doc:`Debugging Tools<api/pomdp_py.utils.debugging>`
-* :doc:`What's New? <changelog>`
 
 Further
 -------

diff --git a/docs/html/api/pomdp_py.utils.html b/docs/html/api/pomdp_py.utils.html
diff --git a/docs/html/changelog.html b/docs/html/changelog.html
@@ -56,6 +56,7 @@
   <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
+<li><a class="reference internal" href="#version-1-3-1-pending">Version 1.3.1 (pending)</a></li>
 <li><a class="reference internal" href="#version-1-3-0-1-09-30-2021">Version 1.3.0.1 (09/30/2021)</a></li>
 <li><a class="reference internal" href="#version-1-2-4-6-canceled">Version 1.2.4.6 (canceled)</a></li>
 <li><a class="reference internal" href="#version-1-2-4-5-07-05-2021">Version 1.2.4.5 (07/05/2021)</a></li>
@@ -80,6 +81,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="design_principles.html">Design Principles</a></li>
 <li class="toctree-l1"><a class="reference internal" href="existing_solvers.html">Existing POMDP Solvers</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">What's New?</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-1-3-1-pending">Version 1.3.1 (pending)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-3-0-1-09-30-2021">Version 1.3.0.1 (09/30/2021)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-2-4-6-canceled">Version 1.2.4.6 (canceled)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-2-4-5-07-05-2021">Version 1.2.4.5 (07/05/2021)</a></li>
@@ -157,12 +159,21 @@ <h3 class="donation">Donate/support</h3>
   <div class="section" id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <p>Best viewed on <a class="reference external" href="https://h2r.github.io/pomdp-py/html/changelog.html">the website</a>.</p>
+<div class="section" id="version-1-3-1-pending">
+<h2>Version 1.3.1 (pending)<a class="headerlink" href="#version-1-3-1-pending" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p>Bug fix in <a class="reference internal" href="api/pomdp_py.representations.distribution.html#module-pomdp_py.representations.distribution.particles" title="pomdp_py.representations.distribution.particles"><code class="xref py py-mod docutils literal notranslate"><span class="pre">particles</span></code></a> (in <code class="code docutils literal notranslate"><span class="pre">add</span></code>)</p></li>
+<li><p>Added classes for tabular models <a class="reference internal" href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularTransitionModel" title="pomdp_py.utils.templates.TabularTransitionModel"><code class="xref py py-mod docutils literal notranslate"><span class="pre">TabularTransitionModel</span></code></a>,
+<a class="reference internal" href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularObservationModel" title="pomdp_py.utils.templates.TabularObservationModel"><code class="xref py py-mod docutils literal notranslate"><span class="pre">TabularObservationModel</span></code></a>,
+<a class="reference internal" href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularRewardModel" title="pomdp_py.utils.templates.TabularRewardModel"><code class="xref py py-mod docutils literal notranslate"><span class="pre">TabularRewardModel</span></code></a></p></li>
+</ul>
+</div>
 <div class="section" id="version-1-3-0-1-09-30-2021">
 <h2>Version 1.3.0.1 (09/30/2021)<a class="headerlink" href="#version-1-3-0-1-09-30-2021" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><p>Removed dependency on <code class="code docutils literal notranslate"><span class="pre">pygraphviz</span></code>;</p></li>
 <li><p>Added <code class="code docutils literal notranslate"><span class="pre">utils.debugging.Treedebugger</span></code>, which makes it easier to inspect the search tree.
-See <a class="reference internal" href="api/pomdp_py.utils.debugging.html#module-pomdp_py.utils.debugging" title="pomdp_py.utils.debugging"><code class="xref py py-mod docutils literal notranslate"><span class="pre">debugging</span></code></a>.</p></li>
+See <a class="reference internal" href="api/pomdp_py.utils.html#module-pomdp_py.utils.debugging" title="pomdp_py.utils.debugging"><code class="xref py py-mod docutils literal notranslate"><span class="pre">debugging</span></code></a>.</p></li>
 <li><p>Added <code class="code docutils literal notranslate"><span class="pre">WeightedParticles</span></code>; Refactored <code class="code docutils literal notranslate"><span class="pre">Particles</span></code>. (<a class="reference internal" href="api/pomdp_py.representations.distribution.html#module-pomdp_py.representations.distribution.particles" title="pomdp_py.representations.distribution.particles"><code class="xref py py-mod docutils literal notranslate"><span class="pre">particles</span></code></a>)</p></li>
 <li><p>Optionally show progress bar while simulating in POUCT/POMCP.</p></li>
 <li><p>Added a CLI interface to simplify running example domains, e.g. <code class="code docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pomdp_py</span> <span class="pre">-r</span> <span class="pre">tiger</span></code> runs Tiger.</p></li>

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -633,6 +633,8 @@ <h2 id="G">G</h2>
         <li><a href="problems/pomdp_problems.tiger.html#pomdp_problems.tiger.tiger_problem.ObservationModel.get_all_observations">(pomdp_problems.tiger.tiger_problem.ObservationModel method)</a>
 </li>
         <li><a href="api/pomdp_py.framework.html#pomdp_py.framework.basics.ObservationModel.get_all_observations">(pomdp_py.framework.basics.ObservationModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularObservationModel.get_all_observations">(pomdp_py.utils.templates.TabularObservationModel method)</a>
 </li>
       </ul></li>
       <li><a href="problems/pomdp_problems.tiger.cythonize.html#pomdp_problems.tiger.cythonize.tiger_problem.TigerTransitionModel.get_all_states">get_all_states() (pomdp_problems.tiger.cythonize.tiger_problem.TigerTransitionModel method)</a>
@@ -641,6 +643,8 @@ <h2 id="G">G</h2>
         <li><a href="problems/pomdp_problems.tiger.html#pomdp_problems.tiger.tiger_problem.TransitionModel.get_all_states">(pomdp_problems.tiger.tiger_problem.TransitionModel method)</a>
 </li>
         <li><a href="api/pomdp_py.framework.html#pomdp_py.framework.basics.TransitionModel.get_all_states">(pomdp_py.framework.basics.TransitionModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularTransitionModel.get_all_states">(pomdp_py.utils.templates.TabularTransitionModel method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -1349,10 +1353,10 @@ <h2 id="P">P</h2>
 </li>
       <li><a href="problems/pomdp_problems.tag.models.components.html#module-pomdp_problems.tag.models.components.grid_map">pomdp_problems.tag.models.components.grid_map (module)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="problems/pomdp_problems.tag.models.components.html#module-pomdp_problems.tag.models.components.motion_policy">pomdp_problems.tag.models.components.motion_policy (module)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="problems/pomdp_problems.tag.models.html#module-pomdp_problems.tag.models.observation_model">pomdp_problems.tag.models.observation_model (module)</a>
 </li>
       <li><a href="problems/pomdp_problems.tag.models.html#module-pomdp_problems.tag.models.policy_model">pomdp_problems.tag.models.policy_model (module)</a>
@@ -1531,6 +1535,10 @@ <h2 id="P">P</h2>
         <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.DetObservationModel.probability">(pomdp_py.utils.templates.DetObservationModel method)</a>
 </li>
         <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.DetTransitionModel.probability">(pomdp_py.utils.templates.DetTransitionModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularObservationModel.probability">(pomdp_py.utils.templates.TabularObservationModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularTransitionModel.probability">(pomdp_py.utils.templates.TabularTransitionModel method)</a>
 </li>
       </ul></li>
       <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.math.proj">proj() (in module pomdp_py.utils.math)</a>
@@ -1819,6 +1827,12 @@ <h2 id="S">S</h2>
         <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.DetRewardModel.sample">(pomdp_py.utils.templates.DetRewardModel method)</a>
 </li>
         <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.DetTransitionModel.sample">(pomdp_py.utils.templates.DetTransitionModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularObservationModel.sample">(pomdp_py.utils.templates.TabularObservationModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularRewardModel.sample">(pomdp_py.utils.templates.TabularRewardModel method)</a>
+</li>
+        <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularTransitionModel.sample">(pomdp_py.utils.templates.TabularTransitionModel method)</a>
 </li>
         <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.UniformPolicyModel.sample">(pomdp_py.utils.templates.UniformPolicyModel method)</a>
 </li>
@@ -1942,6 +1956,12 @@ <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.math.T">T() (in module pomdp_py.utils.math)</a>
+</li>
+      <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularObservationModel">TabularObservationModel (class in pomdp_py.utils.templates)</a>
+</li>
+      <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularRewardModel">TabularRewardModel (class in pomdp_py.utils.templates)</a>
+</li>
+      <li><a href="api/pomdp_py.utils.html#pomdp_py.utils.templates.TabularTransitionModel">TabularTransitionModel (class in pomdp_py.utils.templates)</a>
 </li>
       <li><a href="problems/pomdp_problems.tag.domain.html#pomdp_problems.tag.domain.action.TagAction">TagAction (class in pomdp_problems.tag.domain.action)</a>
 </li>
@@ -1989,14 +2009,14 @@ <h2 id="T">T</h2>
         <li><a href="problems/pomdp_problems.tiger.html#pomdp_problems.tiger.tiger_problem.TigerAction">(class in pomdp_problems.tiger.tiger_problem)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="problems/pomdp_problems.tiger.cythonize.html#pomdp_problems.tiger.cythonize.tiger_problem.TigerObservation">TigerObservation (class in pomdp_problems.tiger.cythonize.tiger_problem)</a>
 
       <ul>
         <li><a href="problems/pomdp_problems.tiger.html#pomdp_problems.tiger.tiger_problem.TigerObservation">(class in pomdp_problems.tiger.tiger_problem)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="problems/pomdp_problems.tiger.cythonize.html#pomdp_problems.tiger.cythonize.tiger_problem.TigerObservationModel">TigerObservationModel (class in pomdp_problems.tiger.cythonize.tiger_problem)</a>
 </li>
       <li><a href="problems/pomdp_problems.tiger.cythonize.html#pomdp_problems.tiger.cythonize.tiger_problem.TigerPolicyModel">TigerPolicyModel (class in pomdp_problems.tiger.cythonize.tiger_problem)</a>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -149,6 +149,7 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
 <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="installation.html"><span class="doc">Installation</span></a></p></li>
+<li><p><a class="reference internal" href="changelog.html"><span class="doc">What’s New?</span></a> (Changelog)</p></li>
 <li><p><a class="reference internal" href="examples.html"><span class="doc">Examples</span></a>:</p>
 <ol class="arabic simple">
 <li><p><a class="reference internal" href="examples.tiger.html"><span class="doc">Tiger</span></a>: The Tiger domain shows how one could quickly implement a simple POMDP.</p></li>
@@ -160,7 +161,6 @@ <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalin
 <li><p><a class="reference internal" href="existing_solvers.html"><span class="doc">Existing POMDP Solvers</span></a></p></li>
 <li><p><a class="reference internal" href="examples.external_solvers.html"><span class="doc">Using External Solvers</span></a></p></li>
 <li><p><a class="reference internal" href="api/pomdp_py.utils.debugging.html"><span class="doc">Debugging Tools</span></a></p></li>
-<li><p><a class="reference internal" href="changelog.html"><span class="doc">What’s New?</span></a></p></li>
 </ul>
 </div>
 <div class="section" id="further">

diff --git a/docs/html/objects.inv b/docs/html/objects.inv
diff --git a/docs/html/py-modindex.html b/docs/html/py-modindex.html
@@ -599,7 +599,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-2">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="api/pomdp_py.utils.debugging.html#module-pomdp_py.utils.debugging"><code class="xref">pomdp_py.utils.debugging</code></a></td><td>
+       <a href="api/pomdp_py.utils.html#module-pomdp_py.utils.debugging"><code class="xref">pomdp_py.utils.debugging</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-2">
        <td></td>

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js