From 990ab02e9226f80d58f1513ad9bad5a1ff2e2550 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Mon, 29 Aug 2022 16:35:08 +0200 Subject: [PATCH] Add Truncated to docs --- docs/source/api/distributions.rst | 1 + docs/source/api/distributions/truncated.rst | 9 +++++++++ pymc/distributions/truncated.py | 9 +++++++++ 3 files changed, 19 insertions(+) create mode 100644 docs/source/api/distributions/truncated.rst diff --git a/docs/source/api/distributions.rst b/docs/source/api/distributions.rst index 9243ea4ef74..fd738e9e737 100644 --- a/docs/source/api/distributions.rst +++ b/docs/source/api/distributions.rst @@ -10,6 +10,7 @@ Distributions distributions/multivariate distributions/mixture distributions/timeseries + distributions/truncated distributions/censored distributions/simulator distributions/transforms diff --git a/docs/source/api/distributions/truncated.rst b/docs/source/api/distributions/truncated.rst new file mode 100644 index 00000000000..97378d4cd4b --- /dev/null +++ b/docs/source/api/distributions/truncated.rst @@ -0,0 +1,9 @@ +********* +Truncated +********* + +.. currentmodule:: pymc +.. autosummary:: + :toctree: generated + + Truncated diff --git a/pymc/distributions/truncated.py b/pymc/distributions/truncated.py index c0359ec64e7..004b4f3c0a6 100644 --- a/pymc/distributions/truncated.py +++ b/pymc/distributions/truncated.py @@ -111,6 +111,15 @@ class Truncated(Distribution): `SymbolicRandomVariable` graph representing the truncation process, via inverse CDF sampling (if the underlying dist has a logcdf method), or rejection sampling is returned. + + Examples + -------- + .. code-block:: python + + with pm.Model(): + normal_dist = pm.Normal.dist(mu=0.0, sigma=1.0) + truncated_normal = pm.Truncated("truncated_normal", normal_dist, lower=-1, upper=1) + """ rv_type = TruncatedRV