Skip to content

Commit

Permalink
add flip doc. test=develop test=document_fix (PaddlePaddle#2000)
Browse files Browse the repository at this point in the history
  • Loading branch information
jiweibo authored Apr 17, 2020
1 parent 5db824e commit 903ed5f
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion doc/fluid/api_cn/tensor_cn/flip_cn.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,50 @@
.. _cn_api_tensor_flip:

flip
-------------------------------
**版本升级,文档正在开发中**

.. py:function:: paddle.flip(input, dims, name=None):
该OP沿指定轴反转n维tensor.

参数:
- **input** (Variable) - 输入Tensor。维度为多维,数据类型为bool, int32, int64, float32或float64。
- **dims** (list) - 需要翻转的轴。当 ``dims[i] < 0`` 时,实际的计算维度为 rank(input) + dims[i],其中i为dims的索引。
- **name** (str|None) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。默认值为None。

返回:在指定dims上翻转后的Tensor,与输入input数据类型相同。

返回类型:Variable,与输入input数据类型相同。

抛出异常:
- ``TypeError`` - 当输出 ``out`` 和输入 ``input`` 数据类型不一致时候。
- ``ValueError`` - 当参数 ``dims`` 不合法时。

**代码示例1**:

.. code-block:: python
import paddle
import paddle.fluid as fluid
import numpy as np
input = fluid.data(name="x", shape=[-1, 2, 2], dtype='float32')
output = paddle.flip(input, dims=[0, 1])
exe = fluid.Executor(fluid.CPUPlace())
exe.run(fluid.default_startup_program())
img = np.arange(12).reshape((3,2,2)).astype(np.float32)
res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
print(res) # [[[10,11][8, 9]],[[6, 7],[4, 5]] [[2, 3],[0, 1]]]
**代码示例2**:

.. code-block:: python
import paddle
import paddle.fluid as fluid
import numpy as np
img = np.arange(12).reshape((3,2,2)).astype(np.float32)
with fluid.dygraph.guard():
inputs = fluid.dygraph.to_variable(img)
ret = paddle.flip(inputs, [0, 1])
print(ret.numpy()) # [[[10,11][8, 9]],[[6, 7],[4, 5]] [[2, 3],[0, 1]]]

0 comments on commit 903ed5f

Please sign in to comment.