From 249ea3d8dd11d859c687a696b7a73e2862ab1ac7 Mon Sep 17 00:00:00 2001 From: Hao Wang <31058429+haowang101779990@users.noreply.github.com> Date: Thu, 21 Feb 2019 10:51:24 +0800 Subject: [PATCH] add index for api_guides and fix some bugs (#640) --- doc/fluid/api/gen_index.py | 4 ++-- doc/fluid/api/index_en.rst | 3 ++- .../api_guides/low_level/{layers => }/executor_en.rst | 0 doc/fluid/api_guides/low_level/layers/tensor_en.rst | 4 ++-- doc/fluid/beginners_guide/index_en.rst | 10 +++++----- 5 files changed, 11 insertions(+), 10 deletions(-) rename doc/fluid/api_guides/low_level/{layers => }/executor_en.rst (100%) diff --git a/doc/fluid/api/gen_index.py b/doc/fluid/api/gen_index.py index e6b862709..4189918e8 100644 --- a/doc/fluid/api/gen_index.py +++ b/doc/fluid/api/gen_index.py @@ -10,10 +10,10 @@ API Reference ============= .. toctree:: - :maxdepth: 1 + ''') - file_object.write(' api_guides/index.rst'+'\n') + file_object.write(' ../api_guides/index_en.rst'+'\n') file_object.write(' fluid.rst'+'\n') for file_name in sorted(glob.glob("*.rst")): if file_name != ('index_en.rst' and 'fluid.rst'): diff --git a/doc/fluid/api/index_en.rst b/doc/fluid/api/index_en.rst index 88f460f60..d49136c06 100644 --- a/doc/fluid/api/index_en.rst +++ b/doc/fluid/api/index_en.rst @@ -3,8 +3,9 @@ API Reference ============= .. toctree:: - :maxdepth: 1 + + ../api_guides/index_en.rst fluid.rst average.rst backward.rst diff --git a/doc/fluid/api_guides/low_level/layers/executor_en.rst b/doc/fluid/api_guides/low_level/executor_en.rst similarity index 100% rename from doc/fluid/api_guides/low_level/layers/executor_en.rst rename to doc/fluid/api_guides/low_level/executor_en.rst diff --git a/doc/fluid/api_guides/low_level/layers/tensor_en.rst b/doc/fluid/api_guides/low_level/layers/tensor_en.rst index 5e95007a6..0f1e2e088 100755 --- a/doc/fluid/api_guides/low_level/layers/tensor_en.rst +++ b/doc/fluid/api_guides/low_level/layers/tensor_en.rst @@ -4,7 +4,7 @@ Tensor ######## -There are two data structures used in Fluid to host the data, namely `Tensor and LoD_Tensor <../../../user_guides/howto/prepare_data/lod_tensor_en.html>`_. LoD-Tensor is a unique concept of Fluid, which appends sequence information to Tensor. The data that can be transferred in the framework includes: input, output, and learnable parameters in the network. All of them are uniformly represented by LoD-Tensor. In addition, tensor can be regarded as a special LoD-Tensor. +There are two data structures used in Fluid to host the data, namely `Tensor and LoD_Tensor <../../../user_guides/howto/basic_concept/lod_tensor_en.html>`_ . LoD-Tensor is a unique concept of Fluid, which appends sequence information to Tensor. The data that can be transferred in the framework includes: input, output, and learnable parameters in the network. All of them are uniformly represented by LoD-Tensor. In addition, tensor can be regarded as a special LoD-Tensor. Now let's take a closer look at the operations related to these two types of data. @@ -125,7 +125,7 @@ API reference : :ref:`api_fluid_layers_reverse` LoD-Tensor ============ -LoD-Tensor is very suitable for sequence data. For related knowledge, please read `LoD_Tensor <../../../user_guides/howto/prepare_data/lod_tensor_en.html>`_. +LoD-Tensor is very suitable for sequence data. For related knowledge, please read `Tensor and LoD_Tensor <../../../user_guides/howto/basic_concept/lod_tensor_en.html>`_ . 1.create_lod_tensor ----------------------- diff --git a/doc/fluid/beginners_guide/index_en.rst b/doc/fluid/beginners_guide/index_en.rst index 858911b47..b4aed76cc 100644 --- a/doc/fluid/beginners_guide/index_en.rst +++ b/doc/fluid/beginners_guide/index_en.rst @@ -13,15 +13,15 @@ For beginners of PaddlePaddle, the following documentation will tutor you about The following resources are recommended for novices in deep learning: - - `Resources <../beginners_guide/basics/learning_materials.html>`_ ：Selected books and lectures about machine learning, deep learning and programming languages. + - `Resources <../beginners_guide/basics/learning_materials_en.html>`_ ：Selected books and lectures about machine learning, deep learning and programming languages. If you have been armed with certain level of deep learning knowledge, and it happens to be the first time to try PaddlePaddle, the following cases of model building will expedite your learning process: - - `Programming with Fluid <../beginners_guide/programming_guide/programming_guide.html>`_ ： Core concepts and basic usage of Fluid + - `Programming with Fluid <../beginners_guide/programming_guide/programming_guide_en.html>`_ ： Core concepts and basic usage of Fluid - - `Quick Start <../beginners_guide/quick_start/index.html>`_： Two easy-to-go models, linear regression model and digit recognition model, are in place to speed up your study of training neural networks + - `Quick Start <../beginners_guide/quick_start/index_en.html>`_： Two easy-to-go models, linear regression model and digit recognition model, are in place to speed up your study of training neural networks - - `Deep Learning <../beginners_guide/basics/index.html>`_： This section encompasses various fields of fundamental deep learning knowledge, such as image classification, customized recommendation, machine translation, and examples implemented by Fluid are provided. + - `Deep Learning Basics <../beginners_guide/basics/index_en.html>`_： This section encompasses various fields of fundamental deep learning knowledge, such as image classification, customized recommendation, machine translation, and examples implemented by Fluid are provided. .. toctree:: @@ -29,4 +29,4 @@ If you have been armed with certain level of deep learning knowledge, and it hap install/index_en.rst basics/learning_materials_en.md - + programming_guide/programming_guide_en.md -- GitLab