Skip to content

Commit

Permalink
updated references to POMDPExamples.jl and POMDPGallery.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
dylan-asmar committed Jan 27, 2024
1 parent 630b5b7 commit 438464a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 18 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,15 @@ end
println("Undiscounted reward was $rsum.")
```

For more examples with visualization, see the documentation below and [POMDPGallery.jl](https://github.com/JuliaPOMDP/POMDPGallery.jl).
For more examples and examples with visualizations, reference the [Examples](https://JuliaPOMDP.github.io/POMDPs.jl/latest/examples) and [Gallery of POMDPs.jl Problems](https://JuliaPOMDP.github.io/POMDPs.jl/latest/gallery) sections of the documentaiton.

## Documentation and Tutorials

In addition to the above-mentioned [Julia Academy course](https://juliaacademy.com/p/decision-making-under-uncertainty-with-pomdps-jl), detailed documentation can be found [here](http://juliapomdp.github.io/POMDPs.jl/stable/).
In addition to the above-mentioned [Julia Academy course](https://juliaacademy.com/p/decision-making-under-uncertainty-with-pomdps-jl), detailed documentation and examples can be found [here](http://juliapomdp.github.io/POMDPs.jl/stable/).

[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaPOMDP.github.io/POMDPs.jl/stable)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaPOMDP.github.io/POMDPs.jl/latest)

Several tutorials are hosted in the [POMDPExamples repository](https://github.com/JuliaPOMDP/POMDPExamples.jl).


## Supported Packages

Expand Down
14 changes: 2 additions & 12 deletions docs/src/POMDPTools/simulators.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

POMDPTools contains a collection of POMDPs.jl simulators.

Usage examples can be found in the [simulation tutorial in the POMDPExamples package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
Usage examples can be found in the [Simulations Examples](@ref) section.

If you are just getting started, probably the easiest way to begin is the [`stepthrough` function](@ref Stepping-through). Otherwise, consult the [Which Simulator Should I Use?](@ref which_simulator) guide below:

Expand Down Expand Up @@ -51,8 +51,6 @@ for (s, a, o, r) in stepthrough(pomdp, policy, "s,a,o,r", max_steps=10)
end
```

More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).

```@docs
stepthrough
```
Expand All @@ -77,8 +75,6 @@ policy = RandomPolicy(mdp)
r = simulate(rs, mdp, policy)
```

More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)

```@docs
RolloutSimulator
```
Expand All @@ -95,8 +91,6 @@ policy = RandomPolicy(pomdp)
h = simulate(hr, pomdp, policy)
```

More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).

```@docs
HistoryRecorder
```
Expand All @@ -116,10 +110,6 @@ This allows a flexible and general way to interact with a POMDP environment with

In the POMDP case, an updater can optionally be supplied as an additional positional argument if the policy function works with beliefs rather than directly with observations.

More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)

More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)

```@docs
sim
```
Expand Down Expand Up @@ -197,7 +187,7 @@ POMDPTools contains a utility for running many Monte Carlo simulations in parall

### Example

An example can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
An example can be found in the [Parallel Simulations](@ref) section.

### Sim objects

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The list of solver and support packages maintained by the [JuliaPOMDP](https://g

Documentation comes in three forms:
1. An explanatory guide is available in the sections outlined below.
2. How-to examples are available in pages in this document with "Example" in the title and in the [POMDPExamples package](https://github.com/JuliaPOMDP/POMDPExamples.jl).
2. How-to examples are available throughout this documentation with specicic examples in [Examples](@ref examples_section) and [Gallery of POMDPs.jl Problems](@ref).
3. Reference docstrings for the entire POMDPs.jl interface are available in the [API Documentation](@ref) section.

!!! note
Expand Down
2 changes: 1 addition & 1 deletion docs/src/run_simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ r = simulate(sim, m, p)

More inputs, such as a belief updater, initial state, initial belief, etc. may be specified as arguments to [`simulate`](@ref). See the docstring for [`simulate`](@ref) and the appropriate "Input" sections in the [Simulation Standard](@ref) page for more information.

More examples can be found in the [POMDPExamples package](https://github.com/JuliaPOMDP/POMDPExamples.jl). A variety of simulators that return more information and interact in different ways can be found in [POMDPTools](@ref pomdptools_section).
More examples can be found in the [Simulations Examples](@ref) section. A variety of simulators that return more information and interact in different ways can be found in [POMDPTools](@ref pomdptools_section).

0 comments on commit 438464a

Please sign in to comment.