Skip to content

Commit df59f26

Browse files
committed
docs html update
1 parent b231235 commit df59f26

16 files changed

+70
-65
lines changed

docs/_sphinx_src/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,6 @@
102102

103103
# Do not sort automodule classes alphebatically but by how they appear in source.
104104
autodoc_member_order = 'bysource'
105+
106+
# bibtex file
107+
bibtex_bibfiles = ['refs.bib']

docs/html/_sources/examples.tiger.rst.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ For the Tiger problem, we implemented this procedure as follows:
386386
print("True state:", tiger_problem.env.state)
387387
print("Belief:", tiger_problem.agent.cur_belief)
388388
print("Action:", action)
389-
# Step 3; no transition since actions in Tiger problem
389+
# Step 3; There is no state transition for the tiger domain.
390390
# In general, the ennvironment state can be transitioned
391391
# using
392392
#
@@ -402,10 +402,9 @@ For the Tiger problem, we implemented this procedure as follows:
402402
403403
# Step 4
404404
# Let's create some simulated real observation;
405-
# Update the belief Creating true observation for
406-
# sanity checking solver behavior. In general, this
407-
# observation should be sampled from agent's observation
408-
# model, as
405+
# Here, we use observation based on true state for sanity
406+
# checking solver behavior. In general, this observation
407+
# should be sampled from agent's observation model, as
409408
#
410409
# real_observation = tiger_problem.agent.observation_model.sample(tiger_problem.env.state, action)
411410
#
@@ -416,6 +415,8 @@ For the Tiger problem, we implemented this procedure as follows:
416415
print(">> Observation: %s" % real_observation)
417416
418417
# Step 5
418+
# Update the belief. If the planner is POMCP, planner.update
419+
# also automatically updates agent belief.
419420
tiger_problem.agent.update_history(action, real_observation)
420421
planner.update(tiger_problem.agent, action, real_observation)
421422
if isinstance(planner, pomdp_py.POUCT):

docs/html/api/pomdp_py.algorithms.bsp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
136136
<section id="module-pomdp_py.algorithms.bsp.blqr">
137137
<span id="pomdp-py-algorithms-bsp-blqr-module"></span><h2>pomdp_py.algorithms.bsp.blqr module<a class="headerlink" href="#module-pomdp_py.algorithms.bsp.blqr" title="Permalink to this headline"></a></h2>
138138
<p>Implementation of B-LQR algorithm described in “Belief space planning
139-
assuming maximum likelihood observations” <a class="bibtex reference internal" href="pomdp_py.algorithms.html#platt2010belief" id="id1">[2]</a></p>
139+
assuming maximum likelihood observations” <span id="id1">[<a class="reference internal" href="pomdp_py.algorithms.html#id43" title="R. Platt, R. Tedrake, L. Kaelbling, and T. Lozano-Perez. Belief space planning assuming maximum likelihood observations. In Proceedings of Robotics: Science and Systems. Zaragoza, Spain, June 2010. doi:10.15607/RSS.2010.VI.037.">4</a>]</span></p>
140140
<dl class="py class">
141141
<dt class="sig sig-object py" id="pomdp_py.algorithms.bsp.blqr.BLQR">
142142
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pomdp_py.algorithms.bsp.blqr.</span></span><span class="sig-name descname"><span class="pre">BLQR</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func_sysd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jac_sysd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jac_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jac_sysd_u</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise_obs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise_sysd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Qlarge</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">R</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">planning_horizon</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pomdp_py/algorithms/bsp/blqr.html#BLQR"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pomdp_py.algorithms.bsp.blqr.BLQR" title="Permalink to this definition"></a></dt>

0 commit comments

Comments
 (0)