Skip to content

Commit 64b519d

Browse files
committed
updated docs to reflect the new two-argument @returned_quantities
1 parent d92141c commit 64b519d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/api.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ These statements are rewritten by `@model` as calls of [internal functions](@ref
1414
@model
1515
```
1616

17-
One can nest models and call another model inside the model function with [`@submodel`](@ref) and [`@returned_quantities`](@ref).
17+
One can nest models and call another model inside the model function with [`@submodel`](@ref) and [`@returned_quantities(model)`](@ref).
1818

1919
```@docs
2020
@submodel
21-
@returned_quantities
21+
@returned_quantities(model)
2222
```
2323

2424
In the context of nesting models, it's also useful to prefix the variables in sub-models to avoid variable names clashing:
@@ -125,10 +125,10 @@ It is possible to manually increase (or decrease) the accumulated log density fr
125125
@addlogprob!
126126
```
127127

128-
Return values of the model function for a collection of samples can be obtained with [`returned_quantities`](@ref).
128+
Return values of the model function for a collection of samples can be obtained with [`@returned_quantities`](@ref).
129129

130130
```@docs
131-
returned_quantities
131+
@returned_quantities(model, input)
132132
```
133133

134134
For a chain of samples, one can compute the pointwise log-likelihoods of each observed random variable with [`pointwise_loglikelihoods`](@ref). Similarly, the log-densities of the priors using

0 commit comments

Comments
 (0)