Merge pull request #208 from alecloudenback/patch-1

Note what PT stands for
Julia-Tempering · Feb 17, 2024 · 764af10 · 764af10
2 parents b8e3599 + f32d9a9
commit 764af10
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -37,7 +37,7 @@ makedocs(;
     ),
     pages=[
         "Basic usage (local)" => "index.md",
-        "Why PT?" => "unidentifiable-example.md",
+        "Why parallel tempering (PT)?" => "unidentifiable-example.md",
         "Parallelization" => "parallel.md",
         "Distributed usage (MPI)" => "mpi.md",
         "Variational PT" => "variational.md",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -16,7 +16,7 @@ of the following algorithms:
 
 - Non-Reversible Parallel Tempering (NRPT), 
     [Syed et al., 2021](https://rss.onlinelibrary.wiley.com/doi/10.1111/rssb.12464).
-- Variational PT, [Surjanovic et al., 2022](https://arxiv.org/abs/2206.00080). 
+- Variational parallel tempering (Variational PT), [Surjanovic et al., 2022](https://arxiv.org/abs/2206.00080). 
 - autoMALA, [Biron-Lattes et al., 2023](https://arxiv.org/abs/2310.16782).
 
 These algorithms achieve state-of-the-art performance for approximation 
@@ -50,7 +50,7 @@ You will find information there on setting the random `seed`,
 controlling the number of iterations (via `n_rounds`), 
 and many more options
 
-Then, run PT (locally on one process) using the function [`pigeons()`](@ref):
+Then, run parallel tempering (PT) locally on one process using the function [`pigeons()`](@ref):
 
 ```@example example
 pt = pigeons(inputs);

diff --git a/docs/src/unidentifiable-example.md b/docs/src/unidentifiable-example.md
@@ -2,7 +2,7 @@
 CurrentModule = Pigeons
 ```
 
-# [Why PT? An example.](@id unidentifiable-example)
+# [Why Parallel Tempering (PT)? An example.](@id unidentifiable-example)
 
 Consider a Bayesian model where the likelihood is a binomial distribution with probability parameter ``p``. 
 Let us consider an over-parameterized model where we 
@@ -94,4 +94,4 @@ This is also confirmed by the PT ESS estimates:
 
 ```@example why
 samples
-```
+```