Skip to content

Commit 0270cef

Browse files
committed
automala ref in docs
1 parent e4cebd6 commit 0270cef

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

docs/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@
55
From the root of the Pigeons repo:
66

77
```
8-
julia
9-
include("docs/make.jl")
8+
$ julia
9+
julia> include("docs/make.jl")
10+
```
11+
12+
To view the generated website, use LiveServer (but don't add it to the Project file)
13+
```julia
14+
using LiveServer
15+
serve(dir="docs/build")
1016
```
1117

1218
If the documentation build hangs (https://github.com/Julia-Tempering/Pigeons.jl/issues/60)
@@ -17,4 +23,4 @@ a workaround is the following:
1723

1824
## Generating a single page
1925

20-
See `docs/toggle.jl`.
26+
See `docs/toggle.jl`.

docs/src/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ of the following algorithms:
1717
- Non-Reversible Parallel Tempering (NRPT),
1818
[Syed et al., 2021](https://rss.onlinelibrary.wiley.com/doi/10.1111/rssb.12464).
1919
- Variational PT, [Surjanovic et al., 2022](https://arxiv.org/abs/2206.00080).
20+
- autoMALA, [Biron-Lattes et al., 2023](https://arxiv.org/abs/2310.16782).
2021

2122
These algorithms achieve state-of-the-art performance for approximation
2223
of challenging probability distributions.
@@ -146,4 +147,4 @@ citing our work by referring to [our Pigeons paper](https://arxiv.org/abs/2308.0
146147

147148
**APA**
148149

149-
Surjanovic, N., Biron-Lattes, M., Tiede, P., Syed, S., Campbell, T., & Bouchard-Côté, A. (2023). Pigeons.jl: Distributed sampling from intractable distributions. *arXiv:2308.09769.*
150+
Surjanovic, N., Biron-Lattes, M., Tiede, P., Syed, S., Campbell, T., & Bouchard-Côté, A. (2023). Pigeons.jl: Distributed sampling from intractable distributions. *arXiv:2308.09769.*

docs/src/input-stan.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Notice that we have specified a reference distribution, in this case the same mo
4949
no observations (hence the prior). This needs to be done with Stan targets because it is
5050
not possible to automatically extract a prior from a .stan file.
5151

52-
For a [`StanLogPotential`](@ref), the [`default_explorer()`](@ref) is [`AutoMALA`](@ref).
52+
For a [`StanLogPotential`](@ref), the [`default_explorer()`](@ref) is [`AutoMALA`](@ref)[^1].
5353

5454

5555

@@ -106,4 +106,7 @@ samples
106106
<iframe src="../stan_posterior_densities_and_traces.html" style="height:500px;width:100%;"></iframe>
107107
```
108108

109+
[^1]: Biron-Lattes, M., Surjanovic, N., Syed, S., Campbell, T., and Bouchard-Côté, A.
110+
(2023). autoMALA: Locally adaptive Metropolis-adjusted Langevin algorithm. *Accepted
111+
for AISTATS 2024*. [arXiv:2310.16782](https://arxiv.org/abs/2310.16782).
109112

src/explorers/AutoMALA.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ condition the problem.
2020
In normal circumstance, there should not be a need for tuning,
2121
however the following optional keyword parameters are available:
2222
$FIELDS
23+
24+
Reference: Biron-Lattes, M., Surjanovic, N., Syed, S., Campbell, T., and Bouchard-Côté, A.
25+
(2023). autoMALA: Locally adaptive Metropolis-adjusted Langevin algorithm. *Accepted
26+
for AISTATS 2024*. [arXiv:2310.16782](https://arxiv.org/abs/2310.16782).
2327
"""
2428
@kwdef struct AutoMALA{T,TPrec <: Preconditioner}
2529
"""

0 commit comments

Comments
 (0)