Skip to content

Commit

Permalink
fix malformed table in api index page (#5133)
Browse files Browse the repository at this point in the history
  • Loading branch information
SigureMo authored Aug 16, 2022
1 parent 4aa6e65 commit 73522d0
Showing 1 changed file with 71 additions and 71 deletions.
142 changes: 71 additions & 71 deletions docs/api/index_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,78 +2,78 @@
API 文档
==================

欢迎使用飞桨框架(PaddlePaddle), PaddlePaddle 是一个易用、高效、灵活、可扩展的深度学习框架,致力于让深度学习技术的创新与应用更简单。
欢迎使用飞桨框架PaddlePaddle),PaddlePaddle 是一个易用、高效、灵活、可扩展的深度学习框架,致力于让深度学习技术的创新与应用更简单。

在本版本中,飞桨框架对 API 做了许多优化,您可以参考下表来了解飞桨框架最新版的 API 目录结构与说明。更详细的说明,请参见 `版本说明 <../release_note_cn.html>`_ 。此外,您可参考 PaddlePaddle 的 `GitHub <https://github.com/PaddlePaddle/Paddle>`_ 了解详情。

**注: paddle.fluid.\*, paddle.dataset.\* 会在未来的版本中废弃,请您尽量不要使用这两个目录下的 API。**
**注: paddle.fluid.\*paddle.dataset.\* 会在未来的版本中废弃,请您尽量不要使用这两个目录下的 API。**

