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

Add docstring for `BetaRV`

上级 c9dd94b8
......@@ -166,12 +166,46 @@ triangular = TriangularRV()
class BetaRV(RandomVariable):
r"""A beta continuous random variable.
The probability density function for `beta` in terms of its parameters :math:`\alpha`
and :math:`\beta` is:
.. math::
f(x; \alpha, \beta) = \frac{1}{B(\alpha, \beta)} x^{\alpha-1} (1-x)^{\beta-1}
for :math:`0 \leq x \leq 1`. :math:`B` is the beta function defined as:
.. math::
B(\alpha, \beta) = \int_0^1 t^{\alpha-1} (1-t)^{\beta-1} \mathrm{d}t
"""
name = "beta"
ndim_supp = 0
ndims_params = [0, 0]
dtype = "floatX"
_print_name = ("Beta", "\\operatorname{Beta}")
def __call__(self, alpha, beta, size=None, **kwargs):
r"""Draw samples from a beta distribution.
Parameters
----------
alpha
Alpha parameter :math:`\alpha` of the distribution. Must be positive.
beta
Beta parameter :math:`\beta` of the distribution. Must be positive.
size
Sample shape. If the given size is, e.g. `(m, n, k)` then `m * n * k`
independent, identically distributed random variables are
returned. Default is `None` in which case a single random variable
is returned.
"""
return super().__call__(alpha, beta, size=size, **kwargs)
beta = BetaRV()
......
......@@ -55,6 +55,9 @@ Aesara can produce :class:`RandomVariable`\s that draw samples from many differe
.. autoclass:: aesara.tensor.random.basic.TriangularRV
:members: __call__
.. autoclass:: aesara.tensor.random.basic.BetaRV
:members: __call__
.. autoclass:: aesara.tensor.random.basic.GammaRV
:members: __call__
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论