From 687110d918913828930046423adc660f876e73c2 Mon Sep 17 00:00:00 2001 From: David Widmann Date: Wed, 27 Sep 2023 13:20:11 +0200 Subject: [PATCH] Update callback signature in docs --- docs/src/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/api.md b/docs/src/api.md index 52c2c2e1..629e4c37 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -71,8 +71,8 @@ Common keyword arguments for regular and parallel sampling are: - `progress` (default: `AbstractMCMC.PROGRESS[]` which is `true` initially): toggles progress logging - `chain_type` (default: `Any`): determines the type of the returned chain - `callback` (default: `nothing`): if `callback !== nothing`, then - `callback(rng, model, sampler, sample, iteration)` is called after every sampling step, - where `sample` is the most recent sample of the Markov chain and `iteration` is the current iteration + `callback(rng, model, sampler, sample, state, iteration)` is called after every sampling step, + where `sample` is the most recent sample of the Markov chain and `state` and `iteration` are the current state and iteration of the sampler - `discard_initial` (default: `0`): number of initial samples that are discarded - `thinning` (default: `1`): factor by which to thin samples.