Skip to content

Commit b4b2ea1

Browse files
TCChenlongTCChenlong
authored
fix api index (#3583)
* fix api index * fix api index * fix api index
1 parent e958a18 commit b4b2ea1

19 files changed

+221
-226
lines changed

‎docs/api/index_cn.rst‎

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,51 +12,62 @@ API 文档
1212
| 目录 | 功能和包含的API |
1313
+===============================+=======================================================+
1414
| paddle.\* | paddle |
15-
| | 根目录下保留了常用API的别名，当前包括：paddle.tensor, |
15+
| | 根目录下保留了常用API的别名，包括：paddle.tensor, |
1616
| | paddle.framework, paddle.device 目录下的所有API |
1717
+-------------------------------+-------------------------------------------------------+
18-
| paddle.tensor | 跟tensor操作相关的API，如：创建zeros, |
18+
| paddle.tensor | Tensor操作相关的API，包括 创建zeros, |
1919
| | 矩阵运算matmul, 变换concat, 计算add, 查找argmax等 |
2020
+-------------------------------+-------------------------------------------------------+
21-
| paddle.framework | 框架通用API和动态图模式的API，例如 no_grad 、 |
21+
| paddle.framework | 框架通用API和动态图模式的API，包括 no_grad 、 |
2222
| | save 、 load 等。 |
2323
+-------------------------------+-------------------------------------------------------+
24-
| paddle.device | 设备管理相关API，如 set_device, get_device 等 |
24+
| paddle.device | 设备管理相关API，包括 set_device, get_device 等。 |
2525
+-------------------------------+-------------------------------------------------------+
26-
| paddle.amp | paddle自动混合精度策略，包括 auto_cast 、 |
26+
| paddle.amp | 自动混合精度策略，包括 auto_cast 、 |
2727
| | GradScaler 等。 |
2828
+-------------------------------+-------------------------------------------------------+
29-
| paddle.callbacks | paddle日志回调类，包括 ModelCheckpoint 、 |
29+
| paddle.autograd | 自动求导相关API，包括 backward、PyLayer 等。 |
30+
+-------------------------------+-------------------------------------------------------+
31+
| paddle.callbacks | 日志回调类，包括 ModelCheckpoint 、 |
3032
| | ProgBarLogger 等。 |
3133
+-------------------------------+-------------------------------------------------------+
32-
| paddle.nn | 组网相关的API，例如 Linear 、卷积 Conv2D 、 |
33-
| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss 、 |
34-
| | 激活函数 ReLU 等。 |
34+
| paddle.distributed | 分布式相关基础API |
3535
+-------------------------------+-------------------------------------------------------+
36-
| paddle.static | 静态图下基础框架相关API，比如：Variable, Program, |
37-
| | Executor等 |
36+
| paddle.distributed.fleet | 分布式相关高层API |
3837
+-------------------------------+-------------------------------------------------------+
39-
| paddle.static.nn | 静态图下组网专用API，例如全连接层 fc 、控制流 |
40-
| | while_loop/cond 。 |
38+
| paddle.hub | 模型拓展相关的API，包括 list、load、help 等。 |
4139
+-------------------------------+-------------------------------------------------------+
42-
| paddle.onnx | paddle转换为onnx协议相关API，比如：export |
40+
| paddle.io | 数据输入输出相关API，包括 Dataset, DataLoader 等。 |
4341
+-------------------------------+-------------------------------------------------------+
44-
| paddle.optimizer | 优化算法相关API，比如：SGD，Adagrad, Adam等 |
42+
| paddle.jit | 动态图转静态图相关API，包括 to_static、 |
43+
| | ProgramTranslator、TracedLayer 等。 |
4544
+-------------------------------+-------------------------------------------------------+
46-
| paddle.optimizer.lr | 学习率衰减相关API，例如 NoamDecay 、 StepDecay 、 |
47-
| | PiecewiseDecay 等。 |
45+
| paddle.metric | 评估指标计算相关的API，包括 Accuracy, Auc等。 |
4846
+-------------------------------+-------------------------------------------------------+
49-
| paddle.metric | 评估指标计算相关的API，比如：Accuracy, Auc等。 |
47+
| paddle.nn | 组网相关的API，包括 Linear 、卷积 Conv2D 、 |
48+
| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss 、 |
49+
| | 激活函数 ReLU 等。 |
5050
+-------------------------------+-------------------------------------------------------+
51-
| paddle.io | 数据输入输出相关API，比如：Dataset, DataLoader 等。 |
51+
| paddle.onnx | paddle转换为onnx协议相关API，包括 export 等。 |
5252
+-------------------------------+-------------------------------------------------------+
53-
| paddle.distributed | 分布式相关基础API |
53+
| paddle.optimizer | 优化算法相关API，包括 SGD，Adagrad, Adam 等。 |
5454
+-------------------------------+-------------------------------------------------------+
55-
| paddle.distributed.fleet | 分布式相关高层API |
55+
| paddle.optimizer.lr | 学习率衰减相关API，包括 NoamDecay 、 StepDecay 、 |
56+
| | PiecewiseDecay 等。 |
5657
+-------------------------------+-------------------------------------------------------+
57-
| paddle.vision | 视觉领域API，例如数据集 Cifar10 、数据处理 ColorJitter|
58-
| | 、常用基础网络结构 ResNet 等。 |
58+
| paddle.regularizer | 正则化相关API，包括 L1Decay、L2Decay 等。 |
59+
+-------------------------------+-------------------------------------------------------+
60+
| paddle.static | 静态图下基础框架相关API，包括 Variable, Program, |
61+
| | Executor等 |
5962
+-------------------------------+-------------------------------------------------------+
60-
| paddle.text | NLP领域API，目前包括NLP领域相关的数据集， |
63+
| paddle.static.nn | 静态图下组网专用API，包括 全连接层 fc 、控制流 |
64+
| | while_loop/cond 。 |
65+
+-------------------------------+-------------------------------------------------------+
66+
| paddle.text | NLP领域API，包括NLP领域相关的数据集， |
6167
| | 如 Imdb 、 Movielens 。 |
6268
+-------------------------------+-------------------------------------------------------+
69+
| paddle.utils | 工具类相关API，包括 CppExtension、CUDAExtension 等。 |
70+
+-------------------------------+-------------------------------------------------------+
71+
| paddle.vision | 视觉领域API，包括 数据集 Cifar10 、数据处理 |
72+
| | ColorJitter、常用基础网络结构 ResNet 等。 |
73+
+-------------------------------+-------------------------------------------------------+

‎docs/api/index_en.rst‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,28 @@ In this version, PaddlePaddle has made many optimizations to the APIs. You can r
2929
| paddle.amp | Paddle automatic mixed precision strategy, including |
3030
| | auto_cast, GradScaler, etc. |
3131
+-------------------------------+-------------------------------------------------------+
32+
| paddle.autograd | Auto grad API, including backward, PyLayer, etc. |
33+
+-------------------------------+-------------------------------------------------------+
3234
| paddle.callbacks | Paddle log callback APIs, including ModelCheckpoint, |
3335
| | ProgBarLogger, etc. |
3436
+-------------------------------+-------------------------------------------------------+
35-
| paddle.nn | Networking-related APIs such as Linear, Conv2D, |
36-
| | CrossEntropyLoss, RNN，and ReLU |
37+
| paddle.distributed | Distributed related basic APIs. |
3738
+-------------------------------+-------------------------------------------------------+
38-
| paddle.static | Basic framework related APIs under static graph, |
39-
| | such as Variable, Program, Executor, etc. |
39+
| paddle.distributed.fleet | Distributed related high-level APIs. |
4040
+-------------------------------+-------------------------------------------------------+
41-
| paddle.static.nn | Special APIs for networking under static graph such |
42-
| | as full connect layer fc and control flow |
43-
| | while_loop/cond |
41+
| paddle.hub | Model extension API, including list, load, help, etc. |
4442
+-------------------------------+-------------------------------------------------------+
45-
| paddle.framework | Universal APIs and imprerative mode APIs such as |
46-
| | to_variable and prepare_context |
43+
| paddle.io | APIs related to data input and output such as |
44+
| | Dataset, and DataLoader |
45+
+-------------------------------+-------------------------------------------------------+
46+
| paddle.jit | Dynamic graph to static graph APIs, including |
47+
| | to_static, ProgramTranslator, TracedLayer, etc. |
48+
+-------------------------------+-------------------------------------------------------+
49+
| paddle.metric | APIs related to evaluation computation such as |
50+
| | Accuracy and Auc. |
51+
+-------------------------------+-------------------------------------------------------+
52+
| paddle.nn | Networking-related APIs such as Linear, Conv2D, |
53+
| | CrossEntropyLoss, RNN，and ReLU, etc. |
4754
+-------------------------------+-------------------------------------------------------+
4855
| paddle.onnx | APIs related to convert paddle model to ONNX，such as |
4956
| | export |
@@ -54,22 +61,22 @@ In this version, PaddlePaddle has made many optimizations to the APIs. You can r
5461
| paddle.optimizer.lr | APIs related to learning rate decay, such as |
5562
| | NoamDecay, StepDecay, PiecewiseDecay, etc. |
5663
+-------------------------------+-------------------------------------------------------+
57-
| paddle.metric | APIs related to evaluation computation such as |
58-
| | Accuracy and Auc |
64+
| paddle.regularizer | Regularization APIs, including L1Decay, L2Decay, etc. |
5965
+-------------------------------+-------------------------------------------------------+
60-
| paddle.io | APIs related to data input and output such as |
61-
| | Dataset, and DataLoader |
66+
| paddle.static | Basic framework related APIs under static graph, |
67+
| | such as Variable, Program, Executor, etc. |
68+
+-------------------------------+-------------------------------------------------------+
69+
| paddle.static.nn | Special APIs for networking under static graph such |
70+
| | as full connect layer fc and control flow |
71+
| | while_loop/cond |
6272
+-------------------------------+-------------------------------------------------------+
63-
| paddle.distributed | Distributed related basic APIs |
64-
| | |
73+
| paddle.text | The NLP domain API currently includes data sets |
74+
| | related to the NLP domain, such as Imdb and Movielens.|
6575
+-------------------------------+-------------------------------------------------------+
66-
| paddle.distributed.fleet | Distributed related high-level APIs |
67-
| | |
76+
| paddle.utils | Utils APIs, including CppExtension, CUDAExtension. |
6877
+-------------------------------+-------------------------------------------------------+
6978
| paddle.vision | Vision domain APIs such as datasets Cifar10, |
7079
| | data processing ColorJitter, and commonly used models |
7180
| | like resnet |
7281
+-------------------------------+-------------------------------------------------------+
73-
| paddle.text | The NLP domain API currently includes data sets |
74-
| | related to the NLP domain, such as Imdb and Movielens.|
75-
+-------------------------------+-------------------------------------------------------+
82+

0 commit comments

Comments
 (0)