diff --git a/docs/api/api_label b/docs/api/api_label index aada119a877..fa32368d2e3 100644 --- a/docs/api/api_label +++ b/docs/api/api_label @@ -228,6 +228,7 @@ paddle.scatter_nd .. _api_paddle_scatter_nd: paddle.scatter_nd_add .. _api_paddle_scatter_nd_add: paddle.shard_index .. _api_paddle_shard_index: paddle.sign .. _api_paddle_sign: +paddle.sgn .. _api_paddle_sgn: paddle.sin .. _api_paddle_sin: paddle.sinh .. _api_paddle_sinh: paddle.slice .. _api_paddle_slice: diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 113f031234d..20b3e889edf 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -107,6 +107,7 @@ tensor 数学操作 " :ref:`paddle.rsqrt ` ", "rsqrt 激活函数" " :ref:`paddle.scale ` ", "缩放算子" " :ref:`paddle.sign ` ", "对输入 x 中每个元素进行正负判断" + " :ref:`paddle.sgn ` ", "对输入 x 中每个元素进行正负判断,对于复数则输出单位向量" " :ref:`paddle.sin ` ", "计算输入的正弦值" " :ref:`paddle.sinh ` ", "双曲正弦函数" " :ref:`paddle.sqrt ` ", "计算输入的算数平方根" diff --git a/docs/api/paddle/Tensor/Overview_en.rst b/docs/api/paddle/Tensor/Overview_en.rst index 85f9137ce79..6b34759a74f 100644 --- a/docs/api/paddle/Tensor/Overview_en.rst +++ b/docs/api/paddle/Tensor/Overview_en.rst @@ -227,6 +227,7 @@ Methods set_value shard_index sign + sgn sin sinh slice diff --git a/docs/api/paddle/Tensor_cn.rst b/docs/api/paddle/Tensor_cn.rst index 9e76fee3455..f869964ccba 100755 --- a/docs/api/paddle/Tensor_cn.rst +++ b/docs/api/paddle/Tensor_cn.rst @@ -1972,6 +1972,15 @@ sign(name=None) 请参考 :ref:`cn_api_tensor_sign` +sgn(name=None) +::::::::: + +返回:计算后的 Tensor + +返回类型:Tensor + +请参考 :ref:`cn_api_tensor_sgn` + sin(name=None) ::::::::: diff --git a/docs/api/paddle/sgn_cn.rst b/docs/api/paddle/sgn_cn.rst new file mode 100644 index 00000000000..da9b81bc2dd --- /dev/null +++ b/docs/api/paddle/sgn_cn.rst @@ -0,0 +1,25 @@ +.. _cn_api_tensor_sgn: + +sgn +------------------------------- + +.. py:function:: paddle.sgn(x, name=None) + +对于复数张量,此函数返回一个新的张量,其元素与 input 元素的角度相同且绝对值为 1。 + +对于实数张量,对输入参数 ``x`` 中每个元素进行正负判断,并且输出正负判断值:1 代表正,-1 代表负,0 代表零。 + +参数 +:::::::::::: + - **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。 + - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + +返回 +:::::::::::: +Tensor,输出正负号或复数的单位向量,数据的 shape 大小及数据类型和输入 ``x`` 一致。 + + +代码示例 +:::::::::::: + +COPY-FROM: paddle.sgn