Skip to content

Commit

Permalink
fix api index (#3583)
Browse files Browse the repository at this point in the history 
* fix api index

* fix api index

* fix api index
  • Loading branch information
@TCChenlong
TCChenlong authored Jun 9, 2021
1 parent e958a18 commit b4b2ea1
Show file tree
Hide file tree
Showing 19 changed files with 221 additions and 226 deletions.
59 changes: 35 additions & 24 deletions docs/api/index_cn.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,51 +12,62 @@ API 文档
| 目录 | 功能和包含的API |
+===============================+=======================================================+
| paddle.\* | paddle |
| | 根目录下保留了常用API的别名，当前包括：paddle.tensor, |
| | 根目录下保留了常用API的别名，包括：paddle.tensor, |
| | paddle.framework, paddle.device 目录下的所有API |
+-------------------------------+-------------------------------------------------------+
| paddle.tensor | 跟tensor操作相关的API，如：创建zeros, |
| paddle.tensor | Tensor操作相关的API，包括 创建zeros, |
| | 矩阵运算matmul, 变换concat, 计算add, 查找argmax等 |
+-------------------------------+-------------------------------------------------------+
| paddle.framework | 框架通用API和动态图模式的API，例如 no_grad 、 |
| paddle.framework | 框架通用API和动态图模式的API，包括 no_grad 、 |
| | save 、 load 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.device | 设备管理相关API，如 set_device, get_device 等 |
| paddle.device | 设备管理相关API，包括 set_device, get_device 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.amp | paddle自动混合精度策略，包括 auto_cast 、 |
| paddle.amp | 自动混合精度策略，包括 auto_cast 、 |
| | GradScaler 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.callbacks | paddle日志回调类，包括 ModelCheckpoint 、 |
| paddle.autograd | 自动求导相关API，包括 backward、PyLayer 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.callbacks | 日志回调类，包括 ModelCheckpoint 、 |
| | ProgBarLogger 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.nn | 组网相关的API，例如 Linear 、卷积 Conv2D 、 |
| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss 、 |
| | 激活函数 ReLU 等。 |
| paddle.distributed | 分布式相关基础API |
+-------------------------------+-------------------------------------------------------+
| paddle.static | 静态图下基础框架相关API，比如：Variable, Program, |
| | Executor等 |
| paddle.distributed.fleet | 分布式相关高层API |
+-------------------------------+-------------------------------------------------------+
| paddle.static.nn | 静态图下组网专用API，例如全连接层 fc 、控制流 |
| | while_loop/cond 。 |
| paddle.hub | 模型拓展相关的API，包括 list、load、help 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.onnx | paddle转换为onnx协议相关API，比如：export |
| paddle.io | 数据输入输出相关API，包括 Dataset, DataLoader 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.optimizer | 优化算法相关API，比如：SGD，Adagrad, Adam等 |
| paddle.jit | 动态图转静态图相关API，包括 to_static、 |
| | ProgramTranslator、TracedLayer 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.optimizer.lr | 学习率衰减相关API，例如 NoamDecay 、 StepDecay 、 |
| | PiecewiseDecay 等。 |
| paddle.metric | 评估指标计算相关的API，包括 Accuracy, Auc等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.metric | 评估指标计算相关的API，比如：Accuracy, Auc等。 |
| paddle.nn | 组网相关的API，包括 Linear 、卷积 Conv2D 、 |
| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss 、 |
| | 激活函数 ReLU 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.io | 数据输入输出相关API，比如：Dataset, DataLoader 等。 |
| paddle.onnx | paddle转换为onnx协议相关API，包括 export 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.distributed | 分布式相关基础API |
| paddle.optimizer | 优化算法相关API，包括 SGD，Adagrad, Adam 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.distributed.fleet | 分布式相关高层API |
| paddle.optimizer.lr | 学习率衰减相关API，包括 NoamDecay 、 StepDecay 、 |
| | PiecewiseDecay 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.vision | 视觉领域API，例如数据集 Cifar10 、数据处理 ColorJitter|
| | 、常用基础网络结构 ResNet 等。 |
| paddle.regularizer | 正则化相关API，包括 L1Decay、L2Decay 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.static | 静态图下基础框架相关API，包括 Variable, Program, |
| | Executor等 |
+-------------------------------+-------------------------------------------------------+
| paddle.text | NLP领域API，目前包括NLP领域相关的数据集， |
| paddle.static.nn | 静态图下组网专用API，包括 全连接层 fc 、控制流 |
| | while_loop/cond 。 |
+-------------------------------+-------------------------------------------------------+
| paddle.text | NLP领域API，包括NLP领域相关的数据集， |
| | 如 Imdb 、 Movielens 。 |
+-------------------------------+-------------------------------------------------------+
| paddle.utils | 工具类相关API，包括 CppExtension、CUDAExtension 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.vision | 视觉领域API，包括 数据集 Cifar10 、数据处理 |
| | ColorJitter、常用基础网络结构 ResNet 等。 |
+-------------------------------+-------------------------------------------------------+
47 changes: 27 additions & 20 deletions docs/api/index_en.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,28 @@ In this version, PaddlePaddle has made many optimizations to the APIs. You can r
| paddle.amp | Paddle automatic mixed precision strategy, including |
| | auto_cast, GradScaler, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.autograd | Auto grad API, including backward, PyLayer, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.callbacks | Paddle log callback APIs, including ModelCheckpoint, |
| | ProgBarLogger, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.nn | Networking-related APIs such as Linear, Conv2D, |
| | CrossEntropyLoss, RNN，and ReLU |
| paddle.distributed | Distributed related basic APIs. |
+-------------------------------+-------------------------------------------------------+
| paddle.static | Basic framework related APIs under static graph, |
| | such as Variable, Program, Executor, etc. |
| paddle.distributed.fleet | Distributed related high-level APIs. |
+-------------------------------+-------------------------------------------------------+
| paddle.static.nn | Special APIs for networking under static graph such |
| | as full connect layer fc and control flow |
| | while_loop/cond |
| paddle.hub | Model extension API, including list, load, help, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.framework | Universal APIs and imprerative mode APIs such as |
| | to_variable and prepare_context |
| paddle.io | APIs related to data input and output such as |
| | Dataset, and DataLoader |
+-------------------------------+-------------------------------------------------------+
| paddle.jit | Dynamic graph to static graph APIs, including |
| | to_static, ProgramTranslator, TracedLayer, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.metric | APIs related to evaluation computation such as |
| | Accuracy and Auc. |
+-------------------------------+-------------------------------------------------------+
| paddle.nn | Networking-related APIs such as Linear, Conv2D, |
| | CrossEntropyLoss, RNN，and ReLU, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.onnx | APIs related to convert paddle model to ONNX，such as |
| | export |
Expand All @@ -54,22 +61,22 @@ In this version, PaddlePaddle has made many optimizations to the APIs. You can r
| paddle.optimizer.lr | APIs related to learning rate decay, such as |
| | NoamDecay, StepDecay, PiecewiseDecay, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.metric | APIs related to evaluation computation such as |
| | Accuracy and Auc |
| paddle.regularizer | Regularization APIs, including L1Decay, L2Decay, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.io | APIs related to data input and output such as |
| | Dataset, and DataLoader |
| paddle.static | Basic framework related APIs under static graph, |
| | such as Variable, Program, Executor, etc. |
+-------------------------------+-------------------------------------------------------+
| paddle.static.nn | Special APIs for networking under static graph such |
| | as full connect layer fc and control flow |
| | while_loop/cond |
+-------------------------------+-------------------------------------------------------+
| paddle.distributed | Distributed related basic APIs |
| | |
| paddle.text | The NLP domain API currently includes data sets |
| | related to the NLP domain, such as Imdb and Movielens.|
+-------------------------------+-------------------------------------------------------+
| paddle.distributed.fleet | Distributed related high-level APIs |
| | |
| paddle.utils | Utils APIs, including CppExtension, CUDAExtension. |
+-------------------------------+-------------------------------------------------------+
| paddle.vision | Vision domain APIs such as datasets Cifar10, |
| | data processing ColorJitter, and commonly used models |
| | like resnet |
+-------------------------------+-------------------------------------------------------+
| paddle.text | The NLP domain API currently includes data sets |
| | related to the NLP domain, such as Imdb and Movielens.|
+-------------------------------+-------------------------------------------------------+

Loading

0 comments on commit b4b2ea1

Please sign in to comment.