From 1a9f172a21b8481e82118aae6da17950187c5d0d Mon Sep 17 00:00:00 2001 From: AyaseNana <49900969+NKNaN@users.noreply.github.com> Date: Wed, 13 Dec 2023 16:51:45 +0800 Subject: [PATCH] =?UTF-8?q?=E3=80=90Hackathon=205th=20No.=2018=E3=80=91Add?= =?UTF-8?q?=20Binomial=20API=20-part=20(#6386)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/paddle/Overview_cn.rst | 1 + docs/api/paddle/binomial_cn.rst | 30 ++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/api/paddle/binomial_cn.rst diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 9e75e40ea2e..00dfbbd6d2f 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -301,6 +301,7 @@ tensor random 相关 :widths: 10, 30 " :ref:`paddle.bernoulli ` ", "以输入 x 为概率,生成一个伯努利分布(0-1 分布)的 Tensor,输出 Tensor 的形状和数据类型与输入 x 相同" + " :ref:`paddle.binomial ` ", "以输入 count 为总实验次数, prob 为实验成功的概率,生成一个二项分布的 Tensor" " :ref:`paddle.multinomial ` ", "以输入 x 为概率,生成一个多项分布的 Tensor" " :ref:`paddle.normal ` ", "返回符合正态分布(均值为 mean ,标准差为 std 的正态随机分布)的随机 Tensor" " :ref:`paddle.rand ` ", "返回符合均匀分布的,范围在[0, 1)的 Tensor" diff --git a/docs/api/paddle/binomial_cn.rst b/docs/api/paddle/binomial_cn.rst new file mode 100644 index 00000000000..c2ffb8197ca --- /dev/null +++ b/docs/api/paddle/binomial_cn.rst @@ -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