Add Truncated to docs

pymc-devs · Sep 15, 2022 · 990ab02 · 990ab02
1 parent c53cd2f
commit 990ab02
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git 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
@@ -0,0 +1,9 @@
+*********
+Truncated
+*********
+
+.. currentmodule:: pymc
+.. autosummary::
+   :toctree: generated
+
+   Truncated
diff --git 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