Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kzheng-bdai
kzheng-bdai committed Mar 12, 2024
1 parent 129ff98 commit 0b0c517
Show file tree
Hide file tree
Showing 228 changed files with 26,569 additions and 661 deletions.
1 change: 1 addition & 0 deletions docs/_sphinx_src/api/modules.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ pomdp_py
:maxdepth: 4

pomdp_py
pomdp_py.problems
10 changes: 0 additions & 10 deletions docs/_sphinx_src/api/pomdp_py.problems.lasertag.rst
View file

This file was deleted.

2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.light_dark.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.light\_dark package
======================================

.. include:: ../../../pomdp_py/problems/light_dark/README.rst

Subpackages
-----------

Expand Down
2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.load_unload.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.load\_unload package
=======================================

.. include:: ../../../pomdp_py/problems/load_unload/README.rst

Submodules
----------

Expand Down
2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.maze.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.maze package
===============================

.. include:: ../../../pomdp_py/problems/maze/README.rst

Subpackages
-----------

Expand Down
2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.multi_object_search.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.multi\_object\_search package
================================================

.. include:: ../../../pomdp_py/problems/multi_object_search/README.rst

Subpackages
-----------

Expand Down
2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.rocksample.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.rocksample package
=====================================

.. include:: ../../../pomdp_py/problems/rocksample/README.rst

Subpackages
-----------

Expand Down
2 changes: 2 additions & 0 deletions docs/_sphinx_src/api/pomdp_py.problems.tiger.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
pomdp\_py.problems.tiger package
================================

.. include:: ../../../pomdp_py/problems/tiger/README.rst

Subpackages
-----------

Expand Down
6 changes: 3 additions & 3 deletions docs/_sphinx_src/building_docs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Building docs for `pomdp_py.problems`

2. Building docs for `pomdp_py`. Run :code:`sphinx-apidoc`::

sphinx-apidoc -o problems/ ../../pomdp_py.problems
sphinx-apidoc -o problems/ ../../pomdp_py/problems

3. Generate web pages::

Expand All @@ -54,13 +54,13 @@ Building docs for `pomdp_py.problems`

Note that when creating the documentation for a problem under :code:`pomdp_py.problems`,
you may want to re-use the README file on github for the documentation. To do that,
first create a read-me file at :code:`pomdp_py.problems/<problem>/README.rst` with desirable
first create a read-me file at :code:`pomdp_py/problems/<problem>/README.rst` with desirable
content that describes the problem. Then, include this read-me file at the top of the
generated :code:`pomdp_py.problems.<problem>.rst`, like so:

.. code-block::
.. include:: ../../../pomdp_py.problems/<problem>/README.rst
.. include:: ../../../pomdp_py/problems/<problem>/README.rst
Note on Changelog
Expand Down
2 changes: 0 additions & 2 deletions docs/_sphinx_src/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ Further
* :doc:`extensions`
* :doc:`other_libraries`
* :doc:`building_docs`
* :doc:`simple_rl_integration`

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -76,7 +75,6 @@ API References
:caption: API References

api/modules
problems/modules

Tools
-----
Expand Down
6 changes: 0 additions & 6 deletions docs/_sphinx_src/simple_rl_integration.rst
View file

This file was deleted.

16 changes: 12 additions & 4 deletions docs/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; pomdp_py 1.3.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
<title>Overview: module code &#8212; pomdp_py 1.3.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=51d35e29" />
<script src="../_static/documentation_options.js?v=e358f374"></script>
<script src="../_static/documentation_options.js?v=4720776d"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
Expand All @@ -34,7 +34,7 @@



<p class="blurb">A framework to build and solve POMDP problems (v1.3.4).</p>
<p class="blurb">A framework to build and solve POMDP problems (v1.3.5).</p>



