Skip to content

Commit 7776b90

Browse files
[Docathon][Add Inplace CN Doc No.9] (#7230)
* 增加了inplace类cauchy)_方法的中文文档 * 修复了标题下划线的问题和空格问题 * 按照反馈进行了格式修改 * 4-14按照要求进行修改 * Update docs/api/paddle/cauchy__cn.rst --------- Co-authored-by: zachary sun <[email protected]>
1 parent f63c7f4 commit 7776b90

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ tensor 数学操作原位(inplace)版本
200200
" :ref:`paddle.add_ <cn_api_paddle_add_>` ", "Inplace 版本的 add API,对输入 x 采用 Inplace 策略"
201201
" :ref:`paddle.addmm_ <cn_api_paddle_addmm_>` ", "Inplace 版本的 addmm API,对输入 input 采用 Inplace 策略"
202202
" :ref:`paddle.put_along_axis_ <cn_api_paddle_put_along_axis_>` ", "Inplace 版本的 put_along_axis API,对输入 x 采用 Inplace 策略"
203+
" :ref:`paddle.cauchy_ <cn_api_paddle_cauchy_>` ", "直接修改输入 x,将所有元素替换为从柯西分布中随机采样的数值"
203204
" :ref:`paddle.ceil_ <cn_api_paddle_ceil_>` ", "Inplace 版本的 ceil API,对输入 x 采用 Inplace 策略"
204205
" :ref:`paddle.clip_ <cn_api_paddle_clip_>` ", "Inplace 版本的 clip API,对输入 x 采用 Inplace 策略"
205206
" :ref:`paddle.copysign_ <cn_api_paddle_copysign_>` ", "Inplace 版本的 copysign API,对输入 x 采用 Inplace 策略"
@@ -257,6 +258,7 @@ tensor 数学操作原位(inplace)版本
257258

258259

259260

261+
260262
.. _tensor_logic:
261263

262264
tensor 逻辑操作

docs/api/paddle/cauchy__cn.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _cn_api_paddle_cauchy_:
2+
3+
cauchy\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.cauchy_(x, loc = 0, scale = 1, name = None)
7+
8+
9+
10+
直接修改输入张量 ``x``,将所有元素替换为从柯西分布中随机采样的数值。
11+
12+
参数
13+
::::::::::::
14+
15+
- **x** (Tensor) - 输入的 Tensor,支持的数据类型为:float32、float64。
16+
- **loc** (scalar,可选) - 分布峰值的位置参数,数据类型为 float32 或 float64。默认值为 0,对应标准柯西分布。
17+
- **scale** (scalar,可选) - 表示分布峰值一半高度处的半宽度(HWHM),控制曲线的陡峭程度。必须为正数,数据类型为 float32 或 float64。默认值为 1,对应标准柯西分布。
18+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
19+
20+
返回
21+
::::::::::::
22+
Tensor,对输入的张量 ``x`` 直接进行了修改,数据类型与输入时相同。
23+
24+
代码示例
25+
::::::::::::
26+
27+
COPY-FROM: paddle.cauchy_

0 commit comments

Comments
 (0)