diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 4ffd46ddb5e..18c4dc71c16 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -200,6 +200,7 @@ tensor 数学操作原位(inplace)版本 " :ref:`paddle.add_ ` ", "Inplace 版本的 add API,对输入 x 采用 Inplace 策略" " :ref:`paddle.addmm_ ` ", "Inplace 版本的 addmm API,对输入 input 采用 Inplace 策略" " :ref:`paddle.put_along_axis_ ` ", "Inplace 版本的 put_along_axis API,对输入 x 采用 Inplace 策略" + " :ref:`paddle.cauchy_ ` ", "Inplace 版本的 cauchy API,对输入 x 采用 Inplace 策略" " :ref:`paddle.ceil_ ` ", "Inplace 版本的 ceil API,对输入 x 采用 Inplace 策略" " :ref:`paddle.clip_ ` ", "Inplace 版本的 clip API,对输入 x 采用 Inplace 策略" " :ref:`paddle.copysign_ ` ", "Inplace 版本的 copysign API,对输入 x 采用 Inplace 策略" diff --git a/docs/api/paddle/cauchy__cn.rst b/docs/api/paddle/cauchy__cn.rst new file mode 100644 index 00000000000..ce7d5d74ea2 --- /dev/null +++ b/docs/api/paddle/cauchy__cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_cauchy_: + +cauchy\_ +------------------------------- + +.. py:function:: paddle.cauchy_(x, loc=0, scale=1, name=None) +该函数将输入 Tensor 填充为从柯西分布(Cauchy distribution)中采样的随机数。 + +参数 +:::::::::::: + + - **x** (Tensor) - 待填充的目标张量,数据类型必须为 float32 或 float64。 + - **loc** (scalar,可选) - 柯西分布的峰值位置,数据类型为 float32 或 float64,默认值为 0。 + - **scale** (scalar,可选) - 柯西分布的半高全宽(HWHM),必须为正数,数据类型为 float32 或 float64,默认值为 1。 + - **name** (str|None,可选) - 操作的名称,一般无需设置,默认值为 None。 + +返回 +:::::::::::: +填充了柯西分布随机数的输入张量 + +返回类型 +:::::::::::: +Tensor + +代码示例 +:::::::::::: + +COPY-FROM: paddle.cauchy_