Expand Down Expand Up @@ -122,6 +122,8 @@ <h1>All modules for which code is available</h1>
<li><a href="pomdp_py/framework/oopomdp.html">pomdp_py.framework.oopomdp</a></li>
<li><a href="pomdp_py/framework/planner.html">pomdp_py.framework.planner</a></li>
<li><a href="pomdp_py/problems/light_dark/env/env.html">pomdp_py.problems.light_dark.env.env</a></li>
<li><a href="pomdp_py/problems/light_dark/env/plotting.html">pomdp_py.problems.light_dark.env.plotting</a></li>
<li><a href="pomdp_py/problems/load_unload/load_unload.html">pomdp_py.problems.load_unload.load_unload</a></li>
<li><a href="pomdp_py/problems/maze/domain/observation.html">pomdp_py.problems.maze.domain.observation</a></li>
<li><a href="pomdp_py/problems/maze/domain/state.html">pomdp_py.problems.maze.domain.state</a></li>
<li><a href="pomdp_py/problems/maze/env/env.html">pomdp_py.problems.maze.env.env</a></li>
Expand All @@ -131,25 +133,31 @@ <h1>All modules for which code is available</h1>
<li><a href="pomdp_py/problems/multi_object_search/domain/observation.html">pomdp_py.problems.multi_object_search.domain.observation</a></li>
<li><a href="pomdp_py/problems/multi_object_search/domain/state.html">pomdp_py.problems.multi_object_search.domain.state</a></li>
<li><a href="pomdp_py/problems/multi_object_search/env/env.html">pomdp_py.problems.multi_object_search.env.env</a></li>
<li><a href="pomdp_py/problems/multi_object_search/env/visual.html">pomdp_py.problems.multi_object_search.env.visual</a></li>
<li><a href="pomdp_py/problems/multi_object_search/example_worlds.html">pomdp_py.problems.multi_object_search.example_worlds</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/components/grid_map.html">pomdp_py.problems.multi_object_search.models.components.grid_map</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/components/sensor.html">pomdp_py.problems.multi_object_search.models.components.sensor</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/observation_model.html">pomdp_py.problems.multi_object_search.models.observation_model</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/policy_model.html">pomdp_py.problems.multi_object_search.models.policy_model</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/reward_model.html">pomdp_py.problems.multi_object_search.models.reward_model</a></li>
<li><a href="pomdp_py/problems/multi_object_search/models/transition_model.html">pomdp_py.problems.multi_object_search.models.transition_model</a></li>
<li><a href="pomdp_py/problems/multi_object_search/problem.html">pomdp_py.problems.multi_object_search.problem</a></li>
<li><a href="pomdp_py/problems/rocksample/cythonize/rocksample_problem.html">pomdp_py.problems.rocksample.cythonize.rocksample_problem</a></li>
<li><a href="pomdp_py/problems/rocksample/rocksample_problem.html">pomdp_py.problems.rocksample.rocksample_problem</a></li>
<li><a href="pomdp_py/problems/tag/agent/agent.html">pomdp_py.problems.tag.agent.agent</a></li>
<li><a href="pomdp_py/problems/tag/domain/action.html">pomdp_py.problems.tag.domain.action</a></li>
<li><a href="pomdp_py/problems/tag/domain/observation.html">pomdp_py.problems.tag.domain.observation</a></li>
<li><a href="pomdp_py/problems/tag/domain/state.html">pomdp_py.problems.tag.domain.state</a></li>
<li><a href="pomdp_py/problems/tag/env/env.html">pomdp_py.problems.tag.env.env</a></li>
<li><a href="pomdp_py/problems/tag/env/visual.html">pomdp_py.problems.tag.env.visual</a></li>
<li><a href="pomdp_py/problems/tag/experiment.html">pomdp_py.problems.tag.experiment</a></li>
<li><a href="pomdp_py/problems/tag/models/components/grid_map.html">pomdp_py.problems.tag.models.components.grid_map</a></li>
<li><a href="pomdp_py/problems/tag/models/components/motion_policy.html">pomdp_py.problems.tag.models.components.motion_policy</a></li>
<li><a href="pomdp_py/problems/tag/models/observation_model.html">pomdp_py.problems.tag.models.observation_model</a></li>
<li><a href="pomdp_py/problems/tag/models/policy_model.html">pomdp_py.problems.tag.models.policy_model</a></li>
<li><a href="pomdp_py/problems/tag/models/reward_model.html">pomdp_py.problems.tag.models.reward_model</a></li>
<li><a href="pomdp_py/problems/tag/models/transition_model.html">pomdp_py.problems.tag.models.transition_model</a></li>
<li><a href="pomdp_py/problems/tag/problem.html">pomdp_py.problems.tag.problem</a></li>
<li><a href="pomdp_py/problems/tiger/cythonize/tiger_problem.html">pomdp_py.problems.tiger.cythonize.tiger_problem</a></li>
<li><a href="pomdp_py/problems/tiger/tiger_problem.html">pomdp_py.problems.tiger.tiger_problem</a></li>
<li><a href="pomdp_py/representations/belief/histogram.html">pomdp_py.representations.belief.histogram</a></li>
Expand Down
22 changes: 12 additions & 10 deletions docs/html/_modules/pomdp_py/algorithms/bsp/blqr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pomdp_py.algorithms.bsp.blqr &#8212; pomdp_py 1.3.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=d1102ebc" />
<title>pomdp_py.algorithms.bsp.blqr &#8212; pomdp_py 1.3.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css?v=51d35e29" />
<script src="../../../../_static/documentation_options.js?v=e358f374"></script>
<script src="../../../../_static/documentation_options.js?v=4720776d"></script>
<script src="../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../../../../_static/favicon.ico"/>
Expand All @@ -34,7 +34,7 @@



<p class="blurb">A framework to build and solve POMDP problems (v1.3.4).</p>
<p class="blurb">A framework to build and solve POMDP problems (v1.3.5).</p>



