Skip to content

Commit

Permalink
【Hackathon 5th No. 18】Add Binomial API -part (PaddlePaddle#6386)
Browse files Browse the repository at this point in the history
  • Loading branch information
NKNaN authored Dec 13, 2023
1 parent 938f02a commit 1a9f172
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ tensor random 相关
:widths: 10, 30

" :ref:`paddle.bernoulli <cn_api_paddle_bernoulli>` ", "以输入 x 为概率,生成一个伯努利分布(0-1 分布)的 Tensor,输出 Tensor 的形状和数据类型与输入 x 相同"
" :ref:`paddle.binomial <cn_api_paddle_binomial>` ", "以输入 count 为总实验次数, prob 为实验成功的概率,生成一个二项分布的 Tensor"
" :ref:`paddle.multinomial <cn_api_paddle_multinomial>` ", "以输入 x 为概率,生成一个多项分布的 Tensor"
" :ref:`paddle.normal <cn_api_paddle_normal>` ", "返回符合正态分布(均值为 mean ,标准差为 std 的正态随机分布)的随机 Tensor"
" :ref:`paddle.rand <cn_api_paddle_rand>` ", "返回符合均匀分布的,范围在[0, 1)的 Tensor"
Expand Down
30 changes: 30 additions & 0 deletions docs/api/paddle/binomial_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _cn_api_paddle_binomial:

binomial
-------------------------------

.. py:function:: paddle.binomial(count, prob, name=None)
以输入参数 ``count`` 和 ``prob`` 分别为二项分布的 `n` 和 `p` 参数,生成一个二项分布的随机数 Tensor ,支持 Tensor 形状广播。输出 Tensor 的 dtype 为 ``int64`` 。

.. math::
out_i \sim Binomial (n = count_i, p = prob_i)
参数
::::::::::::

- **count** (Tensor) - Tensor 的每个元素代表一个二项分布的总试验次数。数据类型支持 ``int32`` 、``int64`` 。
- **prob** (Tensor) - Tensor 的每个元素代表一个二项分布的试验成功概率。数据类型支持 ``bfloat16`` 、``float16`` 、``float32`` 、``float64`` 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
::::::::::::

Tensor,二项分布采样得到的随机 Tensor,形状为 ``count`` 和 ``prob`` 进行广播后的 Tensor 形状, dtype 为 ``int64`` 。


代码示例
::::::::::::

COPY-FROM: paddle.binomial

0 comments on commit 1a9f172

Please sign in to comment.