未验证 提交 53ff28b9 编写于 作者: W wangchaochaohu 提交者: GitHub

refine the doc for masked_select test=develop (#2469)

上级 43353502
......@@ -97,6 +97,7 @@ paddle
paddle/logical_xor.rst
paddle/logsumexp.rst
paddle/manual_seed.rst
paddle/masked_select.rst
paddle/matmul.rst
paddle/max.rst
paddle/maximum.rst
......
......@@ -67,6 +67,7 @@ paddle.tensor
tensor/logical_or.rst
tensor/logical_xor.rst
tensor/math.rst
tensor/masked_select.rst
tensor/max.rst
tensor/maximum.rst
tensor/mean.rst
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
.. _api_tensor_search_masked_select:
masked_select
---------------
.. autofunction:: paddle.tensor.search.masked_select
:noindex:
......@@ -96,6 +96,7 @@ paddle
paddle_cn/logsumexp_cn.rst
paddle_cn/log_cn.rst
paddle_cn/manual_seed_cn.rst
paddle_cn/masked_select_cn.rst
paddle_cn/matmul_cn.rst
paddle_cn/max_cn.rst
paddle_cn/maximum_cn.rst
......
......@@ -92,6 +92,7 @@ paddle.tensor
tensor_cn/logical_or_cn.rst
tensor_cn/logical_xor_cn.rst
tensor_cn/logsumexp_cn.rst
tensor_cn/masked_select_cn.rst
tensor_cn/math_cn.rst
tensor_cn/matmul_cn.rst
tensor_cn/max_cn.rst
......
.. _cn_api_tensor_masked_select:
masked_select
-------------------------------
.. py:function:: paddle.masked_select(x, mask, name=None)
该OP返回一个1-D 的Tensor, Tensor的值是根据 ``mask`` 对输入 ``x`` 进行选择的, ``mask`` 的数据类型是bool 。
参数:
- **x** (Tensor) - 输入Tensor, 数据类型为float32, float64,int32 或者int64。
- **mask** (Tensor) - 用于索引的二进制掩码的Tensor,数据类型维bool。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:返回一个根据 ``mask`` 选择的的Tensor
抛出异常:
- ``TypeError``: - 如果 ``x`` 不是 Tensor 或者 ``x`` 是Tensor的时候的数据类型不是 float32, float64, int32, int64其中之一。
- ``TypeError``: - 如果 ``mask`` 不是 Tensor 或者 ``mask`` 是Tensor的时候的数据类型不是 bool。
**代码示例**:
.. code-block:: python
import paddle
import numpy as np
paddle.disable_static()
data = np.array([[1.0, 2.0, 3.0, 4.0],
[5.0, 6.0, 7.0, 8.0],
[9.0, 10.0, 11.0, 12.0]]).astype('float32')
mask_data = np.array([[True, False, False, False],
[True, True, False, False],
[True, False, False, False]]).astype('bool')
x = paddle.to_tensor(data)
mask = paddle.to_tensor(mask_data)
out = paddle.masked_select(x, mask)
#[1.0 5.0 6.0 9.0]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册