-
Notifications
You must be signed in to change notification settings - Fork 13
Clarify interpretation of noise distributions #656
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
dilpath
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
doc/v2/documentation_data_format.rst
Outdated
| Denote by :math:`m` the measured value, | ||
| :math:`y:=\text{observableFormula}` the simulated value | ||
| (the location parameter of the noise distribution), | ||
| (the median of the noise distribution), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, you are right, that wasn't worded correctly.
Fine to merge with Dilan's suggestions, but with respect to #654, I am wondering if we really want to refer here to the median, or just generally to something like "first parameter in canonical notation", or just nothing at all.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"first parameter in canonical notation"
This is not correct either, as with log-normal we have log(m) not m entering the formula, so I would like to keep median (I think it helps to think about what the noise distribution means). As for #654, I think the way to handle it would simply be to split the noise distribution into two sections, discrete and continuous.
doc/v2/documentation_data_format.rst
Outdated
| :math:`y:=\text{observableFormula}` the simulated value | ||
| (the location parameter of the noise distribution), | ||
| (the median of the noise distribution), | ||
| and :math:`\sigma` the scale parameter of the noise distribution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same problem here, right? For the log-normal distribution, sigma wouldn't be the scale but its logarithm?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, for normal distributions it is the standard distribution (no log), while for Laplace it is the scale. I have made this clearer.
Co-authored-by: Dilan Pathirana <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, now just for consistency and to make the table narrower, I'll shorten the other descriptions too.
Removes the horizontal scrollbar on the table for me: https://petab--656.org.readthedocs.build/en/656/v2/documentation_data_format.html#noise-distributions
When implementing support for
LogLaplacein PEtab.jl, I realized that the interpretation of the noise distributions in the spec is not entirely clear. In particular, for the supported distributions, the model output is not assumed to be the mean or location of the data distribution, but rather its median.For example, let ($m$ ) be the measured value, $y := \text{observableFormula}$ the simulated value, and $\sigma$ the noise. For the $\log(m) \sim \mathcal{N}(\log(y), \sigma)$ , which implies $m \sim \mathcal{LN}(\log(y), \sigma)$ . For this
LogNormaldistribution in PEtab we haveLogNormal, the median isy(expof first argument). A similar interpretation holds forLogLaplace. Overall, this PR aims to clarify this.