Skip to content

Commit 2b1d5e3

Browse files
committed
Update changelog, use -ise in prose
1 parent d5f2063 commit 2b1d5e3

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

HISTORY.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44

55
An extension for MarginalLogDensities.jl has been added.
66

7-
Loading DynamicPPL and MarginalLogDensities now provides the `DynamicPPL.marginalize` function to marginalize out variables from a model.
7+
Loading DynamicPPL and MarginalLogDensities now provides the `DynamicPPL.marginalize` function to marginalise out variables from a model.
88
This is useful for averaging out random effects or nuisance parameters while improving inference on fixed effects/parameters of interest.
99
The `marginalize` function returns a `MarginalLogDensities.MarginalLogDensity`, a function-like callable struct that returns the approximate log-density of a subset of the parameters after integrating out the rest of them.
10-
By default, this uses the Laplace approximation and sparse AD, making the marginalization computationally very efficient.
11-
Please see [the documentation](https://turinglang.org/DynamicPPL.jl/v0.37/api/#Marginalization) for further information.
10+
By default, this uses the Laplace approximation and sparse AD, making the marginalisation computationally very efficient.
11+
Note that the Laplace approximation relies on the model being differentiable with respect to the marginalised variables, and that their posteriors are unimodal and approximately Gaussian.
12+
13+
Please see [the MarginalLogDensities documentation](https://eloceanografo.github.io/MarginalLogDensities.jl/stable) and the [new Marginalisation section of the DynamicPPL documentation](https://turinglang.org/DynamicPPL.jl/v0.37/api/#Marginalisation) for further information.
1214

1315
## 0.37.3
1416

docs/src/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,16 +136,16 @@ When using `predict` with `MCMCChains.Chains`, you can control which variables a
136136
- `include_all=false` (default): Include only newly predicted variables
137137
- `include_all=true`: Include both parameters from the original chain and predicted variables
138138

139-
## Marginalization
139+
## Marginalisation
140140

141-
DynamicPPL provides the `marginalize` function to marginalize out variables from a model.
141+
DynamicPPL provides the `marginalize` function to marginalise out variables from a model.
142142
This requires `MarginalLogDensities.jl` to be loaded in your environment.
143143

144144
```@docs
145145
marginalize
146146
```
147147

148-
A `MarginalLogDensity` object acts as a function which maps non-marginalized parameter values to a marginal log-probability.
148+
A `MarginalLogDensity` object acts as a function which maps non-marginalised parameter values to a marginal log-probability.
149149
To retrieve a VarInfo object from it, you can use:
150150

151151
```@docs

0 commit comments

Comments
 (0)