Skip to content

Commit

Permalink
add lightbox for doc images
Browse files Browse the repository at this point in the history
  • Loading branch information
joseph-jnl committed Jan 31, 2025
1 parent 39aaa30 commit fb63277
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ jobs:
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material mkdocstrings-python
- run: pip install mkdocs-material mkdocstrings-python mkdocs-glightbox
- run: mkdocs gh-deploy --force
5 changes: 5 additions & 0 deletions docs/chap3_finite_mdps.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Finite Markov Decision Processes

## Figure 3.2 Random Gridworld
Recreate the following experiments using the cli command below:
```bash
python run.py
```
Expand All @@ -8,6 +10,8 @@ python run.py
Figure 3.2: State-value function for a random policy (equal probability for all directions). Config uses this example as a default.
///

## Figure 3.8 Optimal Gridworld
Recreate the following experiments using the cli command below:
```bash
python run.py grid=example_3_8_optimal_grid plots=example_3_8_optimal_grid
```
Expand All @@ -16,6 +20,7 @@ python run.py grid=example_3_8_optimal_grid plots=example_3_8_optimal_grid
Figure 3.5: Optimal state-value function and policy for a gridworld.
///

## Arbitrary Example
```bash
python run.py grid.n_rows=10 grid.n_cols=10 grid.special_states=[[0,0,8,1],[1,3,7,9]] grid.special_states_prime=[[4,2,1,8],[1,3,7,1]] grid.special_states_rewards=[10,5,8,15] plots.policy=true
```
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ plugins:
options:
heading_level: 2
show_root_heading: true
- glightbox

markdown_extensions:
- pymdownx.blocks.caption
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,5 @@ dev = [
"ruff>=0.8.0",
"mkdocs-material>=9.5.50",
"mkdocstrings-python>=1.13.0",
"mkdocs-glightbox>=0.4.0",
]
11 changes: 11 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fb63277

Please sign in to comment.