Skip to content

Commit a2d5e5e

Browse files
author
root
committed
add sparse overview
1 parent 6427237 commit a2d5e5e

File tree

4 files changed

+57
-8
lines changed

4 files changed

+57
-8
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -404,5 +404,5 @@ device 相关
404404
:header: "API 名称", "API 功能"
405405
:widths: 10, 30
406406

407-
" :ref:`paddle.sparse.sparse_coo_tensor<cn_api_paddle_sparse_coo_tensor>` ", "创建一个 COO(Coordinate)格式的稀疏 Tensor"
408-
" :ref:`paddle.sparse.sparse_csr_tensor<cn_api_paddle_sparse_csr_tensor>` ", "创建一个 CSR(Compressed Sparse Row)格式的稀疏 Tensor"
407+
" :ref:`paddle.incubate.sparse.sparse_coo_tensor<cn_api_paddle_incubate_sparse_coo_tensor>` ", "创建一个 COO(Coordinate)格式的稀疏 Tensor"
408+
" :ref:`paddle.incubate.sparse.sparse_csr_tensor<cn_api_paddle_incubate_sparse_csr_tensor>` ", "创建一个 CSR(Compressed Sparse Row)格式的稀疏 Tensor"
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.. _cn_overview_paddle:
2+
3+
paddle.incubate.sparse
4+
---------------------
5+
6+
paddle.incubate.sparse 目录包含飞桨框架支持稀疏数据存储和计算相关的API。具体如下:
7+
8+
- :ref:`稀疏数据结构相关 <about_sparse_tensor>`
9+
- :ref:`数学操作API <about_sparse_math>`
10+
- :ref:`NN相关API <about_sparse_nn>`
11+
12+
.. __about_sparse_tensor:
13+
14+
稀疏数据结构相关
15+
::::::::::::::::::::
16+
17+
.. csv-table::
18+
::header: "API 名称", "API 功能"
19+
20+
" :ref: `paddle.incubate.sparse.sparse_coo_tensor <cn_api_paddle_incubate_sparse_coo_tensor>` ", "构造COO格式的SparseTensor"
21+
" :ref: `paddle.incubate.sparse.sparse_csr_tensor <cn_api_paddle_incubate_sparse_csr_tensor>` ", "构造CSR格式的SparseTensor"
22+
23+
24+
.. __about_sparse_math:
25+
26+
数学操作相关
27+
::::::::::::::::::::
28+
29+
.. csv-table::
30+
::header: "API 名称", "API 功能"
31+
32+
" :ref: `paddle.incubate.sparse.abs` ", "绝对值函数"
33+
" :ref: `paddle.incubate.sparse.add` ", "Sparse Tensor逐元素相加"
34+
" :ref: `paddle.incubate.sparse.asin` ", "arcsine函数"
35+
" :ref: `paddle.incubate.sparse.asinh` ", "反双曲正弦函数"
36+
" :ref: `paddle.incubate.sparse.atan` ", "反双曲正切函数"
37+
38+
39+
.. __about_sparse_nn:
40+
41+
NN相关
42+
::::::::::::::::::::
43+
44+
.. csv-table::
45+
::header: "API 名称", "API 功能"
46+
47+
" :ref: `paddle.incubate.sparse.nn.Conv3D` ", "三维卷积"
48+
" :ref: `paddle.incubate.sparse.nn.SubmConv3D` ", "三维的submanifold卷积"
49+
" :ref: `paddle.incubate.sparse.nn.Relu` ", "激活函数"

docs/api/paddle/sparse/sparse_coo_tensor_cn.rst renamed to docs/api/paddle/incubate/sparse/sparse_coo_tensor_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _cn_api_paddle_sparse_coo_tensor:
1+
.. _cn_api_paddle_incubate_sparse_coo_tensor:
22

33
sparse_coo_tensor
44
-------------------------------
55

66

7-
.. py:function:: paddle.sparse.sparse_coo_tensor(indices, values, shape=None, dtype=None, place=None, stop_gradient=True)
7+
.. py:function:: paddle.incubate.sparse.sparse_coo_tensor(indices, values, shape=None, dtype=None, place=None, stop_gradient=True)
88
99
该 API 通过已知的非零元素的 ``indices`` 和 ``values`` 来创建一个 coordinate 格式的稀疏 tensor,tensor 类型为 ``paddle.Tensor`` 。
1010

@@ -40,4 +40,4 @@ sparse_coo_tensor
4040
代码示例
4141
:::::::::
4242

43-
COPY-FROM: paddle.sparse.sparse_coo_tensor
43+
COPY-FROM: paddle.incubate.sparse.sparse_coo_tensor

docs/api/paddle/sparse/sparse_csr_tensor_cn.rst renamed to docs/api/paddle/incubate/sparse/sparse_csr_tensor_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _cn_api_paddle_sparse_csr_tensor:
1+
.. _cn_api_paddle_incubate_sparse_csr_tensor:
22

33
sparse_csr_tensor
44
-------------------------------
55

66

7-
.. py:function:: paddle.sparse.sparse_csr_tensor(crows, cols, values, shape, dtype=None, place=None, stop_gradient=True)
7+
.. py:function:: paddle.incubate.sparse.sparse_csr_tensor(crows, cols, values, shape, dtype=None, place=None, stop_gradient=True)
88
99
该 API 通过已知的非零元素的 ``crows`` , ``cols`` 和 ``values`` 来创建一个 CSR(Compressed Sparse Row) 格式的稀疏 tensor,tensor 类型为 ``paddle.Tensor`` 。
1010

@@ -43,4 +43,4 @@ sparse_csr_tensor
4343

4444
**代码示例**
4545

46-
COPY-FROM: paddle.sparse.sparse_csr_tensor
46+
COPY-FROM: paddle.incubate.sparse.sparse_csr_tensor

0 commit comments

Comments
 (0)