Move MCMCSummary to MCMC diagnostics in the docs

[DavAug]

After a while I found the pints.MCMCSummary object with the MCMC samplers in the documentation, and I was somehow expecting it to be with the diagnostics.

Is this just me or is it worth maybe moving the MCMCSummary documentation to the diagnostics?

[MichaelClerx]

Maybe even the other way around? All other MCMC-only stuff is currently under "MCMC Samplers", so perhaps the MCMC diagnostics and this summary should both be there?

[DavAug]

That would work for me!

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Michael Clerx [email protected] Sent: Tuesday, February 9, 2021 2:00:01 PM To: pints-team/pints [email protected] Cc: David Augustin [email protected]; Author [email protected] Subject: Re: [pints-team/pints] Move MCMCSummary to MCMC diagnostics in the docs (#1281)

Maybe even the other way around? All other MCMC-only stuff is currently under "MCMC Samplers", so perhaps the MCMC diagnostics and this summary should both be there?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/pints-team/pints/issues/1281#issuecomment-775918036, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AEY2T3SK6OXSSOV4NQ66B2TS6EWVDANCNFSM4XK6CVJQ.

[MichaelClerx]

Hey @ben18785 , would this make sense? Or are the diagnostics in _diagnostic.py useful for sampling in general?

[ben18785]

Hmm. Well, as it stands the diagnostics are only for MCMC methods but, in the future, I'd envision having other diagnostics in there. But they could always be housed in different folders. I really don't mind either way! To be honest, I would be guided by "Do what's easiest to change" here.

[MichaelClerx]

Cool! I similarly don't mind @DavAug , so you can decide!