Add sparse api chinese doc #5362

zhwesky2010 · 2022-10-14T08:40:10Z

批量新增稀疏API的中文文档

paddle-bot · 2022-10-14T08:40:14Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-5362.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：[Beta]飞桨文档预览工具

momozi1996 · 2022-10-17T02:59:32Z

docs/api/paddle/incubate/sparse/Overview_cn.rst

-    " :ref:`paddle.incubate.sparse.nn.Relu` ", "激活函数"
+    " :ref:`paddle.incubate.sparse.nn.functional.conv3d ` ", "三维卷积函数"
+    " :ref:`paddle.incubate.sparse.nn.functional.subm_conv3d ` ", "三维的 submanifold 卷积函数"
+    " :ref:`paddle.incubate.sparse.nn.functional.max_pool3d ` ", "三维最大池化层"


绝对链接有问题：

这5个文档的PR后面开活会提交，这里只提交一个模板

momozi1996 · 2022-10-17T03:01:18Z

docs/api/paddle/incubate/sparse/Overview_cn.rst

+.. csv-table::
+    :header: "API 名称", "API 功能"
+
+    " :ref:`paddle.incubate.sparse.nn.ReLU <cn_api_paddle_incubate_sparse_nn_ReLU>` ", "激活层"


请检查绝对链接，预览未生成

好的，因为链接现在失效的，所以如果现在合入，后期还是需再修改的。还是等待有绝对链接再合入，OK么？

好的，因为链接现在失效的，所以如果现在合入，后期还是需再修改的。还是等待有绝对链接再合入，OK么？

已经删掉了，还是不要被阻塞了

momozi1996 · 2022-10-17T03:01:59Z

docs/api/paddle/incubate/sparse/Overview_cn.rst

+    " :ref:`paddle.incubate.sparse.multiply <cn_api_paddle_incubate_sparse_multiply>` ", "对稀疏 Tensor 逐元素相乘"
+    " :ref:`paddle.incubate.sparse.divide <cn_api_paddle_incubate_sparse_divide>` ", "对稀疏 Tensor 逐元素相除"
+    " :ref:`paddle.incubate.sparse.transpose <cn_api_paddle_incubate_sparse_transpose>` ", "对稀疏 Tensor 根据 perm 进行数据重排"
+    " :ref:`paddle.incubate.sparse.coalesce ` ", "对 SparseCooTensor 进行排序与合并操作"


绝对链接的问题

同上，这几个已删除

momozi1996 · 2022-10-17T03:03:45Z

docs/api/paddle/incubate/sparse/addmm_cn.rst

+     input[SparseCsrTensor] + x[SparseCsrTensor] @ y[SparseCsrTensor] -> out[SparseCsrTensor]
+     input[DenseTensor] + x[SparseCsrTensor] @ y[DenseTensor] -> out[DenseTensor]
+     input[SparseCooTensor] + x[SparseCooTensor] @ y[SparseCooTensor] -> out[SparseCooTensor]
+     input[DenseTensor] + x[SparseCooTensor] @ y[DenseTensor] -> out[DenseTensor]


公式是否有问题？

momozi1996 · 2022-10-17T03:06:06Z

docs/api/paddle/incubate/sparse/masked_matmul_cn.rst

+输入、输出的格式对应关系如下：
+
+.. note::
+     x[DenseTensor] @ y[DenseTensor] * mask[SparseCooTensor] -> out[SparseCooTensor]


这里有问题不？

momozi1996 · 2022-10-17T03:06:54Z

docs/api/paddle/incubate/sparse/matmul_cn.rst

+输入、输出的格式对应关系如下：
+
+.. note::
+     x[SparseCsrTensor] @ y[SparseCsrTensor] -> out[SparseCsrTensor]


momozi1996 · 2022-10-17T03:07:56Z

docs/api/paddle/incubate/sparse/mv_cn.rst

