Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gallery: Working example for TagPOMDP #540

Merged
merged 5 commits into from
Jan 30, 2024
Merged

Gallery: Working example for TagPOMDP #540

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84c7868
Updated TagPOMDP gallery example to use PGFPlotsX
dylan-asmar Jan 30, 2024
c786c54
Remove Tag note and added LaserTag example to gallery
dylan-asmar Jan 30, 2024
7f3fc33
updated using statements in gallery examples
dylan-asmar Jan 30, 2024
93f25b9
removed LaserTag example
dylan-asmar Jan 30, 2024
3be7db7
back to GR but adding plots in setup
dylan-asmar Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions docs/src/gallery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ Pkg.add(url="https://github.com/sisl/RoombaPOMDPs.git")
using POMDPs
using POMDPTools
using POMDPGifs
using BasicPOMCP
using Random
using ParticleFilters
using Cairo
using LinearAlgebra
using BasicPOMCP
# If you don't have RoombaPOMDPs installed, uncomment the following two lines
# using Pkg
Expand Down Expand Up @@ -126,11 +127,12 @@ In this problem, the UAV must go from one corner to the other while avoiding a g
![DroneSurveillance](examples/DroneSurveillance.gif)

```@example
using DroneSurveillance
using POMDPs
using NativeSARSOP
using POMDPTools
using POMDPGifs
using NativeSARSOP
using Random
using DroneSurveillance
import Cairo, Fontconfig
pomdp = DroneSurveillancePOMDP()
Expand All @@ -152,8 +154,8 @@ An implementation of the classic Mountain Car RL problem using the QuickPOMDPs i
using POMDPs
using POMDPTools
using POMDPGifs
using QuickPOMDPs
using Random
using QuickPOMDPs
using Compose
import Cairo
Expand Down Expand Up @@ -202,11 +204,12 @@ The robot must navigate and sample good rocks (green) and then arrive at an exit

```@example
using POMDPs
using RockSample
using POMDPTools
using POMDPGifs
using NativeSARSOP
using POMDPGifs
using Cairo
using Random
using RockSample
using Cairo
pomdp = RockSamplePOMDP(rocks_positions=[(2,3), (4,4), (4,2)],
sensor_efficiency=20.0,
Expand All @@ -229,12 +232,19 @@ The orange agent is the pursuer and the red agent is the evader. The pursuer mus

![TagPOMDPProblem](examples/TagPOMDP.gif)

```julia
```@setup TagPOMDP
using Pkg
Pkg.add("Plots")
using Plots
```

```@example TagPOMDP
using POMDPs
using TagPOMDPProblem
using NativeSARSOP
using POMDPTools
using POMDPGifs
using NativeSARSOP
using Random
using TagPOMDPProblem
pomdp = TagPOMDP()
solver = SARSOPSolver(; max_time=20.0)
Expand All @@ -245,8 +255,10 @@ saved_gif = simulate(sim, pomdp, policy)
println("gif saved to: $(saved_gif.filename)")
```

!!! note
This gif was **not** generated at documentation build time because of GR errors with Github Actions ([Plots.jl issue 4764](https://github.com/JuliaPlots/Plots.jl/issues/4764)).
```@setup TagPOMDP
using Pkg
Pkg.rm("Plots")
```

## Adding New Gallery Examples
To add new examples, please submit a pull request to the POMDPs.jl repository with changes made to the `gallery.md` file in `docs/src/`. Please include the creation of a gif in the code snippet. The gif should be generated during the creation of the documenation using `@eval` and saved in the `docs/src/examples/` directory. The gif should be named `problem_name.gif` where `problem_name` is the name of the problem. The gif can then be included using `![problem_name](examples/problem_name.gif)`.
Loading