-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Mar 23, 2024
1 parent
33526b5
commit 118d421
Showing
54 changed files
with
5,522 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-23T21:21:27","documenter_version":"1.3.0"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>POMDPTools: the standard library for POMDPs.jl · POMDPs.jl</title><meta name="title" content="POMDPTools: the standard library for POMDPs.jl · POMDPs.jl"/><meta property="og:title" content="POMDPTools: the standard library for POMDPs.jl · POMDPs.jl"/><meta property="twitter:title" content="POMDPTools: the standard library for POMDPs.jl · POMDPs.jl"/><meta name="description" content="Documentation for POMDPs.jl."/><meta property="og:description" content="Documentation for POMDPs.jl."/><meta property="twitter:description" content="Documentation for POMDPs.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="POMDPs.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">POMDPs.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><span class="tocitem">Basics</span><ul><li><a class="tocitem" href="../">POMDPs.jl</a></li><li><a class="tocitem" href="../install/">Installation</a></li><li><a class="tocitem" href="../get_started/">Getting Started</a></li><li><a class="tocitem" href="../concepts/">Concepts and Architecture</a></li></ul></li><li><span class="tocitem">Defining (PO)MDP Models</span><ul><li><a class="tocitem" href="../def_pomdp/">Defining POMDPs and MDPs</a></li><li><a class="tocitem" href="../interfaces/">Spaces and Distributions</a></li></ul></li><li><span class="tocitem">Writing Solvers</span><ul><li><a class="tocitem" href="../def_solver/">Solvers</a></li><li><a class="tocitem" href="../offline_solver/">Example: Defining an offline solver</a></li><li><a class="tocitem" href="../online_solver/">Example: Defining an online solver</a></li></ul></li><li><span class="tocitem">Writing Belief Updaters</span><ul><li><a class="tocitem" href="../def_updater/">Defining a Belief Updater</a></li></ul></li><li><span class="tocitem">Analyzing Results</span><ul><li><a class="tocitem" href="../simulation/">Simulation Standard</a></li><li><a class="tocitem" href="../run_simulation/">Running Simulations</a></li><li><a class="tocitem" href="../policy_interaction/">Interacting with Policies</a></li></ul></li><li><span class="tocitem">Examples and Gallery</span><ul><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../example_defining_problems/">Defining a POMDP</a></li><li><a class="tocitem" href="../example_solvers/">Using Different Solvers</a></li><li><a class="tocitem" href="../example_simulations/">Simulations Examples</a></li><li><a class="tocitem" href="../example_gridworld_mdp/">GridWorld MDP Tutorial</a></li><li><a class="tocitem" href="../gallery/">Gallery of POMDPs.jl Problems</a></li></ul></li><li><span class="tocitem">POMDPTools</span><ul><li class="is-active"><a class="tocitem" href>POMDPTools: the standard library for POMDPs.jl</a></li><li><a class="tocitem" href="distributions/">Implemented Distributions</a></li><li><a class="tocitem" href="model/">Model Tools</a></li><li><a class="tocitem" href="visualization/">Visualization</a></li><li><a class="tocitem" href="beliefs/">Implemented Belief Updaters</a></li><li><a class="tocitem" href="policies/">Implemented Policies</a></li><li><a class="tocitem" href="simulators/">Implemented Simulators</a></li><li><a class="tocitem" href="common_rl/">CommonRLInterface Integration</a></li><li><a class="tocitem" href="testing/">Testing</a></li></ul></li><li><a class="tocitem" href="../faq/">Frequently Asked Questions (FAQ)</a></li><li><a class="tocitem" href="../api/">API Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">POMDPTools</a></li><li class="is-active"><a href>POMDPTools: the standard library for POMDPs.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>POMDPTools: the standard library for POMDPs.jl</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaPOMDP/POMDPs.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaPOMDP/POMDPs.jl/blob/master/docs/src/POMDPTools/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="pomdptools_section"><a class="docs-heading-anchor" href="#pomdptools_section">POMDPTools: the standard library for POMDPs.jl</a><a id="pomdptools_section-1"></a><a class="docs-heading-anchor-permalink" href="#pomdptools_section" title="Permalink"></a></h1><p>The POMDPs.jl package does nothing more than define an <em>interface</em> or <em>language</em> for interacting with and solving (PO)MDPs; it does not contain any implementations. In practice, defining and solving POMDPs is made vastly easier if some commonly-used structures are provided. The POMDPTools package contains these implementations. Thus, the relationship between POMDPs.jl and POMDPTools is similar to the relationship between a programming language and its <a href="https://en.wikipedia.org/wiki/Standard_library">standard library</a>.</p><p>The POMDPTools package source code is hosted in <a href="https://github.com/JuliaPOMDP/POMDPs.jl/tree/master/lib/POMDPTools">the POMDPs.jl github repository in the <code>lib/POMDPTools</code> directory</a>.</p><p>The contents of the library are outlined below:</p><ul><li><a href="distributions/#Implemented-Distributions">Implemented Distributions</a></li><li class="no-marker"><ul><li><a href="distributions/#Sparse-Categorical-(SparseCat)">Sparse Categorical (<code>SparseCat</code>)</a></li><li><a href="distributions/#Implicit">Implicit</a></li><li><a href="distributions/#Bool-Distribution">Bool Distribution</a></li><li><a href="distributions/#Deterministic">Deterministic</a></li><li><a href="distributions/#Uniform">Uniform</a></li><li><a href="distributions/#Pretty-Printing">Pretty Printing</a></li></ul></li><li><a href="model/#Model-Tools">Model Tools</a></li><li class="no-marker"><ul><li><a href="model/#Interface-Extensions">Interface Extensions</a></li><li><a href="model/#Model-Transformations">Model Transformations</a></li><li><a href="model/#Utility-Types">Utility Types</a></li></ul></li><li><a href="visualization/#Visualization">Visualization</a></li><li><a href="beliefs/#Implemented-Belief-Updaters">Implemented Belief Updaters</a></li><li class="no-marker"><ul><li><a href="beliefs/#Discrete-(Bayesian-Filter)">Discrete (Bayesian Filter)</a></li><li><a href="beliefs/#K-Previous-Observations">K Previous Observations</a></li><li><a href="beliefs/#Previous-Observation">Previous Observation</a></li><li><a href="beliefs/#Nothing-Updater">Nothing Updater</a></li></ul></li><li><a href="policies/#Implemented-Policies">Implemented Policies</a></li><li class="no-marker"><ul><li><a href="policies/#Function">Function</a></li><li><a href="policies/#Alpha-Vector-Policy">Alpha Vector Policy</a></li><li><a href="policies/#Random-Policy">Random Policy</a></li><li><a href="policies/#Stochastic-Policies">Stochastic Policies</a></li><li><a href="policies/#Vector-Policies">Vector Policies</a></li><li><a href="policies/#Value-Dict-Policy">Value Dict Policy</a></li><li><a href="policies/#Exploration-Policies">Exploration Policies</a></li><li><a href="policies/#Playback-Policy">Playback Policy</a></li><li><a href="policies/#Utility-Wrapper">Utility Wrapper</a></li><li><a href="policies/#Pretty-Printing-Policies">Pretty Printing Policies</a></li></ul></li><li><a href="policies/#Policy-Evaluation">Policy Evaluation</a></li><li><a href="simulators/#Implemented-Simulators">Implemented Simulators</a></li><li class="no-marker"><ul><li><a href="simulators/#which_simulator">Which Simulator Should I Use?</a></li><li><a href="simulators/#Stepping-through">Stepping through</a></li><li><a href="simulators/#Rollouts">Rollouts</a></li><li><a href="simulators/#History-Recorder">History Recorder</a></li><li><a href="simulators/#sim-function"><code>sim()</code></a></li><li><a href="simulators/#Histories">Histories</a></li><li><a href="simulators/#Parallel">Parallel</a></li><li><a href="simulators/#Display">Display</a></li></ul></li><li><a href="common_rl/#CommonRLInterface-Integration">CommonRLInterface Integration</a></li><li class="no-marker"><ul><li><a href="common_rl/#Environment-Wrapper-Types">Environment Wrapper Types</a></li><li><a href="common_rl/#Constructors">Constructors</a></li></ul></li><li><a href="testing/#Testing">Testing</a></li><li class="no-marker"><ul><li><a href="testing/#Testing-(PO)MDP-Models">Testing (PO)MDP Models</a></li><li><a href="testing/#Testing-Solvers">Testing Solvers</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../gallery/">« Gallery of POMDPs.jl Problems</a><a class="docs-footer-nextpage" href="distributions/">Implemented Distributions »</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="auto">Automatic (OS)</option><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 1.3.0 on <span class="colophon-date" title="Saturday 23 March 2024 21:21">Saturday 23 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.