+
+.. note::
+     x[SparseCsrTensor] @ vec[DenseTensor] -> out[DenseTensor]
+     x[SparseCooTensor] @ vec[DenseTensor] -> out[DenseTensor]


momozi1996 · 2022-10-17T03:10:42Z

docs/api/paddle/incubate/sparse/nn/LeakyReLU_cn.rst

+:::::::::
+    - input：任意形状的 SparseTensor。
+    - output：和 input 具有相同形状和数据类型的 SparseTensor。
+


1）返回值？

2）class类的所有用法，需要写一下。参考别的class类

1）这个是class类的，没有返回值。

2）没有其他用法，看了下别的激活类class，也是这样的写法

momozi1996 · 2022-10-17T03:21:15Z

docs/api/paddle/incubate/sparse/transpose_cn.rst

+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.transpose


COPY-FROM未生成代码块，可能是英文文档有错误或警告

transpose是最新和入的，应该是所安装的whl包里还没有这个api的问题，这一行和其他写法是一样的

写法是一样的，因为别的API 从英文文档和源代码拷贝成功了，不过transpose没有拷贝成功。
应该是transpose的英文文档有CI没过。

这个示例代码是需要正确的，否则无法合入

已经删除

momozi1996

一些小问题，注意，链接+示例代码+返回值的问题属于红线，优先解决一下～辛苦了

zhwesky2010 · 2022-10-17T06:24:59Z

一些小问题，注意，链接+示例代码+返回值的问题属于红线，优先解决一下～辛苦了

有问题地方都已经删掉了，目前没问题了，发版PR需要尽快合入

…evelop

momozi1996

LGTM

zhwesky2010 force-pushed the sparse_doc branch 3 times, most recently from 704b496 to e8bce70 Compare October 14, 2022 15:23

momozi1996 reviewed Oct 17, 2022

View reviewed changes

Add many sparse api chinese doc

98bc9c5

zhwesky2010 force-pushed the sparse_doc branch from e8bce70 to 98bc9c5 Compare October 17, 2022 03:42

fix comment

28fa9ce

Merge branch 'develop' of https://github.com/PaddlePaddle/docs into d…

483aa51

…evelop

zhwesky2010 changed the title ~~Add many sparse api chinese doc~~ Add sparse api chinese doc Oct 17, 2022

momozi1996 approved these changes Oct 18, 2022

View reviewed changes

zhwesky2010 merged commit ff29179 into PaddlePaddle:develop Oct 18, 2022

Ligoml mentioned this pull request Oct 25, 2022

【Hackathon No.60】add sparse sqrt docs #4684

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add sparse api chinese doc #5362

Add sparse api chinese doc #5362

zhwesky2010 commented Oct 14, 2022 •

edited

Loading

paddle-bot bot commented Oct 14, 2022

momozi1996 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

momozi1996 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022

momozi1996 Oct 17, 2022

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 left a comment

zhwesky2010 commented Oct 17, 2022 •

edited

Loading

momozi1996 left a comment

Add sparse api chinese doc #5362

Add sparse api chinese doc #5362

Conversation

zhwesky2010 commented Oct 14, 2022 • edited Loading

paddle-bot bot commented Oct 14, 2022

momozi1996 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhwesky2010 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhwesky2010 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhwesky2010 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhwesky2010 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

momozi1996 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

momozi1996 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhwesky2010 Oct 17, 2022 • edited Loading

Choose a reason for hiding this comment

momozi1996 left a comment

Choose a reason for hiding this comment

zhwesky2010 commented Oct 17, 2022 • edited Loading

momozi1996 left a comment

Choose a reason for hiding this comment

zhwesky2010 commented Oct 14, 2022 •

edited

Loading

momozi1996 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022 •

edited

Loading

momozi1996 Oct 17, 2022 •

edited

Loading

zhwesky2010 Oct 17, 2022 •

edited

Loading

zhwesky2010 commented Oct 17, 2022 •

edited

Loading