Expand All @@ -55,10 +55,12 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="../../../../examples.html">Examples</a></li>
<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"><a class="reference internal" href="../../../../changelog.html">What's New?</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../api/modules.html">pomdp_py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../problems/modules.html">problems</a></li>
</ul>


Expand Down Expand Up @@ -124,7 +126,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre


<div class="viewcode-block" id="BLQR">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR">[docs]</a>
<span class="k">class</span> <span class="nc">BLQR</span><span class="p">(</span><span class="n">pomdp_py</span><span class="o">.</span><span class="n">Planner</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
Expand Down Expand Up @@ -187,7 +189,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre
<span class="bp">self</span><span class="o">.</span><span class="n">_dim_control</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_R</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>

<div class="viewcode-block" id="BLQR.ekf_update_mlo">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR.ekf_update_mlo">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR.ekf_update_mlo">[docs]</a>
<span class="k">def</span> <span class="nf">ekf_update_mlo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bt</span><span class="p">,</span> <span class="n">ut</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Performs the ekf belief update assuming maximum likelihood observation.</span>
Expand Down Expand Up @@ -261,7 +263,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre
<span class="k">return</span> <span class="n">b_i_vec</span> <span class="o">-</span> <span class="n">b_ip1_vec</span>

<div class="viewcode-block" id="BLQR.integrate_belief_segment">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR.integrate_belief_segment">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR.integrate_belief_segment">[docs]</a>
<span class="k">def</span> <span class="nf">integrate_belief_segment</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">b_i</span><span class="p">,</span> <span class="n">u_i</span><span class="p">,</span> <span class="n">num_segments</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is to represent equation 18.</span>

Expand Down Expand Up @@ -300,7 +302,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">segmented_cost_function</span><span class="p">(</span><span class="n">bu_traj</span><span class="p">,</span> <span class="n">b_des</span><span class="p">,</span> <span class="n">u_des</span><span class="p">,</span> <span class="n">num_segments</span><span class="p">)</span>

<div class="viewcode-block" id="BLQR.segmented_cost_function">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR.segmented_cost_function">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR.segmented_cost_function">[docs]</a>
<span class="k">def</span> <span class="nf">segmented_cost_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bu_traj</span><span class="p">,</span> <span class="n">b_des</span><span class="p">,</span> <span class="n">u_des</span><span class="p">,</span> <span class="n">num_segments</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The cost function in eq 17.</span>

Expand Down Expand Up @@ -339,7 +341,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre


<div class="viewcode-block" id="BLQR.create_plan">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR.create_plan">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR.create_plan">[docs]</a>
<span class="k">def</span> <span class="nf">create_plan</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">b_0</span><span class="p">,</span>
Expand Down Expand Up @@ -422,7 +424,7 @@ <h1>Source code for pomdp_py.algorithms.bsp.blqr</h1><div class="highlight"><pre


<div class="viewcode-block" id="BLQR.interpret_sqp_plan">
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.html#pomdp_py.algorithms.bsp.blqr.BLQR.interpret_sqp_plan">[docs]</a>
<a class="viewcode-back" href="../../../../api/pomdp_py.algorithms.bsp.html#pomdp_py.algorithms.bsp.blqr.BLQR.interpret_sqp_plan">[docs]</a>
<span class="k">def</span> <span class="nf">interpret_sqp_plan</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">opt_res</span><span class="p">,</span> <span class="n">num_segments</span><span class="p">):</span>
<span class="n">x_res</span> <span class="o">=</span> <span class="n">opt_res</span><span class="o">.</span><span class="n">x</span>
<span class="n">plan</span> <span class="o">=</span> <span class="p">[]</span>
Expand Down
10 changes: 6 additions & 4 deletions docs/html/_modules/pomdp_py/problems/light_dark/env/env.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pomdp_py.problems.light_dark.env.env &#8212; pomdp_py 1.3.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=d1102ebc" />
<title>pomdp_py.problems.light_dark.env.env &#8212; pomdp_py 1.3.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="../../../../../_static/alabaster.css?v=51d35e29" />
<script src="../../../../../_static/documentation_options.js?v=e358f374"></script>
<script src="../../../../../_static/documentation_options.js?v=4720776d"></script>
<script src="../../../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../../../../../_static/favicon.ico"/>
Expand All @@ -34,7 +34,7 @@



<p class="blurb">A framework to build and solve POMDP problems (v1.3.4).</p>
<p class="blurb">A framework to build and solve POMDP problems (v1.3.5).</p>



Expand All @@ -55,10 +55,12 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="../../../../../examples.html">Examples</a></li>
<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"><a class="reference internal" href="../../../../../changelog.html">What's New?</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../api/modules.html">pomdp_py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../problems/modules.html">problems</a></li>
</ul>


Expand Down
Loading

0 comments on commit 0b0c517

Please sign in to comment.