【Hackathon 6th No.17】为 Paddle 新增 sparse.mask_as API

docs/api/paddle/sparse/Overview_cn.rst

@@ -59,6 +59,7 @@ paddle.sparse 目录包含飞桨框架支持稀疏数据存储和计算相关的
     " :ref:`paddle.sparse.reshape <cn_api_paddle_sparse_reshape>` ", "改变一个 SparseTensor 的形状"
     " :ref:`paddle.sparse.coalesce<cn_api_paddle_sparse_coalesce>` ", "对 SparseCooTensor 进行排序并合并"
     " :ref:`paddle.sparse.transpose <cn_api_paddle_sparse_transpose>` ", "在不改变数据的情况下改变 ``x`` 的维度顺序, 支持 COO 格式的多维 SparseTensor 以及 COO 格式的 2 维和 3 维 SparseTensor"
+    " :ref:`paddle.sparse.mask_as<cn_api_paddle_sparse_mask_as>` ", "稀疏张量的掩码逻辑，使用稀疏张量 `mask` 的索引过滤输入的稠密张量 `x`"
 
 .. _about_sparse_nn:
 

docs/api/paddle/sparse/mask_as_cn.rst

@@ -0,0 +1,24 @@
+.. _cn_api_paddle_sparse_mask_as:
+
+mask_as
+-------------------------------
+
+.. py:function:: paddle.sparse.mask_as(x, mask, name=None)
+
+使用稀疏张量 `mask` 的索引过滤输入的稠密张量 `x`，并生成相应格式的稀疏张量。输入的 `x` 和 `mask` 必须具有相同的形状，且返回的稀疏张量具有与 `mask` 相同的索引，即使对应的索引中存在 `零` 值。
+
+参数
+:::::::::
+    - **x** (DenseTensor) - 输入的 DenseTensor。数据类型为 float32，float64，int32，int64，complex64，complex128，int8，int16，float16。
+    - **mask** (SparseTensor) - 输入的稀疏张量，是一个 SparseTensor，可以为 SparseCooTensor、SparseCsrTensor。当其为 SparseCsrTensor 时，应该是 2D 或 3D 的形式。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+:::::::::
+SparseTensor: 其稀疏格式、dtype、shape 均与 `mask` 相同。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.sparse.mask_as

docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.sparse_mask.md

@@ -0,0 +1,32 @@
+## [ 参数完全一致 ] torch.Tensor.sparse_mask
+
+### [torch.Tensor.sparse_mask](https://pytorch.org/docs/stable/generated/torch.Tensor.sparse_mask.html)
+
+```python
+torch.Tensor.sparse_mask(mask)
+```
+
+### [paddle.sparse.mask_as](https://www.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/sparse/mask_as_cn.html)
+
+```python
+paddle.sparse.mask_as(x, mask, name=None)
+```
+
+两者功能一致，但使用方式不一致，前者可以直接访问方法，后者需要调用方法，具体如下：
+
+### 参数映射
+
+| PyTorch    | PaddlePaddle | 备注                                 |
+| ---------- | ------------ | ------------------------------------ |
+| -          | x            | 输入的 DenseTensor。                  |
+| mask       | mask         | 掩码逻辑的 mask，参数完全一致。           |
+
+### 转写示例
+
+```python
+# torch 版本可以直接访问方法
+# torch.sparse_mask(mask)
+
+# Paddle 版本需要调用
+paddle.sparse.mask_as(x, mask)
+```

docs/guides/model_convert/convert_from_pytorch/pytorch_api_mapping_cn.md

@@ -1066,6 +1066,7 @@
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.softmax`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.softmax.md) |
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.sort`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.sort.md) |
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.split`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.split.md) |
+| REFERENCE-MAPPING-ITEM(`torch.Tensor.sparse_mask`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.sparse_mask.md) |
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.sqrt`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.sqrt.md) |
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.sqrt_`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.sqrt_.md) |
 | REFERENCE-MAPPING-ITEM(`torch.Tensor.square`, https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/model_convert/convert_from_pytorch/api_difference/Tensor/torch.Tensor.square.md) |