Skip to content

Commit 4dade6d

Browse files
authored
Updated docstrings for pymc.Beta (#5500)
* Updated docstrings for pymc.Beta * Marked alpha and beta as optional in pymc.Beta docstring
1 parent 0282280 commit 4dade6d

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

pymc/distributions/continuous.py

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,6 +1167,7 @@ class Beta(UnitContinuous):
11671167
\frac{x^{\alpha - 1} (1 - x)^{\beta - 1}}{B(\alpha, \beta)}
11681168
11691169
.. plot::
1170+
:context: close-figs
11701171
11711172
import matplotlib.pyplot as plt
11721173
import numpy as np
@@ -1204,14 +1205,14 @@ class Beta(UnitContinuous):
12041205
12051206
Parameters
12061207
----------
1207-
alpha: float
1208-
alpha > 0.
1209-
beta: float
1210-
beta > 0.
1211-
mu: float
1212-
Alternative mean (0 < mu < 1).
1213-
sigma: float
1214-
Alternative standard deviation (0 < sigma < sqrt(mu * (1 - mu))).
1208+
alpha : tensor_like of float, optional
1209+
``alpha`` > 0. If not specified, then calculated using ``mu`` and ``sigma``.
1210+
beta : tensor_like of float, optional
1211+
``beta`` > 0. If not specified, then calculated using ``mu`` and ``sigma``.
1212+
mu : tensor_like of float, optional
1213+
Alternative mean (0 < ``mu`` < 1).
1214+
sigma : tensor_like of float, optional
1215+
Alternative standard deviation (1 < ``sigma`` < sqrt(``mu`` * (1 - ``mu``))).
12151216
12161217
Notes
12171218
-----
@@ -1264,9 +1265,13 @@ def logcdf(value, alpha, beta):
12641265
12651266
Parameters
12661267
----------
1267-
value: numeric or np.ndarray or aesara.tensor
1268+
value : tensor_like of float
12681269
Value(s) for which log CDF is calculated. If the log CDF for multiple
12691270
values are desired the values must be provided in a numpy array or Aesara tensor.
1271+
alpha : tensor_like of float
1272+
``alpha`` > 0.
1273+
beta : tensor_like of float
1274+
``beta`` > 0.
12701275
12711276
Returns
12721277
-------

0 commit comments

Comments
 (0)