Skip to content

Updated pymc.Gamma docstring #5496

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 19, 2022
Merged

Updated pymc.Gamma docstring #5496

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28ec044
Updated pymc.Gamma docstring
areding Feb 19, 2022
b23bf5a
address review comments
areding Feb 19, 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
13 changes: 8 additions & 5 deletions pymc/distributions/continuous.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2271,13 +2271,13 @@ class Gamma(PositiveContinuous):

Parameters
----------
alpha: float
alpha : float, optional
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
alpha : float, optional
alpha : tensor_like of float, optional

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I've addressed these.

Shape parameter (alpha > 0).
beta: float
beta : float, optional
Rate parameter (beta > 0).
mu: float
mu : float, optional
Alternative shape parameter (mu > 0).
sigma: float
sigma : float, optional
Alternative scale parameter (sigma > 0).
"""
rv_op = gamma
Expand Down Expand Up @@ -2332,10 +2332,13 @@ def logcdf(value, alpha, inv_beta):

Parameters
----------
value: numeric or np.ndarray or `TensorVariable`
value : numeric or ndarray or TensorVariable
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 `TensorVariable`.
alpha : float
Shape parameter (alpha > 0).
inv_beta:

Returns
-------
Expand Down