Skip to content

Commit

Permalink
Add warning about unobserved continuous censored distributions
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Osthege <michael.osthege@outlook.com>

Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
Co-authored-by: Michael Osthege <michael.osthege@outlook.com>
  • Loading branch information
3 people authored May 22, 2022
1 parent a95dd71 commit 66fba38
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions pymc/distributions/censored.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ class Censored(SymbolicDistribution):
upper: float or None
Upper (right) censoring point. If `None`, the distribution will not be right censored.
Warnings
--------
Continuous censored distributions should only be used as likelihoods.
Continuous censored distributions are a form of discrete-continuous mixture
and as such cannot be sampled properly without a custom step sampler.
If you wish to sample such a distribution, you can add the latent uncensored
distribution to the model and then wrap it in a :class:`~pymc.Deterministic`
:func:`~pymc.math.clip`.
Examples
--------
Expand Down

0 comments on commit 66fba38

Please sign in to comment.