diff --git a/doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst b/doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst index 4b0254656562197802986401f0ff5c6f149a7a3a..a2cb0b18d9f3ed6eaa0c1728a6b21d26f313e63c 100644 --- a/doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst +++ b/doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst @@ -3,7 +3,7 @@ ############ .. toctree:: - :maxdepth: 2 + :maxdepth: 1 local_dev_guide.md submit_pr_guide.md diff --git a/doc/fluid/advanced_usage/development/profiling/index_cn.rst b/doc/fluid/advanced_usage/development/profiling/index_cn.rst index 2a20389a094ac8c9bc68b083d9d83890ef481492..7baf05134332ec22e8db837aad05877e01fab558 100644 --- a/doc/fluid/advanced_usage/development/profiling/index_cn.rst +++ b/doc/fluid/advanced_usage/development/profiling/index_cn.rst @@ -2,13 +2,14 @@ 性能调优 ########## -介绍 Fluid 使用过程中的调优方法，包括： +本模块介绍 Fluid 使用过程中的调优方法，包括： + +- `如何进行基准测试 `_：介绍如何选择基准模型，从而验证模型的精度和性能 +- `CPU性能调优 `_：介绍如何使用 cProfile 包、yep库、Google perftools 进行性能分析与调优 +- `GPU性能调优 `_：介绍如何使用 Fluid 内置的定时工具、nvprof 或 nvvp 进行性能分析和调优 +- `堆内存分析和优化 `_：介绍如何使用 gperftool 进行堆内存分析和优化，以解决内存泄漏的问题 +- `Timeline工具简介 `_ ：介绍如何使用 Timeline 工具进行性能分析和调优 - - `如何进行基准测试 `_：介绍如何选择基准模型，从而验证模型的精度和性能 - - `CPU性能调优 `_：介绍如何使用 cProfile 包、yep库、Google perftools 进行性能分析与调优 - - `GPU性能调优 `_：介绍如何使用 Fluid 内置的定时工具、nvprof 或 nvvp 进行性能分析和调优 - - `堆内存分析和优化 `_：介绍如何使用 gperftool 进行堆内存分析和优化，以解决内存泄漏的问题 - - `Timeline工具简介 `_ ：介绍如何使用 Timeline 工具进行性能分析和调优 .. toctree:: :hidden: diff --git a/doc/fluid/api_cn/api_guides/index.rst b/doc/fluid/api_cn/api_guides/index.rst index fe96d6e912b872d92c3e36f7b464de496d27d098..dc8d04ad584f37c68ebae2c30b40bb7bca3b9bd1 100755 --- a/doc/fluid/api_cn/api_guides/index.rst +++ b/doc/fluid/api_cn/api_guides/index.rst @@ -3,7 +3,7 @@ API使用指南 =========== .. toctree:: - :titlesonly: + :hidden: high_low_level_api.md low_level/layers/index.rst diff --git a/doc/fluid/beginners_guide/index.rst b/doc/fluid/beginners_guide/index.rst index 7b22cd8f72e75b67919ecb33299485f039982951..f7759b92ce2e173c0a6bf82ea343e3d397d5719e 100644 --- a/doc/fluid/beginners_guide/index.rst +++ b/doc/fluid/beginners_guide/index.rst @@ -4,12 +4,7 @@ PaddlePaddle (PArallel Distributed Deep LEarning)是一个易用、高效、灵活、可扩展的深度学习框架 -您可参考我们的 `Github `_ 了解详情，也可阅读 `版本说明 <../release_note.html>`_ 了解新版本的特性 - - -========= - 概览 -========= +您可参考PaddlePaddle的 `Github `_ 了解详情，也可阅读 `版本说明 <../release_note.html>`_ 了解新版本的特性 当您第一次来到PaddlePaddle，请您首先阅读以下文档，了解安装方法： @@ -30,14 +25,10 @@ PaddlePaddle (PArallel Distributed Deep LEarning)是一个易用、高效、灵 - `深度学习基础知识 <../beginners_guide/basics/index.html>`_：覆盖图像分类、个性化推荐、机器翻译等多个深度领域的基础知识，提供 Fluid 实现案例 -========= - 目录 -========= - .. toctree:: - :maxdepth: 2 + :hidden: - install/Start.rst + install/index_cn.rst quick_start/index.rst basics/index.rst basics/learning_materials.md diff --git a/doc/fluid/beginners_guide/install/compile/fromsource.rst b/doc/fluid/beginners_guide/install/compile/fromsource.rst index afa77c3faec64b841e376a85761bf015a8b16933..a591c3f106a5ab7ccbcb323d18693d0a0bbb5676 100644 --- a/doc/fluid/beginners_guide/install/compile/fromsource.rst +++ b/doc/fluid/beginners_guide/install/compile/fromsource.rst @@ -4,10 +4,10 @@ 您也可以选择源码编译的方式编译安装PaddlePaddle，但由于本机环境的多样性，在编译源码时易出现复杂问题，可能会造成您安装失败。为保证您顺利安装，推荐您优先选择普通安装方式。 -**编译PaddlePaddle** ---------------------- .. toctree:: + :hidden: + compile_Ubuntu.md compile_CentOS.md compile_MacOS.md diff --git a/doc/fluid/beginners_guide/install/Start.rst b/doc/fluid/beginners_guide/install/index_cn.rst similarity index 66% rename from doc/fluid/beginners_guide/install/Start.rst rename to doc/fluid/beginners_guide/install/index_cn.rst index 5c0cd67f936328611582903e86c5eed07d56a183..6a0b896a195e95dcc28aebcc39e9568c84bc72de 100644 --- a/doc/fluid/beginners_guide/install/Start.rst +++ b/doc/fluid/beginners_guide/install/index_cn.rst @@ -10,13 +10,13 @@ 请确保您的环境满足以上条件 -- 如果您希望使用 `pip `_ 进行安装PaddlePaddle可以直接使用以下命令: +- 如果您希望使用 `pip `_ 进行安装PaddlePaddle可以直接使用以下命令: -:code:`pip install paddlepaddle` （CPU版本最新） - -:code:`pip install paddlepaddle-gpu` （GPU版本最新） - -:code:`pip install paddlepaddle==[pip版本号]` +:code:`pip install paddlepaddle` （CPU版本最新） + +:code:`pip install paddlepaddle-gpu` （GPU版本最新） + +:code:`pip install paddlepaddle==[pip版本号]` 其中[pip版本号]请查阅 `PyPi.org `_ @@ -25,28 +25,13 @@ 其中[docker版本号]请查阅 `DockerHub `_ - -如果对上面的指令有疑问或者不能正常使用，请参见以下内容 - -安装PaddlePaddle ------------------------ - .. toctree:: - :maxdepth:1 + :hidden: install_Ubuntu.md install_CentOS.md install_MacOS.md install_Windows.md compile/fromsource.rst - -参考信息 ------------------------ - -如在安装或编译过程中遇到问题请参见 - -.. toctree:: - :maxdepth:1 - FAQ.md Tables.md 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 e2395bc09ce5a9aad899601e17742a73cb621082..bb0ec018522fe99d077f1f0775ffd195f4816b60 100644 --- a/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst +++ b/doc/fluid/user_guides/howto/evaluation_and_debugging/index.rst @@ -3,7 +3,7 @@ ############### .. toctree:: - :maxdepth: 2 + :maxdepth: 1 evaluation/metrics.rst debug/visualdl.md diff --git a/doc/fluid/user_guides/howto/prepare_data/index.rst b/doc/fluid/user_guides/howto/prepare_data/index.rst index 930a4dbcb2b4f3c6c699e354280d5710c4fd9a31..00a043c4336a0d31bb1b3fc18a4f3e94ae899445 100644 --- a/doc/fluid/user_guides/howto/prepare_data/index.rst +++ b/doc/fluid/user_guides/howto/prepare_data/index.rst @@ -35,14 +35,14 @@ Python Reader是纯的Python端接口，数据传入与模型训练/预测过程 数据，具体请参考: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 feeding_data.rst Python Reader支持组batch、shuffle等高级功能，具体请参考： .. toctree:: - :maxdepth: 2 + :maxdepth: 1 reader.md @@ -52,7 +52,7 @@ py_reader接口异步方式 Fluid提供PyReader异步数据传入方式，数据传入与模型训练/预测过程是异步的，效率较高。具体请参考： .. toctree:: - :maxdepth: 2 + :maxdepth: 1 use_py_reader.rst @@ -65,4 +65,4 @@ LoD-Tensor是Fluid中特有的概念，它在Tensor基础上附加了序列信 .. toctree:: :maxdepth:2 - lod_tensor.md \ No newline at end of file + lod_tensor.md diff --git a/doc/fluid/user_guides/howto/training/index.rst b/doc/fluid/user_guides/howto/training/index.rst index 68475101e26b3f695c8003995cc1c6a95426ff27..f021e7f3bbde81413d60dc1c94e5c397c9114ae7 100644 --- a/doc/fluid/user_guides/howto/training/index.rst +++ b/doc/fluid/user_guides/howto/training/index.rst @@ -5,7 +5,7 @@ PaddlePaddle Fluid支持单机训练，和多节点训练。每种训练模式下，都支持多种训练方法。 .. toctree:: - :maxdepth: 2 + :maxdepth: 1 single_node multi_node diff --git a/doc/fluid/user_guides/howto/training/multi_node.rst b/doc/fluid/user_guides/howto/training/multi_node.rst index 93df4abd4d1bf51ea9bc275de384c7545df825e8..9008f47c1e88c9682ea715921ec3cd4ffee9e8bc 100644 --- a/doc/fluid/user_guides/howto/training/multi_node.rst +++ b/doc/fluid/user_guides/howto/training/multi_node.rst @@ -3,7 +3,7 @@ ######## .. toctree:: - :maxdepth: 2 + :maxdepth: 1 cluster_quick_start.rst cluster_howto.rst diff --git a/doc/fluid/user_guides/index.rst b/doc/fluid/user_guides/index.rst index fcdccc4b48eb2bc7ed7d92b4d175f2d54d3d38d1..3513da22723fbd997eb173724d49f862e54d5cb0 100644 --- a/doc/fluid/user_guides/index.rst +++ b/doc/fluid/user_guides/index.rst @@ -2,9 +2,6 @@ 使用指南 ######## -============== - 概览 -============== .. todo:: 如果您已经掌握了新手入门阶段的内容，期望可以针对实际问题建模、搭建自己网络，本模块提供了一些 Fluid 的使用细节供您参考： @@ -27,13 +24,8 @@ - `Fluid 模型库 <../user_guides/models/index_cn.html>`_ - -============== - 目录 -============== - .. toctree:: - :maxdepth: 2 + :hidden: howto/prepare_data/index howto/configure_simple_model/index