Skip to content

Commit 603021f

Browse files
committed
add paper reference to docstring
1 parent 69de1e6 commit 603021f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

pymc/step_methods/hmc/walnuts.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def stats(self) -> dict[str, Any]:
188188
class WALNUTS(BaseHMC):
189189
"""Within-orbit Adaptive Step-length No-U-Turn Sampler.
190190
191-
WALNUTS extends NUTS by adapting the integration step size within
191+
WALNUTS (Bou-Rabee et al., 2025) extends NUTS by adapting the integration step size within
192192
each trajectory. This can improve numerical stability in models
193193
with varying curvature.
194194
@@ -204,6 +204,13 @@ class WALNUTS(BaseHMC):
204204
Maximum depth during tuning phase.
205205
**kwargs
206206
Additional arguments passed to BaseHMC.
207+
208+
References
209+
----------
210+
.. [1] Bou-Rabee, N., Carpenter, B., Kleppe, T. S., & Liu, S. (2025).
211+
The Within-Orbit Adaptive Leapfrog No-U-Turn Sampler.
212+
arXiv preprint arXiv:2506.18746.
213+
https://arxiv.org/abs/2506.18746v1
207214
"""
208215

209216
name = "walnuts"

0 commit comments

Comments
 (0)