File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -29,6 +29,17 @@ The sampler is constructed using
29
29
```julia
30
30
spl = MetropolisHastings(proposal)
31
31
```
32
+
33
+ When using `MetropolisHastings` with the function `sample`, the following keyword
34
+ arguments are allowed:
35
+
36
+ - `init_params` defines the initial parameterization for your model. If
37
+ none is given, the initial parameters will be drawn from the sampler's proposals.
38
+ - `param_names` is a vector of strings to be assigned to parameters. This is only
39
+ used if `chain_type=Chains`.
40
+ - `chain_type` is the type of chain you would like returned to you. Supported
41
+ types are `chain_type=Chains` if `MCMCChains` is imported, or
42
+ `chain_type=StructArray` if `StructArrays` is imported.
32
43
"""
33
44
mutable struct MetropolisHastings{D} <: Metropolis
34
45
proposal :: D
You can’t perform that action at this time.
0 commit comments