Skip to content

Commit 988aa84

Browse files
committed
Improve returned() documentation
1 parent 968c879 commit 988aa84

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/src/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,10 @@ It is possible to manually increase (or decrease) the accumulated log density fr
166166
@addlogprob!
167167
```
168168

169-
Return values of the model function for a collection of samples can be obtained with [`returned(model, chain)`](@ref).
169+
Return values of the model function can be obtained with [`returned(model, sample)`](@ref), where `sample` is either a `MCMCChains.Chains` object (which represents a collection samples) or a single sample represented as a `NamedTuple`.
170170

171171
```@docs
172+
returned(::DynamicPPL.Model, ::MCMCChains.Chains)
172173
returned(::DynamicPPL.Model, ::NamedTuple)
173174
```
174175

0 commit comments

Comments
 (0)