Skip to content

Commit 66fba38

Browse files
ricardoV94OriolAbrilmichaelosthege
authored
Add warning about unobserved continuous censored distributions
Co-authored-by: Michael Osthege <[email protected]> Co-authored-by: Oriol Abril-Pla <[email protected]> Co-authored-by: Michael Osthege <[email protected]>
1 parent a95dd71 commit 66fba38

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pymc/distributions/censored.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ class Censored(SymbolicDistribution):
5353
upper: float or None
5454
Upper (right) censoring point. If `None`, the distribution will not be right censored.
5555
56+
Warnings
57+
--------
58+
Continuous censored distributions should only be used as likelihoods.
59+
Continuous censored distributions are a form of discrete-continuous mixture
60+
and as such cannot be sampled properly without a custom step sampler.
61+
If you wish to sample such a distribution, you can add the latent uncensored
62+
distribution to the model and then wrap it in a :class:`~pymc.Deterministic`
63+
:func:`~pymc.math.clip`.
64+
5665
5766
Examples
5867
--------

0 commit comments

Comments
 (0)