Skip to content

Updated docstrings for pymc.Beta #5500

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

Merged
merged 2 commits into from
Feb 25, 2022
Merged

Updated docstrings for pymc.Beta #5500

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cee9fd
Updated docstrings for pymc.Beta
sagartomar Feb 19, 2022
91ebd25
Marked alpha and beta as optional in pymc.Beta docstring
sagartomar Feb 24, 2022
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
23 changes: 14 additions & 9 deletions pymc/distributions/continuous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1167,6 +1167,7 @@ class Beta(UnitContinuous):
\frac{x^{\alpha - 1} (1 - x)^{\beta - 1}}{B(\alpha, \beta)}

.. plot::
:context: close-figs

import matplotlib.pyplot as plt
import numpy as np
Expand Down Expand Up @@ -1204,14 +1205,14 @@ class Beta(UnitContinuous):

Parameters
----------
alpha: float
alpha > 0.
beta: float
beta > 0.
mu: float
Alternative mean (0 < mu < 1).
sigma: float
Alternative standard deviation (0 < sigma < sqrt(mu * (1 - mu))).
alpha : tensor_like of float, optional
``alpha`` > 0. If not specified, then calculated using ``mu`` and ``sigma``.
beta : tensor_like of float, optional
``beta`` > 0. If not specified, then calculated using ``mu`` and ``sigma``.
mu : tensor_like of float, optional
Alternative mean (0 < ``mu`` < 1).
sigma : tensor_like of float, optional
Alternative standard deviation (1 < ``sigma`` < sqrt(``mu`` * (1 - ``mu``))).

Notes
-----
Expand Down Expand Up @@ -1264,9 +1265,13 @@ def logcdf(value, alpha, beta):

Parameters
----------
value: numeric or np.ndarray or aesara.tensor
value : tensor_like of float
Value(s) for which log CDF is calculated. If the log CDF for multiple
values are desired the values must be provided in a numpy array or Aesara tensor.
alpha : tensor_like of float
``alpha`` > 0.
beta : tensor_like of float
``beta`` > 0.

Returns
-------
Expand Down