Skip to content

Commit 81d9b63

Browse files
authored
【Paddle Tensor No.21】docs: Add docs for Tensor.bitwise_invert (#6932)
* docs: Add docs for Tensor.bitwise_invert bitwise_invert 复用 bitwise_not,两者功能相同 * docs: modify note
1 parent 60b255b commit 81d9b63

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

docs/api/paddle/Tensor_cn.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -691,6 +691,15 @@ bitwise_not(out=None, name=None)
691691

692692
请参考 :ref:`cn_api_paddle_bitwise_not`
693693

694+
bitwise_invert(out=None, name=None)
695+
:::::::::
696+
697+
返回:按位取反运算后的结果
698+
699+
返回类型:Tensor
700+
701+
请参考 :ref:`cn_api_paddle_bitwise_invert`
702+
694703
bitwise_or(y, out=None, name=None)
695704
:::::::::
696705

docs/api/paddle/bitwise_invert_cn.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _cn_api_paddle_bitwise_invert:
2+
3+
bitwise_invert
4+
-------------------------------
5+
6+
.. py:function:: paddle.bitwise_invert(x, out=None, name=None)
7+
8+
对 Tensor ``x`` 逐元素进行 ``按位取反`` 运算。
9+
10+
.. math::
11+
Out = \sim X
12+
13+
.. note::
14+
``bitwise_invert`` 和 ``bitwise_not`` 执行相同的操作,功能等效。
15+
16+
参数
17+
::::::::::::
18+
19+
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。
20+
- **out** (Tensor,可选)- 输出的结果 `Tensor`,是与输入数据类型相同的 N-D `Tensor`。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
21+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
22+
23+
返回
24+
::::::::::::
25+
``按位取反`` 运算后的结果 ``Tensor``,数据类型与 ``x`` 相同。
26+
27+
代码示例
28+
::::::::::::
29+
30+
COPY-FROM: paddle.bitwise_invert

0 commit comments

Comments
 (0)