From 988aa8421318513973b58e1cb087983167e6b770 Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Thu, 3 Jul 2025 15:53:42 +0100 Subject: [PATCH 1/3] Improve returned() documentation --- docs/src/api.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/api.md b/docs/src/api.md index 08522e2ce..9bf794883 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -166,9 +166,10 @@ It is possible to manually increase (or decrease) the accumulated log density fr @addlogprob! ``` -Return values of the model function for a collection of samples can be obtained with [`returned(model, chain)`](@ref). +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`. ```@docs +returned(::DynamicPPL.Model, ::MCMCChains.Chains) returned(::DynamicPPL.Model, ::NamedTuple) ``` From 8b9861443ab622abef82cae22d6f73f8b503d468 Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Thu, 3 Jul 2025 15:55:12 +0100 Subject: [PATCH 2/3] Bump patch --- HISTORY.md | 4 ++++ Project.toml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index f216df783..e67ceba0a 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,9 @@ # DynamicPPL Changelog +## 0.36.13 + +Added documentation for the `returned(::Model, ::MCMCChains.Chains)` method. + ## 0.36.12 Removed several unexported functions. diff --git a/Project.toml b/Project.toml index 5108d9aa9..cd473354c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "DynamicPPL" uuid = "366bfd00-2699-11ea-058f-f148b4cae6d8" -version = "0.36.12" +version = "0.36.13" [deps] ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b" From 60c9fc6285535bb83559109eb9d0390abe9e0d84 Mon Sep 17 00:00:00 2001 From: Penelope Yong Date: Thu, 3 Jul 2025 16:56:59 +0100 Subject: [PATCH 3/3] Fix typo --- docs/src/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/api.md b/docs/src/api.md index 9bf794883..a1adcb21c 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -166,7 +166,7 @@ It is possible to manually increase (or decrease) the accumulated log density fr @addlogprob! ``` -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`. +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 of samples) or a single sample represented as a `NamedTuple`. ```@docs returned(::DynamicPPL.Model, ::MCMCChains.Chains)