From f96e05d5026b524604857e0e6ae4271b83ffe15d Mon Sep 17 00:00:00 2001 From: tink2123 Date: Mon, 29 Oct 2018 11:37:48 +0800 Subject: [PATCH 1/2] update overview --- doc/fluid/advanced_usage/index.rst | 35 +++++++++++++++++++++++++++-- doc/fluid/beginners_guide/index.rst | 25 +++++++++++++++++++-- doc/fluid/index_cn.rst | 5 +++-- doc/fluid/overview.md | 25 +++++++++++++++++++++ doc/fluid/user_guides/index.rst | 32 ++++++++++++++++++++++++-- 5 files changed, 114 insertions(+), 8 deletions(-) create mode 100644 doc/fluid/overview.md diff --git a/doc/fluid/advanced_usage/index.rst b/doc/fluid/advanced_usage/index.rst index 7d7a3e674625b..8672dcf37a855 100644 --- a/doc/fluid/advanced_usage/index.rst +++ b/doc/fluid/advanced_usage/index.rst @@ -2,10 +2,41 @@ 进阶使用 ######## - +===================== + 概览 +===================== .. todo:: - Complete this guide +如果您非常熟悉 Fluid，期望获得更高效的模型或者定义自己的Operator，请阅读： + + - `移动端部署 <../advanced_usage/deploy/index_mobile.html>`_：介绍了 PaddlePaddle 组织下的嵌入式平台深度学习框架——Paddle-Mobile，包括： + + - `简介 <../advanced_usage/deploy/mobile_readme.html>`_：简要介绍了 Paddle-Mobile 的应用效果，特点以及使用说明 + - `环境搭建 <../advanced_usage/deploy/mobile_build.html>`_：从使用 Docker 和不使用 Docker 两种方法下分别介绍如何搭建环境 + - `ios开发文档 <../advanced_usage/deploy/mobile_dev.html>`_：介绍如何在 ios 系统下运用 Paddle-Mobile 进行开发 + + - `Anakin预测引擎 <../advanced_usage/deploy/index_anakin.html>`_：介绍如何使用 Anakin 在不同硬件平台实现深度学习的高速预测 + + - `如何写新的Operator <../advanced_usage/development/new_op.html>`_ ：介绍如何在 Fluid 中添加新的 Operator + + - `性能调优 <../advanced_usage/development/profiling/index.html>`_ ：介绍 Fluid 使用过程中的调优方法，包括： + + - `如何进行基准测试 <../advanced_usage/development/profiling/benchmark.html>`_：介绍如何选择基准模型，从而验证模型的精度和性能 + - `CPU性能调优 <../advanced_usage/development/profiling/cpu_profiling_cn.html>`_：介绍如何使用 cProfile 包、yep库、Google perftools 进行性能分析与调优 + - `GPU性能调优 <../advanced_usage/development/profiling/gpu_profiling_cn.html>`_：介绍如何使用 Fluid 内置的定时工具、nvprof 或 nvvp 进行性能分析和调优 + - `堆内存分析和优化 <../advanced_usage/development/profiling/host_memory_profiling_cn.html>`_：介绍如何使用 gperftool 进行堆内存分析和优化，以解决内存泄漏的问题 + - `Timeline工具简介 <../advanced_usage/development/profiling/timeline_cn.html>`_ ：介绍如何使用 Timeline 工具进行性能分析和调优 + + +非常欢迎您为我们的开源社区做出贡献，关于如何贡献您的代码或文档，请阅读： + + - `如何贡献代码 <../advanced_usage/development/contribute_to_paddle.html>`_：介绍如何向 PaddlePaddle 开源社区贡献代码 + + - `如何贡献文档 <../advanced_usage/development/write_docs.html>`_：介绍如何向 PaddlePaddle 开源社区贡献文档 + +===================== + 目录 +===================== .. toctree:: :maxdepth: 2 diff --git a/doc/fluid/beginners_guide/index.rst b/doc/fluid/beginners_guide/index.rst index 327cc0bf4479f..755abd318ef9b 100644 --- a/doc/fluid/beginners_guide/index.rst +++ b/doc/fluid/beginners_guide/index.rst @@ -2,9 +2,30 @@ 新手入门 ######## -.. todo:: +========= + 概览 +========= - 新手入门的导引文字，需要完善。 +请您首先阅读以下文档，了解安装方法： + + - `安装说明 <../beginners_guide/install/install_doc.html>`_：我们支持在Ubunt/CentOS/Windows/MacOS环境上的安装 + +如果您初次接触深度学习，在学习PaddlePaddle之前建议您先阅读以下资料： + + - `学习资料 <../beginners_guide/basics/learning_materials.html>`_：推荐机器学习、深度学习和编程语言三个方面的书籍与视频公开课 + +如果您已经具备一定的深度学习基础，第一次使用 Fluid 时，可以跟随下列简单的模型案例供您快速上手： + + - `Fluid编程指南 <../beginners_guide/programming_guide/programming_guide.html>`_：介绍 Fluid 的基本概念和使用方法 + + - `快速入门 <../beginners_guide/quick_start/index.html>`_：提供线性回归和识别数字两个入门级模型，帮助您快速上手训练网络 + + - `深度学习基础知识 <../beginners_guide/basics/index.html>`_：覆盖图像分类、个性化推荐、机器翻译等多个深度领域的基础知识，提供 Fluid 实现案例 + + +========= + 目录 +========= .. toctree:: :maxdepth: 2 diff --git a/doc/fluid/index_cn.rst b/doc/fluid/index_cn.rst index 42ff490b23b4a..758dd616e602a 100644 --- a/doc/fluid/index_cn.rst +++ b/doc/fluid/index_cn.rst @@ -1,4 +1,4 @@ -.. PaddlePaddle Fluid documentation master file, created by +.. PaddlePaddle Fluid documentation master file, created by sphinx-quickstart on Thu Jun 7 17:04:53 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. @@ -10,7 +10,8 @@ .. toctree:: :maxdepth: 1 + + overview.md beginners_guide/index.rst user_guides/index.rst advanced_usage/index.rst - api_guides/index_cn.rst diff --git a/doc/fluid/overview.md b/doc/fluid/overview.md new file mode 100644 index 0000000000000..ddc94adfb8731 --- /dev/null +++ b/doc/fluid/overview.md @@ -0,0 +1,25 @@ +# 概览 + +使用文档部分将帮助您更好的了解和学习 PaddlePaddle，本单元将主要为您展示 **教程** 和 **API** 两个板块。 + + +## 教程 + +如果您想了解深度学习知识与 Fluid 使用方法，可以在教程部分查找相关内容。教程模块主要包含： + +- [新手入门](beginners_guide/index.html)：包含安装说明和多个简单的模型案例供您快速上手 + +- [使用指南](user_guides/index.html)：包含 Fluid 使用说明和已开源的模型库助您更好地应用Fluid + +- [进阶使用](advanced_usage/index.html)：包含移动端部署、模型调优、书写Operator等高阶使用说明，使 Fluid 更贴合您的需求。 + + +## API + +如果您是PaddlePaddle的老用户，想查找与您项目相关的API，可以直接阅读： + +- [API Guide](api/api_guides/index.html)：介绍 Fluid 主要 API 的功能以及说明文档的接口 + + +- [API](api/index.html)：Fluid 已有 API 的设计思想与使用说明 + diff --git a/doc/fluid/user_guides/index.rst b/doc/fluid/user_guides/index.rst index 1ed2df77fdc16..e7b3b718159ac 100644 --- a/doc/fluid/user_guides/index.rst +++ b/doc/fluid/user_guides/index.rst @@ -2,10 +2,38 @@ 使用指南 ######## - +============== + 概览 +============== .. todo:: - 完善导引介绍 +如果您已经掌握了新手入门阶段的内容，期望可以针对实际问题建模、搭建自己网络，本模块提供了一些 Fluid 的使用细节供您参考： + + + - `Fluid 设计思想 <../user_guides/design_idea/fluid_design_idea.html>`_：介绍 Fluid 底层的设计思想，帮助用户更好的理解框架运作过程 + + - `准备数据 <../user_guides/howto/prepare_data/index.html>`_ ：介绍使用 Fluid 训练网络时，数据的支持类型及传输方法 + + - `配置简单的网络 <../user_guides/howto/configure_simple_model/index.html>`_： 介绍如何针对问题建模，并利用 Fluid 中相关算子搭建网络 + + - `训练神经网络 <../user_guides/howto/training/index.html>`_：介绍如何使用 Fluid 进行单机训练、多机训练、以及保存和载入模型变量 + + - `模型评估与调试 <../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 工具可视化训练过程 + + - `预测部署 <../user_guides/howto/inference/index.html>`_：介绍如何应用训练好的模型进行预测 + + +基于 Fluid 复现的多领域经典模型： + + - `Fluid 模型库 <../user_guides/models/index.html>`_ + + +============== + 目录 +============== .. toctree:: :maxdepth: 2 From cc5963783b5a6072b52b078b1c6be61bab692450 Mon Sep 17 00:00:00 2001 From: Tink_Y <31891223+tink2123@users.noreply.github.com> Date: Wed, 31 Oct 2018 11:27:29 +0800 Subject: [PATCH 2/2] Update overview.md --- doc/fluid/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/fluid/overview.md b/doc/fluid/overview.md index ddc94adfb8731..a7c253a54aafc 100644 --- a/doc/fluid/overview.md +++ b/doc/fluid/overview.md @@ -9,7 +9,7 @@ - [新手入门](beginners_guide/index.html)：包含安装说明和多个简单的模型案例供您快速上手 -- [使用指南](user_guides/index.html)：包含 Fluid 使用说明和已开源的模型库助您更好地应用Fluid +- [使用指南](user_guides/index.html)：包含 Fluid 使用说明和已开源的[模型库](user_guidex/models/index.html)助您更好地应用Fluid - [进阶使用](advanced_usage/index.html)：包含移动端部署、模型调优、书写Operator等高阶使用说明，使 Fluid 更贴合您的需求。