Skip to content

Commit df96cb5

Browse files
committed
talked about POMDPTools in README and updated POMDPTools index
1 parent 3b3e456 commit df96cb5

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@
1010
[![Slack](https://img.shields.io/badge/Chat%20on%20Slack-with%20%23pomdp--bridged-ff69b4)](https://slackinvite.julialang.org)
1111

1212
This package provides a core interface for working with [Markov decision processes (MDPs)](https://en.wikipedia.org/wiki/Markov_decision_process) and [partially observable Markov decision processes (POMDPs)](https://en.wikipedia.org/wiki/Partially_observable_Markov_decision_process).
13+
The [POMDPTools](https://juliapomdp.github.io/POMDPs.jl/stable/POMDPTools/#pomdptools_section) package acts as a "standard library" for the POMPDs.jl interface, providing implementations of commonly-used components such as policies, belief updaters, distributions, and simulators.
1314

1415
Our goal is to provide a common programming vocabulary for:
1516
1. [Expressing problems as MDPs and POMDPs](http://juliapomdp.github.io/POMDPs.jl/stable/def_pomdp).
1617
2. Writing solver software.
1718
3. Running simulations efficiently.
1819

1920
POMDPs.jl integrates with other ecosystems:
20-
- The [POMDPModelTools package](https://github.com/JuliaPOMDP/POMDPModelTools.jl) provides [two-way integration](https://juliapomdp.github.io/POMDPModelTools.jl/stable/common_rl/#CommonRLInterface-Integration) with [CommonRLInterface](https://github.com/JuliaReinforcementLearning/CommonRLInterface.jl) and therefore with the [JuliaReinforcementLearning packages](https://github.com/JuliaReinforcementLearning/ReinforcementLearning.jl).
2121
- Python can be used to define and solve MDPs and POMDPs via the [quickpomdps](https://github.com/JuliaPOMDP/quickpomdps) package or through tables directly via [pyjulia](https://github.com/JuliaPy/pyjulia).
22+
- POMDPTools provides [two-way integration](https://juliapomdp.github.io/POMDPModelTools.jl/stable/common_rl/#CommonRLInterface-Integration) with [CommonRLInterface](https://github.com/JuliaReinforcementLearning/CommonRLInterface.jl) and therefore with the [JuliaReinforcementLearning packages](https://github.com/JuliaReinforcementLearning/ReinforcementLearning.jl).
2223
- The [SymbolicMDPs package](https://github.com/JuliaPlanners/SymbolicMDPs.jl) provides an interface to work with PDDL models.
2324

2425
For a detailed introduction, check out our [Julia Academy course](https://juliaacademy.com/p/decision-making-under-uncertainty-with-pomdps-jl)! For help, please post in [GitHub Discussions tab](https://github.com/JuliaPOMDP/POMDPs.jl/discussions). We welcome contributions from anyone! See [CONTRIBUTING.md](/CONTRIBUTING.md) for information about contributing.
@@ -100,11 +101,11 @@ Several tutorials are hosted in the [POMDPExamples repository](https://github.co
100101

101102
## Supported Packages
102103

103-
Many packages use the POMDPs.jl interface, including MDP and POMDP solvers, support tools, and extensions to the POMDPs.jl interface. POMDPs.jl and all packages in the JuliaPOMDP project are fully supported on Linux and OS X. Windows is supported for all native solvers\*, and most non-native solvers should work, but may require additional configuration.
104+
Many packages use the POMDPs.jl interface, including MDP and POMDP solvers, support tools, and extensions to the POMDPs.jl interface. POMDPs.jl and all packages in the JuliaPOMDP project are fully supported on Linux. OSX and Windows are supported for all native solvers\*, and most non-native solvers should work, but may require additional configuration.
104105

105106
#### Tools:
106107

107-
POMDPs.jl itself contains only the core interface for communicating about problem definitions. Most of the functionality for interacting with problems is actually contained in several support tools packages:
108+
POMDPs.jl itself contains only the core interface for communicating about problem definitions; these packages contain implementations of commonly-used components:
108109

109110
| **`Package`** | **`Build`** | **`Coverage`** |
110111
|-------------------|----------------------|------------------|

docs/src/POMDPTools/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
The POMDPs.jl package does nothing more than define an *interface* or *language* 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 [standard library](https://en.wikipedia.org/wiki/Standard_library).
44

5+
The POMDPTools package source code is hosted in [the POMDPs.jl github repository in the `lib/POMDPTools` directory](https://github.com/JuliaPOMDP/POMDPs.jl/tree/master/lib/POMDPTools).
6+
57
The contents of the library are outlined below:
68

79
```@contents
8-
Pages = ["distributions.md", "beliefs.md"]
10+
Pages = ["distributions.md", "model.md", "visualization.md", "beliefs.md", "policies.md", "simulators.md", "common_rl.md", "testing.md"]
911
```

0 commit comments

Comments
 (0)