Skip to content

premshaw04/#7581/Fix Censored doc type hints and add example for partially censored array inputs #7954

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

premshaw04/#7581/Fix Censored doc type hints and add example for partially censored array inputs #7954

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions pymc/distributions/censored.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ class Censored(Distribution):

.. warning:: dist will be cloned, rendering it independent of the one passed as input.

lower : float or None
lower : float | int | array-like | None
Lower (left) censoring point. If `None` the distribution will not be left censored
upper : float or None
upper : float | int | array-like | None
Upper (right) censoring point. If `None`, the distribution will not be right censored.

Warnings
Expand All @@ -109,6 +109,13 @@ class Censored(Distribution):
with pm.Model():
normal_dist = pm.Normal.dist(mu=0.0, sigma=1.0)
censored_normal = pm.Censored("censored_normal", normal_dist, lower=-1, upper=1)

Partially censored vector using +/- inf masking:

>>> y = np.array([3.2, 10.5, 1.1, 14.4])
>>> lower = np.array([-np.inf, 9.0, -np.inf, 12.0])
>>> upper = np.array([ 4.0, np.inf, 2.5, np.inf])
>>> Censored("y_obs", pm.Normal.dist(mu=5, sigma=3), lower=lower, upper=upper, observed=y)
"""

rv_type = CensoredRV
Expand Down