Skip to content

Commit d2b670d

Browse files
committed
Add accumulators to API docs
1 parent 10b4f2f commit d2b670d

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/src/api.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ returned(::Model)
160160

161161
## Utilities
162162

163-
It is possible to manually increase (or decrease) the accumulated log density from within a model function.
163+
It is possible to manually increase (or decrease) the accumulated log likelihood from within a model function.
164164

165165
```@docs
166166
@addlogprob!
@@ -345,6 +345,22 @@ Base.empty!
345345
SimpleVarInfo
346346
```
347347

348+
### Accumulators
349+
350+
The subtypes of [`AbstractVarInfo`](@ref) store the cumulative log prior and log likelihood, and sometimes other variables that change during executing, in what are called accumulators.
351+
352+
```@docs
353+
AbstractAccumulators
354+
```
355+
356+
DynamicPPL provides the following default accumulators.
357+
358+
```@docs
359+
LogPrior
360+
LogLikelihood
361+
NumProduce
362+
```
363+
348364
### Common API
349365

350366
#### Accumulation of log-probabilities

0 commit comments

Comments
 (0)