Updated docstrings for pymc.Beta #5500
Conversation
pymc/distributions/continuous.py
Outdated
| Alternative mean (0 < mu < 1). | ||
| sigma: float | ||
| Alternative standard deviation (0 < sigma < sqrt(mu * (1 - mu))). | ||
| alpha : tensor_like of float |
There was a problem hiding this comment.
alpha and beta are also optional I think, but I don't know what the defaults are @ricardoV94
There was a problem hiding this comment.
If we don't specify alpha, beta then they will be calculated using mu, sigma. Does it make sense to write the equation for computing alpha, beta from mu, sigma in the docstrings or will that be too long?
There was a problem hiding this comment.
the formula is already there in the extended summary (at the bottom)
There was a problem hiding this comment.
is it okay then to just change it to: alpha : tensor_like of float, optional or should we add something in the description saying that if not specifed then calculated from mu and sigma?
sagartomar
force-pushed
the
beta_docstring
branch
from
9c557d0 to
91ebd25
Compare
Codecov Report
@@ Coverage Diff @@
## main #5500 +/- ##
=======================================
Coverage 81.51% 81.51%
=======================================
Files 81 81
Lines 14219 14219
=======================================
Hits 11591 11591
Misses 2628 2628
|
Thank your for opening a PR!
Depending on what your PR does, here are a few things you might want to address in the description:
For issue #5459
#DataUmbrellaPyMCSprint