Skip to content

Commit 75e2ab9

Browse files
authored
【PaddlePaddle Hackathon 3 No.17】为 Paddle 新增 sgn 文档 (#5107)
* add docs of paddle.sgn * add docs of paddle.sgn
1 parent 24253dc commit 75e2ab9

File tree

5 files changed

+37
-0
lines changed

5 files changed

+37
-0
lines changed

docs/api/api_label

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,7 @@ paddle.scatter_nd .. _api_paddle_scatter_nd:
228228
paddle.scatter_nd_add .. _api_paddle_scatter_nd_add:
229229
paddle.shard_index .. _api_paddle_shard_index:
230230
paddle.sign .. _api_paddle_sign:
231+
paddle.sgn .. _api_paddle_sgn:
231232
paddle.sin .. _api_paddle_sin:
232233
paddle.sinh .. _api_paddle_sinh:
233234
paddle.slice .. _api_paddle_slice:

docs/api/paddle/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ tensor 数学操作
107107
" :ref:`paddle.rsqrt <cn_api_fluid_layers_rsqrt>` ", "rsqrt 激活函数"
108108
" :ref:`paddle.scale <cn_api_fluid_layers_scale>` ", "缩放算子"
109109
" :ref:`paddle.sign <cn_api_tensor_sign>` ", "对输入 x 中每个元素进行正负判断"
110+
" :ref:`paddle.sgn <cn_api_tensor_sgn>` ", "对输入 x 中每个元素进行正负判断,对于复数则输出单位向量"
110111
" :ref:`paddle.sin <cn_api_fluid_layers_sin>` ", "计算输入的正弦值"
111112
" :ref:`paddle.sinh <cn_api_fluid_layers_sinh>` ", "双曲正弦函数"
112113
" :ref:`paddle.sqrt <cn_api_fluid_layers_sqrt>` ", "计算输入的算数平方根"

docs/api/paddle/Tensor/Overview_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ Methods
227227
set_value
228228
shard_index
229229
sign
230+
sgn
230231
sin
231232
sinh
232233
slice

docs/api/paddle/Tensor_cn.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1972,6 +1972,15 @@ sign(name=None)
19721972

19731973
请参考 :ref:`cn_api_tensor_sign`
19741974

1975+
sgn(name=None)
1976+
:::::::::
1977+
1978+
返回:计算后的 Tensor
1979+
1980+
返回类型:Tensor
1981+
1982+
请参考 :ref:`cn_api_tensor_sgn`
1983+
19751984
sin(name=None)
19761985
:::::::::
19771986

docs/api/paddle/sgn_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_tensor_sgn:
2+
3+
sgn
4+
-------------------------------
5+
6+
.. py:function:: paddle.sgn(x, name=None)
7+
8+
对于复数张量,此函数返回一个新的张量,其元素与 input 元素的角度相同且绝对值为 1。
9+
10+
对于实数张量,对输入参数 ``x`` 中每个元素进行正负判断,并且输出正负判断值:1 代表正,-1 代表负,0 代表零。
11+
12+
参数
13+
::::::::::::
14+
- **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::::
19+
Tensor,输出正负号或复数的单位向量,数据的 shape 大小及数据类型和输入 ``x`` 一致。
20+
21+
22+
代码示例
23+
::::::::::::
24+
25+
COPY-FROM: paddle.sgn

0 commit comments

Comments
 (0)