From c2cbecf2130a3019408b9c14ca5ce75f6431754b Mon Sep 17 00:00:00 2001 From: Cheerego <35982308+shanyi15@users.noreply.github.com> Date: Thu, 6 Dec 2018 17:08:39 +0800 Subject: [PATCH] Adjust structure of advanced usage (#442) * adjust_structure_of_advanced_usage * Update paddle_gpu_benchmark.md --- .../{ => anakin}/anakin_arm_benchmark.md | 0 .../deploy/{ => anakin}/anakin_example.md | 0 .../{ => anakin}/anakin_gpu_benchmark.md | 0 .../{ => anakin}/anakin_parser_design.md | 0 .../deploy/{ => anakin}/anakin_run_on_arm.md | 0 .../deploy/{ => anakin}/anakin_tutorial.md | 0 .../{ => anakin}/convert_paddle_to_anakin.md | 0 .../{ => anakin}/how_to_add_anakin_op.md | 0 .../how_to_support_new_device_in_anakin.md | 0 .../{index_anakin.rst => anakin/index_cn.rst} | 0 .../deploy/{ => anakin}/install_anakin.md | 0 .../deploy/{ => anakin}/run_anakin_on_arm.md | 0 doc/fluid/advanced_usage/deploy/index_cn.rst | 13 ++++++ .../advanced_usage/deploy/index_mobile.rst | 8 ---- .../inference/build_and_install_lib_cn.rst | 0 .../deploy}/inference/image/image1.png | Bin .../deploy}/inference/image/image2.png | Bin .../deploy}/inference/image/image3.png | Bin .../deploy}/inference/image/image4.png | Bin .../deploy}/inference/image/image5.png | Bin .../deploy}/inference/image/image6.png | Bin .../deploy}/inference/image/image7.png | Bin .../deploy}/inference/image/image8.png | Bin .../deploy}/inference/image/image9.png | Bin .../inference/image/model_graph_original.png | Bin .../inference/image/model_graph_trt.png | Bin .../deploy/inference/index_cn.rst} | 4 +- .../deploy}/inference/native_infer.md | 2 +- .../deploy}/inference/paddle_gpu_benchmark.md | 2 +- .../inference/paddle_tensorrt_infer.md | 2 +- .../inference/windows_cpp_inference.md | 2 +- .../advanced_usage/deploy/mobile/index_cn.rst | 15 +++++++ .../deploy/{ => mobile}/mobile_build.md | 2 +- .../deploy/{ => mobile}/mobile_readme.md | 0 .../contribute_to_paddle/index_cn.rst | 4 +- .../advanced_usage/development/new_op.md | 1 - .../development/new_op/index_cn.rst | 13 ++++++ .../development/new_op/new_op_cn.md | 1 + .../development/{ => new_op}/op_notes.md | 8 ++-- .../development/profiling/index.rst | 10 ----- .../development/profiling/index_cn.rst | 20 +++++++++ doc/fluid/advanced_usage/index.rst | 40 ++++-------------- doc/fluid/dev/new_op_cn.md | 2 +- doc/fluid/user_guides/index.rst | 4 -- 44 files changed, 84 insertions(+), 69 deletions(-) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_arm_benchmark.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_example.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_gpu_benchmark.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_parser_design.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_run_on_arm.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/anakin_tutorial.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/convert_paddle_to_anakin.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/how_to_add_anakin_op.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/how_to_support_new_device_in_anakin.md (100%) rename doc/fluid/advanced_usage/deploy/{index_anakin.rst => anakin/index_cn.rst} (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/install_anakin.md (100%) rename doc/fluid/advanced_usage/deploy/{ => anakin}/run_anakin_on_arm.md (100%) create mode 100644 doc/fluid/advanced_usage/deploy/index_cn.rst delete mode 100644 doc/fluid/advanced_usage/deploy/index_mobile.rst rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/build_and_install_lib_cn.rst (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image1.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image2.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image3.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image4.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image5.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image6.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image7.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image8.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/image9.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/model_graph_original.png (100%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/image/model_graph_trt.png (100%) rename doc/fluid/{user_guides/howto/inference/index.rst => advanced_usage/deploy/inference/index_cn.rst} (88%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/native_infer.md (99%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/paddle_gpu_benchmark.md (97%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/paddle_tensorrt_infer.md (99%) rename doc/fluid/{user_guides/howto => advanced_usage/deploy}/inference/windows_cpp_inference.md (98%) create mode 100644 doc/fluid/advanced_usage/deploy/mobile/index_cn.rst rename doc/fluid/advanced_usage/deploy/{ => mobile}/mobile_build.md (95%) rename doc/fluid/advanced_usage/deploy/{ => mobile}/mobile_readme.md (100%) delete mode 120000 doc/fluid/advanced_usage/development/new_op.md create mode 100644 doc/fluid/advanced_usage/development/new_op/index_cn.rst create mode 120000 doc/fluid/advanced_usage/development/new_op/new_op_cn.md rename doc/fluid/advanced_usage/development/{ => new_op}/op_notes.md (98%) delete mode 100644 doc/fluid/advanced_usage/development/profiling/index.rst create mode 100644 doc/fluid/advanced_usage/development/profiling/index_cn.rst diff --git a/doc/fluid/advanced_usage/deploy/anakin_arm_benchmark.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_arm_benchmark.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_arm_benchmark.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_arm_benchmark.md diff --git a/doc/fluid/advanced_usage/deploy/anakin_example.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_example.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_example.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_example.md diff --git a/doc/fluid/advanced_usage/deploy/anakin_gpu_benchmark.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_gpu_benchmark.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_gpu_benchmark.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_gpu_benchmark.md diff --git a/doc/fluid/advanced_usage/deploy/anakin_parser_design.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_parser_design.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_parser_design.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_parser_design.md diff --git a/doc/fluid/advanced_usage/deploy/anakin_run_on_arm.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_run_on_arm.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_run_on_arm.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_run_on_arm.md diff --git a/doc/fluid/advanced_usage/deploy/anakin_tutorial.md b/doc/fluid/advanced_usage/deploy/anakin/anakin_tutorial.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/anakin_tutorial.md rename to doc/fluid/advanced_usage/deploy/anakin/anakin_tutorial.md diff --git a/doc/fluid/advanced_usage/deploy/convert_paddle_to_anakin.md b/doc/fluid/advanced_usage/deploy/anakin/convert_paddle_to_anakin.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/convert_paddle_to_anakin.md rename to doc/fluid/advanced_usage/deploy/anakin/convert_paddle_to_anakin.md diff --git a/doc/fluid/advanced_usage/deploy/how_to_add_anakin_op.md b/doc/fluid/advanced_usage/deploy/anakin/how_to_add_anakin_op.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/how_to_add_anakin_op.md rename to doc/fluid/advanced_usage/deploy/anakin/how_to_add_anakin_op.md diff --git a/doc/fluid/advanced_usage/deploy/how_to_support_new_device_in_anakin.md b/doc/fluid/advanced_usage/deploy/anakin/how_to_support_new_device_in_anakin.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/how_to_support_new_device_in_anakin.md rename to doc/fluid/advanced_usage/deploy/anakin/how_to_support_new_device_in_anakin.md diff --git a/doc/fluid/advanced_usage/deploy/index_anakin.rst b/doc/fluid/advanced_usage/deploy/anakin/index_cn.rst similarity index 100% rename from doc/fluid/advanced_usage/deploy/index_anakin.rst rename to doc/fluid/advanced_usage/deploy/anakin/index_cn.rst diff --git a/doc/fluid/advanced_usage/deploy/install_anakin.md b/doc/fluid/advanced_usage/deploy/anakin/install_anakin.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/install_anakin.md rename to doc/fluid/advanced_usage/deploy/anakin/install_anakin.md diff --git a/doc/fluid/advanced_usage/deploy/run_anakin_on_arm.md b/doc/fluid/advanced_usage/deploy/anakin/run_anakin_on_arm.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/run_anakin_on_arm.md rename to doc/fluid/advanced_usage/deploy/anakin/run_anakin_on_arm.md diff --git a/doc/fluid/advanced_usage/deploy/index_cn.rst b/doc/fluid/advanced_usage/deploy/index_cn.rst new file mode 100644 index 000000000..f55e5bc66 --- /dev/null +++ b/doc/fluid/advanced_usage/deploy/index_cn.rst @@ -0,0 +1,13 @@ +######## +预测部署 +######## + +- `原生预测引擎 `_ ：介绍了支持模型部署上线的Fluid C++ API + +- `移动端部署 `_：介绍了 PaddlePaddle组织下的嵌入式平台深度学习框架Paddle-Mobile + +.. toctree:: + :hidden: + + inference/index_cn.rst + mobile/index_cn.rst diff --git a/doc/fluid/advanced_usage/deploy/index_mobile.rst b/doc/fluid/advanced_usage/deploy/index_mobile.rst deleted file mode 100644 index c7a338d9b..000000000 --- a/doc/fluid/advanced_usage/deploy/index_mobile.rst +++ /dev/null @@ -1,8 +0,0 @@ -移动端部署 -########## - -.. toctree:: - :maxdepth: 2 - - mobile_readme.md - mobile_build.md diff --git a/doc/fluid/user_guides/howto/inference/build_and_install_lib_cn.rst b/doc/fluid/advanced_usage/deploy/inference/build_and_install_lib_cn.rst similarity index 100% rename from doc/fluid/user_guides/howto/inference/build_and_install_lib_cn.rst rename to doc/fluid/advanced_usage/deploy/inference/build_and_install_lib_cn.rst diff --git a/doc/fluid/user_guides/howto/inference/image/image1.png b/doc/fluid/advanced_usage/deploy/inference/image/image1.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image1.png rename to doc/fluid/advanced_usage/deploy/inference/image/image1.png diff --git a/doc/fluid/user_guides/howto/inference/image/image2.png b/doc/fluid/advanced_usage/deploy/inference/image/image2.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image2.png rename to doc/fluid/advanced_usage/deploy/inference/image/image2.png diff --git a/doc/fluid/user_guides/howto/inference/image/image3.png b/doc/fluid/advanced_usage/deploy/inference/image/image3.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image3.png rename to doc/fluid/advanced_usage/deploy/inference/image/image3.png diff --git a/doc/fluid/user_guides/howto/inference/image/image4.png b/doc/fluid/advanced_usage/deploy/inference/image/image4.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image4.png rename to doc/fluid/advanced_usage/deploy/inference/image/image4.png diff --git a/doc/fluid/user_guides/howto/inference/image/image5.png b/doc/fluid/advanced_usage/deploy/inference/image/image5.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image5.png rename to doc/fluid/advanced_usage/deploy/inference/image/image5.png diff --git a/doc/fluid/user_guides/howto/inference/image/image6.png b/doc/fluid/advanced_usage/deploy/inference/image/image6.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image6.png rename to doc/fluid/advanced_usage/deploy/inference/image/image6.png diff --git a/doc/fluid/user_guides/howto/inference/image/image7.png b/doc/fluid/advanced_usage/deploy/inference/image/image7.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image7.png rename to doc/fluid/advanced_usage/deploy/inference/image/image7.png diff --git a/doc/fluid/user_guides/howto/inference/image/image8.png b/doc/fluid/advanced_usage/deploy/inference/image/image8.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image8.png rename to doc/fluid/advanced_usage/deploy/inference/image/image8.png diff --git a/doc/fluid/user_guides/howto/inference/image/image9.png b/doc/fluid/advanced_usage/deploy/inference/image/image9.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/image9.png rename to doc/fluid/advanced_usage/deploy/inference/image/image9.png diff --git a/doc/fluid/user_guides/howto/inference/image/model_graph_original.png b/doc/fluid/advanced_usage/deploy/inference/image/model_graph_original.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/model_graph_original.png rename to doc/fluid/advanced_usage/deploy/inference/image/model_graph_original.png diff --git a/doc/fluid/user_guides/howto/inference/image/model_graph_trt.png b/doc/fluid/advanced_usage/deploy/inference/image/model_graph_trt.png similarity index 100% rename from doc/fluid/user_guides/howto/inference/image/model_graph_trt.png rename to doc/fluid/advanced_usage/deploy/inference/image/model_graph_trt.png diff --git a/doc/fluid/user_guides/howto/inference/index.rst b/doc/fluid/advanced_usage/deploy/inference/index_cn.rst similarity index 88% rename from doc/fluid/user_guides/howto/inference/index.rst rename to doc/fluid/advanced_usage/deploy/inference/index_cn.rst index 5b10856e5..7f7a0a102 100644 --- a/doc/fluid/user_guides/howto/inference/index.rst +++ b/doc/fluid/advanced_usage/deploy/inference/index_cn.rst @@ -1,11 +1,11 @@ ############ -预测部署 +原生预测引擎 ############ PaddlePaddle Fluid 提供了 C++ API 来支持模型的部署上线 .. toctree:: - :maxdepth: 2 + :hidden: build_and_install_lib_cn.rst native_infer.md diff --git a/doc/fluid/user_guides/howto/inference/native_infer.md b/doc/fluid/advanced_usage/deploy/inference/native_infer.md similarity index 99% rename from doc/fluid/user_guides/howto/inference/native_infer.md rename to doc/fluid/advanced_usage/deploy/inference/native_infer.md index fc3a3879c..3317ac283 100644 --- a/doc/fluid/user_guides/howto/inference/native_infer.md +++ b/doc/fluid/advanced_usage/deploy/inference/native_infer.md @@ -1,4 +1,4 @@ -# Paddle 预测 API +# C++ 预测 API介绍 为了更简单方便的预测部署，Fluid 提供了一套高层 API 用来隐藏底层不同的优化实现。 diff --git a/doc/fluid/user_guides/howto/inference/paddle_gpu_benchmark.md b/doc/fluid/advanced_usage/deploy/inference/paddle_gpu_benchmark.md similarity index 97% rename from doc/fluid/user_guides/howto/inference/paddle_gpu_benchmark.md rename to doc/fluid/advanced_usage/deploy/inference/paddle_gpu_benchmark.md index c6b1690ef..c5b746290 100644 --- a/doc/fluid/user_guides/howto/inference/paddle_gpu_benchmark.md +++ b/doc/fluid/advanced_usage/deploy/inference/paddle_gpu_benchmark.md @@ -1,4 +1,4 @@ -# PaddlePaddle GPU 性能测试 +# TensorRT库性能测试 ## 测试环境 - CPU:Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz GPU:Tesla P4 diff --git a/doc/fluid/user_guides/howto/inference/paddle_tensorrt_infer.md b/doc/fluid/advanced_usage/deploy/inference/paddle_tensorrt_infer.md similarity index 99% rename from doc/fluid/user_guides/howto/inference/paddle_tensorrt_infer.md rename to doc/fluid/advanced_usage/deploy/inference/paddle_tensorrt_infer.md index 2803e4578..8a98954bf 100644 --- a/doc/fluid/user_guides/howto/inference/paddle_tensorrt_infer.md +++ b/doc/fluid/advanced_usage/deploy/inference/paddle_tensorrt_infer.md @@ -1,4 +1,4 @@ -# 使用Paddle TensorRT预测 +# 使用TensorRT库预测 NVIDIA TensorRT 是一个高性能的深度学习预测库，可为深度学习推理应用程序提供低延迟和高吞吐量。Paddle 1.0 采用了子图的形式对TensorRT进行了初步集成，即我们可以使用该模块来提升Paddle模型的预测性能。该模块依旧在持续开发中，目前已支持的模型有：AlexNet, MobileNet, ResNet50, VGG19, ResNext, Se-ReNext, GoogleNet, DPN, ICNET, MobileNet-SSD等。在这篇文档中，我们将会对Paddle-TensorRT库的获取、使用和原理进行介绍。 diff --git a/doc/fluid/user_guides/howto/inference/windows_cpp_inference.md b/doc/fluid/advanced_usage/deploy/inference/windows_cpp_inference.md similarity index 98% rename from doc/fluid/user_guides/howto/inference/windows_cpp_inference.md rename to doc/fluid/advanced_usage/deploy/inference/windows_cpp_inference.md index f2642b462..b6a5a2168 100644 --- a/doc/fluid/user_guides/howto/inference/windows_cpp_inference.md +++ b/doc/fluid/advanced_usage/deploy/inference/windows_cpp_inference.md @@ -1,4 +1,4 @@ -Windows环境模型预测使用说明 +Windows环境模型预测 =========================== 环境部署 diff --git a/doc/fluid/advanced_usage/deploy/mobile/index_cn.rst b/doc/fluid/advanced_usage/deploy/mobile/index_cn.rst new file mode 100644 index 000000000..4e9fc9e91 --- /dev/null +++ b/doc/fluid/advanced_usage/deploy/mobile/index_cn.rst @@ -0,0 +1,15 @@ +########## +移动端部署 +########## + +本模块介绍了 PaddlePaddle 组织下的嵌入式平台深度学习框架——Paddle-Mobile，包括： + +* `项目简介 `_：简要介绍了 Paddle-Mobile 的应用效果，特点以及使用说明 + +* `环境搭建 `_：分别介绍如何在Docker和非Docker下搭建环境 + +.. toctree:: + :hidden: + + mobile_readme.md + mobile_build.md diff --git a/doc/fluid/advanced_usage/deploy/mobile_build.md b/doc/fluid/advanced_usage/deploy/mobile/mobile_build.md similarity index 95% rename from doc/fluid/advanced_usage/deploy/mobile_build.md rename to doc/fluid/advanced_usage/deploy/mobile/mobile_build.md index e51593164..8f538d04c 100644 --- a/doc/fluid/advanced_usage/deploy/mobile_build.md +++ b/doc/fluid/advanced_usage/deploy/mobile/mobile_build.md @@ -1,7 +1,7 @@ # 环境搭建 ## 使用 docker ### 1. 安装 docker -安装 docker 的方式，参考官方文档 [https://docs.docker.com/install/](https://docs.docker.com/install/) +安装 docker 的方式，参考 [官方文档](https://docs.docker.com/install/) ### 2. 使用 docker 搭建构建环境 首先进入 paddle-mobile 的目录下，执行 `docker build` 以 Linux/Mac 为例 (windows 建议在 'Docker Quickstart Terminal' 中执行) diff --git a/doc/fluid/advanced_usage/deploy/mobile_readme.md b/doc/fluid/advanced_usage/deploy/mobile/mobile_readme.md similarity index 100% rename from doc/fluid/advanced_usage/deploy/mobile_readme.md rename to doc/fluid/advanced_usage/deploy/mobile/mobile_readme.md 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 a46fd00e6..4b0254656 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 @@ -1,6 +1,6 @@ -######## +############ 如何贡献代码 -######## +############ .. toctree:: :maxdepth: 2 diff --git a/doc/fluid/advanced_usage/development/new_op.md b/doc/fluid/advanced_usage/development/new_op.md deleted file mode 120000 index a2b0044b0..000000000 --- a/doc/fluid/advanced_usage/development/new_op.md +++ /dev/null @@ -1 +0,0 @@ -../../dev/new_op_cn.md \ No newline at end of file diff --git a/doc/fluid/advanced_usage/development/new_op/index_cn.rst b/doc/fluid/advanced_usage/development/new_op/index_cn.rst new file mode 100644 index 000000000..5b9a20b57 --- /dev/null +++ b/doc/fluid/advanced_usage/development/new_op/index_cn.rst @@ -0,0 +1,13 @@ +############# +新增operator +############# + +- `如何写新的operator <../../../advanced_usage/development/new_op.html>`_ ：介绍如何在 Fluid 中添加新的 Operator + +- `op相关的一些注意事项 <../../../advanced_usage/development/op_notes.html>`_ ：介绍op相关的一些注意事项 + +.. toctree:: + :hidden: + + new_op_cn.md + op_notes.md diff --git a/doc/fluid/advanced_usage/development/new_op/new_op_cn.md b/doc/fluid/advanced_usage/development/new_op/new_op_cn.md new file mode 120000 index 000000000..dce034858 --- /dev/null +++ b/doc/fluid/advanced_usage/development/new_op/new_op_cn.md @@ -0,0 +1 @@ +../../../dev/new_op_cn.md \ No newline at end of file diff --git a/doc/fluid/advanced_usage/development/op_notes.md b/doc/fluid/advanced_usage/development/new_op/op_notes.md similarity index 98% rename from doc/fluid/advanced_usage/development/op_notes.md rename to doc/fluid/advanced_usage/development/new_op/op_notes.md index 09c8bc008..03e4f2ad0 100644 --- a/doc/fluid/advanced_usage/development/op_notes.md +++ b/doc/fluid/advanced_usage/development/new_op/op_notes.md @@ -1,4 +1,4 @@ -# Op相关的一些注意事项 +# op相关的一些注意事项 ## Fluid中Op的构建逻辑 ### 1.Fluid中Op的构建逻辑 @@ -9,7 +9,7 @@ Op的核心方法是Run，Run方法需要两方面的资源：数据资源和计 Fluid框架的设计理念是可以在多种设备及第三方库上运行，有些Op的实现可能会因为设备或者第三方库的不同而不同。为此，Fluid引入了OpKernel的方式，即一个Op可以有多个OpKernel，这类Op继承自`OperatorWithKernel`，这类Op的代表是conv，conv_op的OpKerne有：`GemmConvKernel`、`CUDNNConvOpKernel`、`ConvMKLDNNOpKernel`，且每个OpKernel都有double和float两种数据类型。不需要OpKernel的代表有`WhileOp`等。 Operator继承关系图： -![op_inheritance_relation_diagram](../pics/op_inheritance_relation_diagram.png) +![op_inheritance_relation_diagram](../../pics/op_inheritance_relation_diagram.png) 进一步了解可参考：[multi_devices](https://github.com/PaddlePaddle/FluidDoc/tree/develop/doc/fluid/design/multi_devices)，[scope](https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/fluid/design/concepts/scope.md)，[Developer's_Guide_to_Paddle_Fluid](https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/fluid/getstarted/Developer's_Guide_to_Paddle_Fluid.md) @@ -92,7 +92,7 @@ Operator继承关系图： 5. 框架没有提供默认的op_infer_var_type方法，用户需要根据实际情况添加op_infer_var_shape。严格来说每个Op都应该注册一个InferVarType，op_infer_var_type根据输入的Var的type和dtype推断输出Var的type和dtype。**注意：**在Python端的LayerHelper中create_variable_for_type_inference操作返回的Variable里面是LoDTensor，C++端的InferVarType可以修改`Variable`的type和dtype。 -更多内容请参考: [如何写新的Op](./new_op.html) +更多内容请参考: [如何写新的Op](../new_op.html) ## 写Op注意事项 ### 1.Op可以支持输入输出类型 @@ -183,4 +183,4 @@ def fc(input, act=None, is_test=False, name=None) -``` \ No newline at end of file +``` diff --git a/doc/fluid/advanced_usage/development/profiling/index.rst b/doc/fluid/advanced_usage/development/profiling/index.rst deleted file mode 100644 index 1d2eedc43..000000000 --- a/doc/fluid/advanced_usage/development/profiling/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -########## -性能调优 -########## -.. toctree:: - - benchmark.rst - cpu_profiling_cn.md - gpu_profiling_cn.rst - host_memory_profiling_cn.md - timeline_cn.md diff --git a/doc/fluid/advanced_usage/development/profiling/index_cn.rst b/doc/fluid/advanced_usage/development/profiling/index_cn.rst new file mode 100644 index 000000000..2a20389a0 --- /dev/null +++ b/doc/fluid/advanced_usage/development/profiling/index_cn.rst @@ -0,0 +1,20 @@ +########## +性能调优 +########## + +介绍 Fluid 使用过程中的调优方法，包括： + + - `如何进行基准测试 `_：介绍如何选择基准模型，从而验证模型的精度和性能 + - `CPU性能调优 `_：介绍如何使用 cProfile 包、yep库、Google perftools 进行性能分析与调优 + - `GPU性能调优 `_：介绍如何使用 Fluid 内置的定时工具、nvprof 或 nvvp 进行性能分析和调优 + - `堆内存分析和优化 `_：介绍如何使用 gperftool 进行堆内存分析和优化，以解决内存泄漏的问题 + - `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/advanced_usage/index.rst b/doc/fluid/advanced_usage/index.rst index 817cd7633..35193bd64 100644 --- a/doc/fluid/advanced_usage/index.rst +++ b/doc/fluid/advanced_usage/index.rst @@ -2,51 +2,27 @@ 进阶使用 ######## -===================== - 概览 -===================== .. todo:: 如果您非常熟悉 Fluid，期望获得更高效的模型或者定义自己的Operator，请阅读： - - `移动端部署 <../advanced_usage/deploy/index_mobile.html>`_：介绍了 PaddlePaddle 组织下的嵌入式平台深度学习框架——Paddle-Mobile，包括： + - `预测部署 <../advanced_usage/deploy/index_cn.html>`_ ：介绍如何应用训练好的模型进行预测 - - `简介 <../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 - - - `Op相关的一些注意事项 <../advanced_usage/development/op_notes.html>`_ ：介绍Op相关的一些注意事项 - - - `性能调优 <../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 工具进行性能分析和调优 + - `新增operator <../advanced_usage/development/new_op/index_cn.html>`_ ：介绍新增operator的方法及注意事项 + - `性能调优 <../advanced_usage/development/profiling/index.html>`_ ：介绍 Fluid 使用过程中的调优方法 非常欢迎您为我们的开源社区做出贡献，关于如何贡献您的代码或文档，请阅读： - - `如何贡献代码 <../advanced_usage/development/contribute_to_paddle.html>`_：介绍如何向 PaddlePaddle 开源社区贡献代码 + - `如何贡献代码 <../advanced_usage/development/contribute_to_paddle/index_cn.html>`_：介绍如何向 PaddlePaddle 开源社区贡献代码 - `如何贡献文档 <../advanced_usage/development/write_docs_cn.html>`_：介绍如何向 PaddlePaddle 开源社区贡献文档 -===================== - 目录 -===================== - .. toctree:: - :maxdepth: 2 + :hidden: - deploy/index_mobile.rst - deploy/index_anakin.rst + deploy/index_cn.rst + development/new_op/index_cn.rst development/contribute_to_paddle/index_cn.rst development/write_docs_cn.md - development/new_op.md - development/op_notes.md - development/profiling/index.rst + development/profiling/index_cn.rst diff --git a/doc/fluid/dev/new_op_cn.md b/doc/fluid/dev/new_op_cn.md index eb6ca6012..23e562d4c 100644 --- a/doc/fluid/dev/new_op_cn.md +++ b/doc/fluid/dev/new_op_cn.md @@ -1,4 +1,4 @@ -# 如何写新的Operator +# 如何写新的operator - [概念简介](#概念简介) - [实现C++类](#实现c类) diff --git a/doc/fluid/user_guides/index.rst b/doc/fluid/user_guides/index.rst index 91e1e521c..fcdccc4b4 100644 --- a/doc/fluid/user_guides/index.rst +++ b/doc/fluid/user_guides/index.rst @@ -23,9 +23,6 @@ - `模型评估 <../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_cn.html>`_ @@ -42,6 +39,5 @@ howto/configure_simple_model/index howto/training/index howto/evaluation_and_debugging/index - howto/inference/index models/index_cn.rst design_idea/fluid_design_idea.md -- GitLab