Skip to content

Commit a64083e

Browse files
committed
..
1 parent b0b5e7e commit a64083e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

petab/v1/distributions.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ class Distribution(abc.ABC):
3131
If ``False``, no transformation is applied.
3232
:param trunc: The truncation points (lower, upper) of the distribution
3333
or ``None`` if the distribution is not truncated.
34+
If the distribution is log-scaled, the truncation limits are expected
35+
to be on the same log scale, rather than on the scale of the underlying
36+
distribution.
3437
"""
3538

3639
def __init__(
@@ -275,8 +278,10 @@ class Normal(Distribution):
275278
:param loc: The location parameter of the distribution.
276279
:param scale: The scale parameter of the distribution.
277280
:param trunc: The truncation limits of the distribution.
278-
``None`` if the distribution is not truncated. The truncation limits
279-
are the truncation limits of the transformed distribution.
281+
``None`` if the distribution is not truncated.
282+
If the distribution is log-scaled, the truncation limits are expected
283+
to be on the same log scale, rather than on the scale of the underlying
284+
normal distribution.
280285
:param log: If ``True``, the distribution is transformed to a log-normal
281286
distribution. If a float, the distribution is transformed to a
282287
log-normal distribution with the given log-base.
@@ -371,8 +376,10 @@ class Laplace(Distribution):
371376
:param loc: The location parameter of the distribution.
372377
:param scale: The scale parameter of the distribution.
373378
:param trunc: The truncation limits of the distribution.
374-
``None`` if the distribution is not truncated. The truncation limits
375-
are the truncation limits of the transformed distribution.
379+
``None`` if the distribution is not truncated.
380+
If the distribution is log-scaled, the truncation limits are expected
381+
to be on the same log scale, rather than on the scale of the underlying
382+
normal distribution.
376383
:param log: If ``True``, the distribution is transformed to a log-Laplace
377384
distribution. If a float, the distribution is transformed to a
378385
log-Laplace distribution with the given log-base.

0 commit comments

Comments
 (0)