In the tutorial https://turinglang.org/v0.30/tutorials/10-bayesian-differential-equations/ , there is very little detail on how to obtain the parameters shown in the summary statistics (so that you may end up being stuck with a pretty print but no obvious way to access the information that is printed)
Although the MCMCChain documentation page is part of the website (go to Library API > Diagnostics > MCMCChains) it is not included in search results from turinglang.org, so one would be forgiven for thinking that there was no documentation on these functions when using the website.
So ideally what I would propose is
[ ] Make search on https://turinglang.org/ global so that it also searches inside all of the libraries that are part of the Library API section of the website)
[ ] Add clear instructions on tutorial pages on how to extract all (or some of) the information provided in the result tables (including describe(chain2) in the tutorial code and link to the MCMC diagnostics page for finer control would be enough for user to find all of the needed information they need on their own)
In the tutorial https://turinglang.org/v0.30/tutorials/10-bayesian-differential-equations/ , there is very little detail on how to obtain the parameters shown in the summary statistics (so that you may end up being stuck with a pretty print but no obvious way to access the information that is printed)
I think one should add that after that line of code
that one can obtain these tables by calling
and/or
That you can estimate the mean parameters in the table with
and that you can run
to obtain the
rhat
metric.This also points to a larger issue : This page https://turinglang.org/MCMCChains.jl/stable/diagnostics/#MCMCDiagnosticTools.rhat-Tuple{Chains} is not searchable from https://turinglang.org so that any user searching
rhat
in the search bar would find no information whatsoever.The same is true for
describe
andsummarystats
, found in another page of the MCMCCChain documentation https://turinglang.org/MCMCChains.jl/stable/stats/#StatsBase.summarystats but not searchable from the turinglang.org website.Although the MCMCChain documentation page is part of the website (go to Library API > Diagnostics > MCMCChains) it is not included in search results from turinglang.org, so one would be forgiven for thinking that there was no documentation on these functions when using the website.
So ideally what I would propose is
describe(chain2)
in the tutorial code and link to the MCMC diagnostics page for finer control would be enough for user to find all of the needed information they need on their own)