+-------------------------------+-------------------------------------------------------+
| 目录 | 功能和包含的 API |
+===============================+=======================================================+
| paddle.\* | paddle |
| | 根目录下保留了常用 API 的别名,包括:paddle.tensor, |
| | paddle.framework, paddle.device 目录下的所有 API |
+-------------------------------+-------------------------------------------------------+
| paddle.tensor | Tensor 操作相关的 API,包括 创建 zeros, |
| | 矩阵运算 matmul, 变换 concat, 计算 add, 查找 argmax 等 |
+-------------------------------+-------------------------------------------------------+
| paddle.framework | 框架通用 API 和动态图模式的 API,包括 no_grad |
| | saveload 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.device | 设备管理相关 API,包括 set_device, get_device 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.linalg | 线性代数相关 API,包括 det, svd 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.fft | 快速傅里叶变换的相关 API,包括 fft, fft2 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.amp | 自动混合精度策略,包括 auto_cast |
| | GradScaler 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.autograd | 自动求导相关 API,包括 backward、PyLayer 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.callbacks | 日志回调类,包括 ModelCheckpoint |
| | ProgBarLogger 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.distributed | 分布式相关基础 API。 |
+-------------------------------+-------------------------------------------------------+
| paddle.distributed.fleet | 分布式相关高层 API。 |
+-------------------------------+-------------------------------------------------------+
| paddle.hub | 模型拓展相关的 API,包括 list、load、help 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.io | 数据输入输出相关 API,包括 Dataset, DataLoader 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.jit | 动态图转静态图相关 API,包括 to_static、 |
| | ProgramTranslator、TracedLayer 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.metric | 评估指标计算相关的 API,包括 Accuracy, Auc 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.nn | 组网相关的 API,包括 Linear 、卷积 Conv2D |
| | 循环神经网络 RNN 、损失函数 CrossEntropyLoss |
| | 激活函数 ReLU 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.onnx | paddle 转换为 onnx 协议相关 API,包括 export 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.optimizer | 优化算法相关 API,包括 SGD,Adagrad, Adam 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.optimizer.lr | 学习率衰减相关 API,包括 NoamDecayStepDecay |
| | PiecewiseDecay 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.regularizer | 正则化相关 API,包括 L1Decay、L2Decay 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.static | 静态图下基础框架相关 API,包括 Variable, Program, |
| | Executor 等 |
+-------------------------------+-------------------------------------------------------+
| paddle.static.nn | 静态图下组网专用 API,包括 全连接层 fc 、控制流 |
| | while_loop/cond |
+-------------------------------+-------------------------------------------------------+
| paddle.text | NLP 领域 API,包括 NLP 领域相关的数据集, |
| | 如 ImdbMovielens |
+-------------------------------+-------------------------------------------------------+
| paddle.utils | 工具类相关 API,包括 CppExtension、CUDAExtension 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.vision | 视觉领域 API,包括 数据集 Cifar10 、数据处理 |
| | ColorJitter、常用基础网络结构 ResNet 等。 |
+-------------------------------+-------------------------------------------------------+
| paddle.sparse | 稀疏领域的 API。 |
+-------------------------------+-------------------------------------------------------+
+--------------------------+----------------------------------------------------------+
| 目录 | 功能和包含的 API |
+==========================+==========================================================+
| paddle.\* | paddle |
| | 根目录下保留了常用 API 的别名,包括:paddle.tensor |
| | paddle.frameworkpaddle.device 目录下的所有 API |
+--------------------------+----------------------------------------------------------+
| paddle.tensor | Tensor 操作相关的 API,包括 创建 zeros |
| | 矩阵运算 matmul变换 concat计算 add查找 argmax 等 |
+--------------------------+----------------------------------------------------------+
| paddle.framework | 框架通用 API 和动态图模式的 API,包括 no_grad |
| | saveload 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.device | 设备管理相关 API,包括 set_deviceget_device 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.linalg | 线性代数相关 API,包括 detsvd 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.fft | 快速傅里叶变换的相关 API,包括 fftfft2 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.amp | 自动混合精度策略,包括 auto_cast |
| | GradScaler 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.autograd | 自动求导相关 API,包括 backward、PyLayer 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.callbacks | 日志回调类,包括 ModelCheckpoint |
| | ProgBarLogger 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.distributed | 分布式相关基础 API。 |
+--------------------------+----------------------------------------------------------+
| paddle.distributed.fleet | 分布式相关高层 API。 |
+--------------------------+----------------------------------------------------------+
| paddle.hub | 模型拓展相关的 API,包括 list、load、help 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.io | 数据输入输出相关 API,包括 DatasetDataLoader 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.jit | 动态图转静态图相关 API,包括 to_static、 |
| | ProgramTranslator、TracedLayer 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.metric | 评估指标计算相关的 API,包括 AccuracyAuc 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.nn | 组网相关的 API,包括 Linear、卷积 Conv2D |
| | 循环神经网络 RNN、损失函数 CrossEntropyLoss |
| | 激活函数 ReLU 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.onnx | paddle 转换为 onnx 协议相关 API,包括 export 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.optimizer | 优化算法相关 API,包括 SGD,AdagradAdam 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.optimizer.lr | 学习率衰减相关 API,包括 NoamDecayStepDecay |
| | PiecewiseDecay 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.regularizer | 正则化相关 API,包括 L1Decay、L2Decay 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.static | 静态图下基础框架相关 API,包括 VariableProgram |
| | Executor 等 |
+--------------------------+----------------------------------------------------------+
| paddle.static.nn | 静态图下组网专用 API,包括 全连接层 fc、控制流 |
| | while_loop/cond |
+--------------------------+----------------------------------------------------------+
| paddle.text | NLP 领域 API,包括 NLP 领域相关的数据集, |
| | 如 ImdbMovielens |
+--------------------------+----------------------------------------------------------+
| paddle.utils | 工具类相关 API,包括 CppExtension、CUDAExtension 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.vision | 视觉领域 API,包括 数据集 Cifar10、数据处理 |
| | ColorJitter、常用基础网络结构 ResNet 等。 |
+--------------------------+----------------------------------------------------------+
| paddle.sparse | 稀疏领域的 API。 |
+--------------------------+----------------------------------------------------------+

0 comments on commit 73522d0

Please sign in to comment.