diff --git a/doc/fluid/advanced_usage/deploy/inference/index_cn.rst b/doc/fluid/advanced_usage/deploy/inference/index_cn.rst index 7f7a0a1020613712b9f3368fb9bec44c01a7b555..f22d1c19a8b2c4634eb56b77cf1b53eb4edc7fe0 100644 --- a/doc/fluid/advanced_usage/deploy/inference/index_cn.rst +++ b/doc/fluid/advanced_usage/deploy/inference/index_cn.rst @@ -5,7 +5,7 @@ PaddlePaddle Fluid 提供了 C++ API 来支持模型的部署上线 .. toctree:: - :hidden: + :titlesonly: build_and_install_lib_cn.rst native_infer.md diff --git a/doc/fluid/advanced_usage/development/profiling/index_cn.rst b/doc/fluid/advanced_usage/development/profiling/index_cn.rst index 7baf05134332ec22e8db837aad05877e01fab558..db40144354e9acbdf061834ccbbe6b7fc3518a6f 100644 --- a/doc/fluid/advanced_usage/development/profiling/index_cn.rst +++ b/doc/fluid/advanced_usage/development/profiling/index_cn.rst @@ -2,6 +2,15 @@ 性能调优 ########## +.. toctree:: + :hidden: + + benchmark.rst + cpu_profiling_cn.md + gpu_profiling_cn.rst + host_memory_profiling_cn.md + timeline_cn.md + 本模块介绍 Fluid 使用过程中的调优方法，包括： - `如何进行基准测试 `_：介绍如何选择基准模型，从而验证模型的精度和性能 @@ -11,11 +20,3 @@ - `Timeline工具简介 `_ ：介绍如何使用 Timeline 工具进行性能分析和调优 -.. toctree:: - :hidden: - - benchmark.rst - cpu_profiling_cn.md - gpu_profiling_cn.rst - host_memory_profiling_cn.md - timeline_cn.md diff --git a/doc/fluid/api/api_guides/high_low_level_api.md b/doc/fluid/api/api_guides/high_low_level_api.md index 8ce2695737c45306c9a0944c35b2e865ce380f05..d95a2f89eb6913ed0b23ce7eaf0613ec44529356 100644 --- a/doc/fluid/api/api_guides/high_low_level_api.md +++ b/doc/fluid/api/api_guides/high_low_level_api.md @@ -1,15 +1,15 @@ ## High/Low-level API简介 -Paddle目前有2套API接口： +PaddlePaddle Fluid目前有2套API接口： - Low-level（底层） API： - 灵活性强并且已经相对成熟，使用它训练的模型，能直接支持C++预测上线。 - - 提供了大量的模型作为使用示例，包括[Book](https://github.com/PaddlePaddle/book)中的第7和8章，以及[models](https://github.com/PaddlePaddle/models)中的所有章节。 + - 提供了大量的模型作为使用示例，包括[Book](https://github.com/PaddlePaddle/book)中的全部章节，以及[models](https://github.com/PaddlePaddle/models)中的所有章节。 - 适用人群：对深度学习有一定了解，需要自定义网络进行训练/预测/上线部署的用户。 - High-level（高层）API： - - 使用简单，[Book](https://github.com/PaddlePaddle/book)中前六章提供了示例。 + - 使用简单 - 尚未成熟，接口暂时在[paddle.fluid.contrib](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle/fluid/contrib)下面。 - 适用人群：想通过Book课程进行深度学习基础知识学习的初级用户。 diff --git a/doc/fluid/api_cn/api_guides/high_low_level_api.md b/doc/fluid/api_cn/api_guides/high_low_level_api.md index 8ce2695737c45306c9a0944c35b2e865ce380f05..b4483654058308cde9ef6c8a2e3ec4051c298e37 100644 --- a/doc/fluid/api_cn/api_guides/high_low_level_api.md +++ b/doc/fluid/api_cn/api_guides/high_low_level_api.md @@ -1,15 +1,14 @@ ## High/Low-level API简介 -Paddle目前有2套API接口： +PaddlePaddle Fluid目前有2套API接口： - Low-level（底层） API： - 灵活性强并且已经相对成熟，使用它训练的模型，能直接支持C++预测上线。 - - 提供了大量的模型作为使用示例，包括[Book](https://github.com/PaddlePaddle/book)中的第7和8章，以及[models](https://github.com/PaddlePaddle/models)中的所有章节。 + - 提供了大量的模型作为使用示例，包括[Book](https://github.com/PaddlePaddle/book)中的全部章节，以及[models](https://github.com/PaddlePaddle/models)中的所有章节。 - 适用人群：对深度学习有一定了解，需要自定义网络进行训练/预测/上线部署的用户。 - High-level（高层）API： - - 使用简单，[Book](https://github.com/PaddlePaddle/book)中前六章提供了示例。 + - 使用简单 - 尚未成熟，接口暂时在[paddle.fluid.contrib](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle/fluid/contrib)下面。 - - 适用人群：想通过Book课程进行深度学习基础知识学习的初级用户。 diff --git a/doc/fluid/api_cn/api_guides/index.rst b/doc/fluid/api_cn/api_guides/index.rst index fbbad453b24a0719951941974ed9df1e27c842dd..eddf57060d81d6069dce5bf4ac2fe799a0293eea 100755 --- a/doc/fluid/api_cn/api_guides/index.rst +++ b/doc/fluid/api_cn/api_guides/index.rst @@ -2,8 +2,10 @@ API使用指南 =========== -.. toctree:: - :hidden: +API使用指南分功能向您介绍PaddlePaddle Fluid的API体系和用法，帮助您快速了解PaddlePaddle Fluid API的全貌，包括以下几个模块： + +.. toctree:: + :titlesonly: high_low_level_api.md low_level/layers/index.rst diff --git a/doc/fluid/api_cn/index_cn.rst b/doc/fluid/api_cn/index_cn.rst index ee9689c3f28842e17f2791e0a41c9328fa729ab4..fb9dbb1896ee744364ef4927e2a07141f6edd038 100644 --- a/doc/fluid/api_cn/index_cn.rst +++ b/doc/fluid/api_cn/index_cn.rst @@ -1,6 +1,6 @@ -============= -API Reference -============= +===== +API +===== .. toctree:: :maxdepth: 1 @@ -12,7 +12,6 @@ API Reference clip_cn.rst data_feeder_cn.rst executor_cn.rst - index_cn.rst initializer_cn.rst io_cn.rst layers_cn.rst diff --git a/doc/fluid/beginners_guide/index.rst b/doc/fluid/beginners_guide/index.rst index a2c7d74254a7f54eebb9f5bb998c4c6ae991dcce..5cade329fd16bfe2652cf59052e950822b64ed79 100644 --- a/doc/fluid/beginners_guide/index.rst +++ b/doc/fluid/beginners_guide/index.rst @@ -8,7 +8,7 @@ PaddlePaddle (PArallel Distributed Deep LEarning)是一个易用、高效、灵 当您第一次来到PaddlePaddle，请您首先阅读以下文档，了解安装方法： - - `安装说明 <../beginners_guide/install/Start.html>`_：我们支持在Ubuntu/CentOS/Windows/MacOS环境上的安装 + - `安装说明 <../beginners_guide/install/index_cn.html>`_：我们支持在Ubuntu/CentOS/Windows/MacOS环境上的安装 如果您初次接触深度学习，在学习PaddlePaddle之前建议您先阅读以下资料： @@ -18,8 +18,6 @@ PaddlePaddle (PArallel Distributed Deep LEarning)是一个易用、高效、灵 - `Fluid编程指南 <../beginners_guide/programming_guide/programming_guide.html>`_：介绍 Fluid 的基本概念和使用方法 - - `Fluid编程指南 <../beginners_guide/programming_guide/programming_guide.html>`_：介绍 Fluid 的基本概念和使用方法 - - `快速入门 <../beginners_guide/quick_start/index.html>`_：提供线性回归和识别数字两个入门级模型，帮助您快速上手训练网络 - `深度学习基础 <../beginners_guide/basics/index.html>`_：覆盖图像分类、个性化推荐、机器翻译等多个深度领域的基础知识，提供 Fluid 实现案例 diff --git a/doc/fluid/beginners_guide/install/FAQ.md b/doc/fluid/beginners_guide/install/FAQ.md index 80a5dd92fbdf4b2f6188c705741ddd0a10b10d9c..97455a1f70d209814c6aa35abbf116aa3f5c8df0 100644 --- a/doc/fluid/beginners_guide/install/FAQ.md +++ b/doc/fluid/beginners_guide/install/FAQ.md @@ -1,5 +1,6 @@ *** - + + # **FAQ** - CentOS6下如何编译python2.7为共享库? diff --git a/doc/fluid/beginners_guide/install/compile/fromsource.rst b/doc/fluid/beginners_guide/install/compile/fromsource.rst index a591c3f106a5ab7ccbcb323d18693d0a0bbb5676..72f5256ce2d4cce6d847e1689e1ceac101b8ad17 100644 --- a/doc/fluid/beginners_guide/install/compile/fromsource.rst +++ b/doc/fluid/beginners_guide/install/compile/fromsource.rst @@ -1,5 +1,5 @@ =========================== -**从源码编译PaddlePaddle** +**从源码编译** =========================== 您也可以选择源码编译的方式编译安装PaddlePaddle，但由于本机环境的多样性，在编译源码时易出现复杂问题，可能会造成您安装失败。为保证您顺利安装，推荐您优先选择普通安装方式。 diff --git a/doc/fluid/beginners_guide/quick_start/index.rst b/doc/fluid/beginners_guide/quick_start/index.rst index 2d93e45b904f532e44be9c0bac5d4e30587e4ae8..69e45881ab2efe93dab1a0b5dceca63dae9ef8f0 100644 --- a/doc/fluid/beginners_guide/quick_start/index.rst +++ b/doc/fluid/beginners_guide/quick_start/index.rst @@ -2,9 +2,7 @@ 快速入门 ######## -.. todo:: - - 概述 +欢迎来到快速入门部分，在这里，我们将向您介绍如何通过PaddlePaddle Fluid实现经典的线性回归和手写识别的模型，以下两篇文档将指导您使用真实数据集搭建起模型、进行训练和预测： .. toctree:: :titlesonly: diff --git a/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst b/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst index bb0ec018522fe99d077f1f0775ffd195f4816b60..72e9c314bceb6f23b3439d094f1c3b097b7a9b2f 100644 --- a/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst +++ b/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst @@ -2,8 +2,14 @@ 模型评估/调试 ############### +本部分包括两篇文档： + +- `模型评估 <../user_guides/howto/evaluation_and_debugging/evaluation/metrics.html>`_：介绍常用模型评估指标的构造方法 + +- `Visual DL 工具 <../user_guides/howto/evaluation_and_debugging/debug/visualdl.html>`_：介绍如何利用 Visual DL 工具可视化训练过程 + .. toctree:: - :maxdepth: 1 + :hidden: evaluation/metrics.rst debug/visualdl.md diff --git a/doc/fluid/user_guides/howto/prepare_data/use_py_reader.rst b/doc/fluid/user_guides/howto/prepare_data/use_py_reader.rst index 6e1374f99c2e42898a8486da2e70526e66646c9e..7baa069b43de6c0f676ae9ebc4c4e1bf5e3524e6 100644 --- a/doc/fluid/user_guides/howto/prepare_data/use_py_reader.rst +++ b/doc/fluid/user_guides/howto/prepare_data/use_py_reader.rst @@ -1,4 +1,4 @@ -.. _user_guide_use_py_reader: +.. _user_guides_use_py_reader: ############################ 使用PyReader读取训练和测试数据 diff --git a/doc/fluid/user_guides/howto/training/cluster_howto.rst b/doc/fluid/user_guides/howto/training/cluster_howto.rst index 8250fcfbac3a0d089bd4a207bd12d5ec9a7cb40c..7d488cc118e83c136db7968c8971cb13ad20f687 100644 --- a/doc/fluid/user_guides/howto/training/cluster_howto.rst +++ b/doc/fluid/user_guides/howto/training/cluster_howto.rst @@ -1,6 +1,6 @@ -.. _cluster_howto +.. _cluster_howto: -Fluid分布式训练使用手册 +分布式训练使用手册 ==================== 分布式训练基本思想 @@ -174,7 +174,7 @@ parameter server上。如果需要使用其他，可以传入其他的方法， .. code-block:: python - if role == "TRAINER": + if role == "TRAINER": fluid.memory_optimize(fluid.default_main_program(), skip_grads=True) t = fluid.DistributeTranspiler() t.transpile(trainer_id, pservers=pserver_endpoints, trainers=trainers) diff --git a/doc/fluid/user_guides/howto/training/index.rst b/doc/fluid/user_guides/howto/training/index.rst index f021e7f3bbde81413d60dc1c94e5c397c9114ae7..e517bf72e7a56889d3e1f9d2b812ea6debf5dc9e 100644 --- a/doc/fluid/user_guides/howto/training/index.rst +++ b/doc/fluid/user_guides/howto/training/index.rst @@ -2,7 +2,7 @@ 训练神经网络 ############ -PaddlePaddle Fluid支持单机训练，和多节点训练。每种训练模式下，都支持多种训练方法。 +PaddlePaddle Fluid支持单机训练和多节点训练。每种训练模式下，都支持多种训练方法，本部分包含以下内容： .. toctree:: :maxdepth: 1 diff --git a/doc/fluid/user_guides/howto/training/train_on_baidu_cloud_cn.rst b/doc/fluid/user_guides/howto/training/train_on_baidu_cloud_cn.rst index 76bb9f49220600ebfec78b388bc0a75c0901e746..71d610ad5342a049e1f67fb6650c5081bd128563 100644 --- a/doc/fluid/user_guides/howto/training/train_on_baidu_cloud_cn.rst +++ b/doc/fluid/user_guides/howto/training/train_on_baidu_cloud_cn.rst @@ -1,6 +1,6 @@ -.. _train_on_baidu_cloud_cn +.. _train_on_baidu_cloud_cn: -在百度云上启动Fluid分布式训练 +在百度云启动Fluid分布式训练 ========================= PaddlePaddle Fluid分布式训练，可以不依赖集群系统（比如MPI，Kubernetes）启动分布式训练。 @@ -113,7 +113,7 @@ PaddlePaddle Fluid分布式训练，可以不依赖集群系统（比如MPI，Ku exe.run(fluid.default_startup_program()) - + for pass_id in range(PASS_NUM): for batch_id, data in enumerate(train_reader()): acc_np, avg_loss_np = exe.run(fluid.default_main_program(), @@ -155,7 +155,7 @@ PaddlePaddle Fluid分布式训练，可以不依赖集群系统（比如MPI，Ku 假设我们创建了2台GPU服务器，ip分别是 :code:`172.16.0.5,172.16.0.6` ，然后在第一台服务器上， 先创建训练程序文件 :code:`dist_train_demo.py` ，从 -`这里 `_ +`这里 `_ 下载代码。然后编写 :code:`fabfile.py` 脚本，用于控制在不同服务器上启动训练任务的parameter server和trainer： .. code-block:: python @@ -225,4 +225,4 @@ PaddlePaddle Fluid分布式训练，可以不依赖集群系统（比如MPI，Ku 任务执行完成后，不要忘记释放掉GPU集群资源，勾选选择需要释放的服务器，选择“释放”，则会关闭机器并释放资源。 如果需要执行新的任务，可以直接使用之前保存的镜像，启动新的集群，并参照前面的步骤开始训练。 -.. image:: src/release.png \ No newline at end of file +.. image:: src/release.png diff --git a/doc/fluid/user_guides/index.rst b/doc/fluid/user_guides/index.rst index f828f3d0b8b81af99561080e3010382b40402af8..d65f0c34565d5ab4a544a44bacb13f107b4cddcd 100644 --- a/doc/fluid/user_guides/index.rst +++ b/doc/fluid/user_guides/index.rst @@ -6,7 +6,7 @@ 如果您已经掌握了新手入门阶段的内容，期望可以针对实际问题建模、搭建自己网络，本模块提供了一些 Fluid 的使用细节供您参考： - - `基本概念 <../user_guides/howto/basic_concept/index_cn.rst>`_ ：介绍了Fluid的基本使用概念 + - `基本概念 <../user_guides/howto/basic_concept/index_cn.html>`_ ：介绍了Fluid的基本使用概念 - `准备数据 <../user_guides/howto/prepare_data/index.html>`_ ：介绍使用 Fluid 训练网络时，数据的支持类型及传输方法 @@ -16,9 +16,6 @@ - `模型评估与调试 <../user_guides/howto/evaluation_and_debugging/index.html>`_：介绍在 Fluid 下进行模型评估和调试的方法，包括： - - `模型评估 <../user_guides/howto/evaluation_and_debugging/evaluation/metrics.html>`_：介绍常用模型评估指标的构造方法 - - `Visual DL 工具 <../user_guides/howto/evaluation_and_debugging/debug/visualdl.html>`_：介绍如何利用 Visual DL 工具可视化训练过程 - 基于 Fluid 复现的多领域经典模型： - `Fluid 模型库 <../user_guides/models/index_cn.html>`_