fix_some_doc bugs (PaddlePaddle#2858)

* fix_some_doc bugs * fix alias mapping
Joejiong · Nov 9, 2020 · 2011df7 · 2011df7
1 parent 094ccf8
commit 2011df7
Show file tree

Hide file tree

Showing 11 changed files with 11 additions and 7 deletions.
diff --git a/doc/paddle/api/alias_api_mapping b/doc/paddle/api/alias_api_mapping
@@ -78,6 +78,11 @@ paddle.fluid.layers.sinh	paddle.sinh,paddle.tensor.sinh,paddle.tensor.math.sinh
 paddle.tensor.manipulation.expand_as	paddle.expand_as,paddle.tensor.expand_as
 paddle.fluid.layers.crf_decoding	paddle.static.nn.crf_decoding
 paddle.fluid.framework.default_main_program	paddle.static.default_main_program
+paddle.device.get_device	paddle.get_device
+paddle.device.set_device	paddle.set_device
+paddle.device.get_cudnn_version	paddle.get_cudnn_version
+paddle.device.XPUPlace	paddle.XPUPlace
+paddle.device.is_compiled_with_xpu	paddle.is_compiled_with_xpu
 paddle.fluid.framework.is_compiled_with_cuda	paddle.is_compiled_with_cuda,paddle.device.is_compiled_with_cuda
 paddle.fluid.layers.log_loss	paddle.nn.functional.log_loss,paddle.nn.functional.loss.log_loss
 paddle.fluid.layers.softmax_with_cross_entropy	paddle.nn.functional.softmax_with_cross_entropy,paddle.nn.functional.loss.softmax_with_cross_entropy

diff --git a/doc/paddle/api/index_cn.rst b/doc/paddle/api/index_cn.rst
@@ -13,14 +13,16 @@ API 文档
 +===============================+=======================================================+
 | paddle.\*                     | paddle                                                |
 |                               | 根目录下保留了常用API的别名，当前包括：paddle.tensor, |
-|                               | paddle.framework目录下的所有API                       |
+|                               | paddle.framework, paddle.device 目录下的所有API       |
 +-------------------------------+-------------------------------------------------------+
 | paddle.tensor                 | 跟tensor操作相关的API，如：创建zeros,                 |
 |                               | 矩阵运算matmul, 变换concat, 计算add, 查找argmax等     |
 +-------------------------------+-------------------------------------------------------+
 | paddle.framework              | 框架通用API和动态图模式的API，例如 no_grad 、         |
 |                               | save 、 load 等。                                     |
 +-------------------------------+-------------------------------------------------------+
+| paddle.device                 | 设备管理相关API，如 set_device, get_device 等         |
++-------------------------------+-------------------------------------------------------+
 | paddle.amp                    | paddle自动混合精度策略，包括 auto_cast 、             |
 |                               | GradScaler 等。                                       |
 +-------------------------------+-------------------------------------------------------+
@@ -46,8 +48,6 @@ API 文档
 +-------------------------------+-------------------------------------------------------+
 | paddle.io                     | 数据输入输出相关API，比如：Dataset, DataLoader 等。   |
 +-------------------------------+-------------------------------------------------------+
-| paddle.device                 | 设备管理相关API，比如：CPUPlace， CUDAPlace等         |
-+-------------------------------+-------------------------------------------------------+
 | paddle.distributed            | 分布式相关基础API                                     |
 +-------------------------------+-------------------------------------------------------+
 | paddle.distributed.fleet      | 分布式相关高层API                                     |

diff --git a/...pi/paddle/vision/datasets/Cifar100_cn.rst → ...dle/vision/datasets/cifar/Cifar100_cn.rst b/...pi/paddle/vision/datasets/Cifar100_cn.rst → ...dle/vision/datasets/cifar/Cifar100_cn.rst
diff --git a/...api/paddle/vision/datasets/Cifar10_cn.rst → ...ddle/vision/datasets/cifar/Cifar10_cn.rst b/...api/paddle/vision/datasets/Cifar10_cn.rst → ...ddle/vision/datasets/cifar/Cifar10_cn.rst
diff --git a/...api/paddle/vision/datasets/Flowers_cn.rst → ...le/vision/datasets/flowers/Flowers_cn.rst b/...api/paddle/vision/datasets/Flowers_cn.rst → ...le/vision/datasets/flowers/Flowers_cn.rst
diff --git a/...e/api/paddle/vision/datasets/MNIST_cn.rst → ...paddle/vision/datasets/mnist/MNIST_cn.rst b/...e/api/paddle/vision/datasets/MNIST_cn.rst → ...paddle/vision/datasets/mnist/MNIST_cn.rst
diff --git a/...api/paddle/vision/datasets/VOC2012_cn.rst → ...le/vision/datasets/voc2012/VOC2012_cn.rst b/...api/paddle/vision/datasets/VOC2012_cn.rst → ...le/vision/datasets/voc2012/VOC2012_cn.rst
diff --git a/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06.png b/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06.png
diff --git a/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06_v2.png b/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06_v2.png
diff --git a/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade_cn.rst b/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade_cn.rst
@@ -17,7 +17,7 @@
 .. image:: https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image05.png?raw=true
 
 
-.. image:: https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06.png?raw=true
+.. image:: https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image06_v2.png?raw=true
 
 
 .. image:: https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/paddle/guides/01_paddle2.0_introduction/main_upgrade/image07.png?raw=true

diff --git a/doc/paddle/tutorial/quick_start/high_level_api/high_level_api.rst b/doc/paddle/tutorial/quick_start/high_level_api/high_level_api.rst
@@ -448,10 +448,9 @@ paddle即可使用相关高层API，如：paddle.Model、视觉领域paddle.visi
     step 1875/1875 [==============================] - loss: 0.0700 - acc: 0.9462 - 11ms/step          
 
 
-注：
-^^^^
+.. note::
 
-``fit()``\ 的第一个参数不仅可以传递数据集\ ``paddle.io.Dataset``\ ，还可以传递DataLoader，如果想要实现某个自定义的数据集抽样等逻辑，可以在fit外自定义DataLoader，然后传递给fit函数。
+    \``fit()``\ 的第一个参数不仅可以传递数据集\ ``paddle.io.Dataset``\ ，还可以传递DataLoader，如果想要实现某个自定义的数据集抽样等逻辑，可以在fit外自定义DataLoader，然后传递给fit函数。
 
 .. code:: python