提交 d2f139e6 authored 作者: Rémi Louf's avatar Rémi Louf 提交者: Brandon T. Willard

Improve `GammaRV`'s docstring

上级 b8e6b3ea
...@@ -162,15 +162,19 @@ lognormal = LogNormalRV() ...@@ -162,15 +162,19 @@ lognormal = LogNormalRV()
class GammaRV(ScipyRandomVariable): class GammaRV(ScipyRandomVariable):
r"""A gamma continuous random variable. r"""A gamma continuous random variable.
The probability density function for `gamma` in terms of `shape = alpha` and `rate = beta` is: The probability density function for `gamma` in terms of the shape parameter
:math:`\alpha` and rate parameter :math:`\beta` is:
.. math:: .. math::
f(x, \alpha, \beta) = \frac{\beta^\alpha}{\Gamma(\alpha)}x^{\alpha-1}e^{-\beta x} f(x; \alpha, \beta) = \frac{\beta^\alpha}{\Gamma(\alpha)}x^{\alpha-1}e^{-\beta x}
for :math:`x \geq 0`, :math:`\alpha > 0` and :math:`\beta > 0`. `gamma` for :math:`x \geq 0`, :math:`\alpha > 0` and :math:`\beta > 0`. :math:`\Gamma` is
takes ``shape`` as a shape parameter for :math:`\alpha` and ``rate`` as a the gamma function:
rate parameter for :math:`\beta`.
.. math::
\Gamma(x) = \int_0^{\infty} t^{x-1} e^{-t} \mathrm{d}t
""" """
name = "gamma" name = "gamma"
...@@ -180,14 +184,14 @@ class GammaRV(ScipyRandomVariable): ...@@ -180,14 +184,14 @@ class GammaRV(ScipyRandomVariable):
_print_name = ("Gamma", "\\operatorname{Gamma}") _print_name = ("Gamma", "\\operatorname{Gamma}")
def __call__(self, shape, rate, size=None, **kwargs): def __call__(self, shape, rate, size=None, **kwargs):
"""Return gamma-distributed random variables. r"""Draw samples from a gamma distribution.
Parameters Parameters
---------- ----------
shape shape
The shape of the gamma distribution. Must be positive. The shape :math:`\alpha` of the gamma distribution. Must be positive.
rate rate
The rate of the gamma distribution. Must be positive. The rate :math:`\beta` of the gamma distribution. Must be positive.
size size
Sample shape. If the given size is, e.g. `(m, n, k)` then `m * n * k` Sample shape. If the given size is, e.g. `(m, n, k)` then `m * n * k`
independent, identically distributed random variables are independent, identically distributed random variables are
...@@ -195,7 +199,6 @@ class GammaRV(ScipyRandomVariable): ...@@ -195,7 +199,6 @@ class GammaRV(ScipyRandomVariable):
is returned. is returned.
""" """
return super().__call__(shape, 1.0 / rate, size=size, **kwargs) return super().__call__(shape, 1.0 / rate, size=size, **kwargs)
@classmethod @classmethod
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论