Skip to content

Commit f79663c

Browse files
committed
Add another note about multiple chains params
1 parent 58f4eab commit f79663c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

usage/sampling-options/index.qmd

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,16 @@ chn[:x][1,:], chn[:y][1,:]
163163
## Upcoming changes in Turing v0.41
164164

165165
In Turing v0.41, instead of providing _initial parameters_, users will have to provide what is conceptually an _initialisation strategy_.
166-
The keyword argument is still `initial_params`, but the permitted values will either be:
166+
The keyword argument is still `initial_params`, but the permitted values (for single-chain sampling) will either be:
167167

168168
- `InitFromPrior()`: generate initial parameters by sampling from the prior
169169
- `InitFromUniform(lower, upper)`: generate initial parameters by sampling uniformly from the given bounds in linked space
170170
- `InitFromParams(namedtuple_or_dict)`: use the provided initial parameters, supplied either as a `NamedTuple` or a `Dict{<:VarName}`
171171

172172
Initialisation with `Vector` will be fully removed due to its inherent ambiguity.
173173
Initialisation with a raw `NamedTuple` will still be supported (it will simply be wrapped in `InitFromParams()`); but we expect to remove this eventually, so it will be more future-proof to use `InitFromParams()` directly.
174+
175+
For multiple chains, the same as above applies: the `initial_params` keyword argument should be a vector of initialisation strategies, one per chain.
174176
:::
175177

176178
## Saving and resuming sampling

0 commit comments

Comments
 (0)