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

Update the docstring of `HypergeomtricRV``

上级 e967ece1
...@@ -996,18 +996,16 @@ class HyperGeometricRV(RandomVariable): ...@@ -996,18 +996,16 @@ class HyperGeometricRV(RandomVariable):
Parameters Parameters
---------- ----------
ngood ngood
Number :math:`K` of desirable items in the population. Number :math:`K` of desirable items in the population. Positive integer.
nbad nbad
Number :math:`N-K` of undesirable items in the population. Number :math:`N-K` of undesirable items in the population. Positive integer.
nsample nsample
Number :math:`n` of items sampled. Must be less than :math:`N`, Number :math:`n` of items sampled. Must be less than :math:`N`,
i.e. `ngood + nbad`.` i.e. `ngood + nbad`.` Positive integer.
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 samples are returned. Default is
returned. Default is `None` in which case a single random variable `None` in which case a single sample is returned.
is returned if `ngood`, `nbad` and `nsample` are all scalars.
Otherwise `np.broadcast(ngood, nbad, nsample).size` samples are drawn.
""" """
return super().__call__(ngood, nbad, nsample, size=size, **kwargs) return super().__call__(ngood, nbad, nsample, size=size, **kwargs)
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论