Skip to content

Commit caeade2

Browse files
authored
Update callback signature in docs (#130)
1 parent 1c589e8 commit caeade2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/src/api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Common keyword arguments for regular and parallel sampling are:
7171
- `progress` (default: `AbstractMCMC.PROGRESS[]` which is `true` initially): toggles progress logging
7272
- `chain_type` (default: `Any`): determines the type of the returned chain
7373
- `callback` (default: `nothing`): if `callback !== nothing`, then
74-
`callback(rng, model, sampler, sample, iteration)` is called after every sampling step,
75-
where `sample` is the most recent sample of the Markov chain and `iteration` is the current iteration
74+
`callback(rng, model, sampler, sample, state, iteration)` is called after every sampling step,
75+
where `sample` is the most recent sample of the Markov chain and `state` and `iteration` are the current state and iteration of the sampler
7676
- `discard_initial` (default: `0`): number of initial samples that are discarded
7777
- `thinning` (default: `1`): factor by which to thin samples.
7878

0 commit comments

Comments
 (0)