Skip to content

Commit

Permalink
build based on a381ab0
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 16, 2023
1 parent 35deed8 commit 42d0d94
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/discrete_explicit/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@
end
end

m = DiscreteExplicitPOMDP(S,A,O,T,Z,R,γ)</code></pre><h2 id="Constructor-Documentation"><a class="docs-heading-anchor" href="#Constructor-Documentation">Constructor Documentation</a><a id="Constructor-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Constructor-Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="QuickPOMDPs.DiscreteExplicitMDP" href="#QuickPOMDPs.DiscreteExplicitMDP"><code>QuickPOMDPs.DiscreteExplicitMDP</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DiscreteExplicitMDP(S,A,T,R,γ,[p₀],[terminals=Set()])</code></pre><p>Create an MDP defined by the tuple (S,A,T,R,γ).</p><p><strong>Arguments</strong></p><p><strong>Required</strong></p><ul><li><code>S</code>,<code>A</code>: State and action spaces (typically <code>Vector</code>s)</li><li><code>T::Function</code>: Transition probability distribution function; <span>$T(s,a,s&#39;)$</span> is the probability of transitioning to state <span>$s&#39;$</span> from state <span>$s$</span> after taking action <span>$a$</span>.</li><li><code>R::Function</code>: Reward function; <span>$R(s,a)$</span> is the reward for taking action <span>$a$</span> in state <span>$s$</span>.</li><li><code>γ::Float64</code>: Discount factor.</li></ul><p><strong>Optional</strong></p><ul><li><code>p₀=Uniform(S)</code>: Initial state distribution (See <code>POMDPModelTools.Deterministic</code> and <code>POMDPModelTools.SparseCat</code> for other options).</li></ul><p><strong>Keyword</strong></p><ul><li><code>terminals=Set()</code>: Set of terminal states. Once a terminal state is reached, no more actions can be taken or reward received.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/094eee5bb2e4c2cb532862d7f20f5710d6db65e7/src/discrete_explicit.jl#L117-L135">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="QuickPOMDPs.DiscreteExplicitPOMDP" href="#QuickPOMDPs.DiscreteExplicitPOMDP"><code>QuickPOMDPs.DiscreteExplicitPOMDP</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DiscreteExplicitPOMDP(S,A,O,T,Z,R,γ,[b₀],[terminals=Set()])</code></pre><p>Create a POMDP defined by the tuple (S,A,O,T,Z,R,γ).</p><p><strong>Arguments</strong></p><p><strong>Required</strong></p><ul><li><code>S</code>,<code>A</code>,<code>O</code>: State, action, and observation spaces (typically <code>Vector</code>s)</li><li><code>T::Function</code>: Transition probability distribution function; <span>$T(s,a,s&#39;)$</span> is the probability of transitioning to state <span>$s&#39;$</span> from state <span>$s$</span> after taking action <span>$a$</span>.</li><li><code>Z::Function</code>: Observation probability distribution function; <span>$O(a, s&#39;, o)$</span> is the probability of receiving observation <span>$o$</span> when state <span>$s&#39;$</span> is reached after action <span>$a$</span>.</li><li><code>R::Function</code>: Reward function; <span>$R(s,a)$</span> is the reward for taking action <span>$a$</span> in state <span>$s$</span>.</li><li><code>γ::Float64</code>: Discount factor.</li></ul><p><strong>Optional</strong></p><ul><li><code>b₀=Uniform(S)</code>: Initial belief/state distribution (See <code>POMDPModelTools.Deterministic</code> and <code>POMDPModelTools.SparseCat</code> for other options).</li></ul><p><strong>Keyword</strong></p><ul><li><code>terminals=Set()</code>: Set of terminal states. Once a terminal state is reached, no more actions can be taken or reward received.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/094eee5bb2e4c2cb532862d7f20f5710d6db65e7/src/discrete_explicit.jl#L55-L74">source</a></section></article><h2 id="Usage-from-Python"><a class="docs-heading-anchor" href="#Usage-from-Python">Usage from Python</a><a id="Usage-from-Python-1"></a><a class="docs-heading-anchor-permalink" href="#Usage-from-Python" title="Permalink"></a></h2><p>The Discrete Explicit interface can be used from python via <a href="https://github.com/JuliaPy/pyjulia">pyjulia</a>. See <a href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/master/examples/tiger.py">examples/tiger.py</a> for an example.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quick/">« Quick Interface</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 16 December 2023 16:11">Saturday 16 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
m = DiscreteExplicitPOMDP(S,A,O,T,Z,R,γ)</code></pre><h2 id="Constructor-Documentation"><a class="docs-heading-anchor" href="#Constructor-Documentation">Constructor Documentation</a><a id="Constructor-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Constructor-Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="QuickPOMDPs.DiscreteExplicitMDP" href="#QuickPOMDPs.DiscreteExplicitMDP"><code>QuickPOMDPs.DiscreteExplicitMDP</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DiscreteExplicitMDP(S,A,T,R,γ,[p₀],[terminals=Set()])</code></pre><p>Create an MDP defined by the tuple (S,A,T,R,γ).</p><p><strong>Arguments</strong></p><p><strong>Required</strong></p><ul><li><code>S</code>,<code>A</code>: State and action spaces (typically <code>Vector</code>s)</li><li><code>T::Function</code>: Transition probability distribution function; <span>$T(s,a,s&#39;)$</span> is the probability of transitioning to state <span>$s&#39;$</span> from state <span>$s$</span> after taking action <span>$a$</span>.</li><li><code>R::Function</code>: Reward function; <span>$R(s,a)$</span> is the reward for taking action <span>$a$</span> in state <span>$s$</span>.</li><li><code>γ::Float64</code>: Discount factor.</li></ul><p><strong>Optional</strong></p><ul><li><code>p₀=Uniform(S)</code>: Initial state distribution (See <code>POMDPModelTools.Deterministic</code> and <code>POMDPModelTools.SparseCat</code> for other options).</li></ul><p><strong>Keyword</strong></p><ul><li><code>terminals=Set()</code>: Set of terminal states. Once a terminal state is reached, no more actions can be taken or reward received.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/a381ab0d1af19174603db01145895dd589bce32f/src/discrete_explicit.jl#L117-L135">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="QuickPOMDPs.DiscreteExplicitPOMDP" href="#QuickPOMDPs.DiscreteExplicitPOMDP"><code>QuickPOMDPs.DiscreteExplicitPOMDP</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DiscreteExplicitPOMDP(S,A,O,T,Z,R,γ,[b₀],[terminals=Set()])</code></pre><p>Create a POMDP defined by the tuple (S,A,O,T,Z,R,γ).</p><p><strong>Arguments</strong></p><p><strong>Required</strong></p><ul><li><code>S</code>,<code>A</code>,<code>O</code>: State, action, and observation spaces (typically <code>Vector</code>s)</li><li><code>T::Function</code>: Transition probability distribution function; <span>$T(s,a,s&#39;)$</span> is the probability of transitioning to state <span>$s&#39;$</span> from state <span>$s$</span> after taking action <span>$a$</span>.</li><li><code>Z::Function</code>: Observation probability distribution function; <span>$O(a, s&#39;, o)$</span> is the probability of receiving observation <span>$o$</span> when state <span>$s&#39;$</span> is reached after action <span>$a$</span>.</li><li><code>R::Function</code>: Reward function; <span>$R(s,a)$</span> is the reward for taking action <span>$a$</span> in state <span>$s$</span>.</li><li><code>γ::Float64</code>: Discount factor.</li></ul><p><strong>Optional</strong></p><ul><li><code>b₀=Uniform(S)</code>: Initial belief/state distribution (See <code>POMDPModelTools.Deterministic</code> and <code>POMDPModelTools.SparseCat</code> for other options).</li></ul><p><strong>Keyword</strong></p><ul><li><code>terminals=Set()</code>: Set of terminal states. Once a terminal state is reached, no more actions can be taken or reward received.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/a381ab0d1af19174603db01145895dd589bce32f/src/discrete_explicit.jl#L55-L74">source</a></section></article><h2 id="Usage-from-Python"><a class="docs-heading-anchor" href="#Usage-from-Python">Usage from Python</a><a id="Usage-from-Python-1"></a><a class="docs-heading-anchor-permalink" href="#Usage-from-Python" title="Permalink"></a></h2><p>The Discrete Explicit interface can be used from python via <a href="https://github.com/JuliaPy/pyjulia">pyjulia</a>. See <a href="https://github.com/JuliaPOMDP/QuickPOMDPs.jl/blob/master/examples/tiger.py">examples/tiger.py</a> for an example.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../quick/">« Quick Interface</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 16 December 2023 17:00">Saturday 16 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 42d0d94

Please sign in to comment.