From 29727289fca4f5d925a094cd6317e37e9644a65f Mon Sep 17 00:00:00 2001 From: Luo Tao Date: Tue, 15 Nov 2016 16:31:17 +0800 Subject: [PATCH] modify first level directory of english doc --- doc/algorithm/index.rst | 7 ++++++ doc/algorithm/rnn/rnn.rst | 4 ++-- doc/build/contribute_to_paddle.md | 2 +- doc/build/index.rst | 11 +++------ doc/demo/quick_start/index_en.md | 2 +- doc/dev/index.rst | 9 ++++++++ doc/dev/layer.md | 4 ++++ doc/dev/new_layer/index.rst | 7 ------ doc/dev/new_layer/new_layer.rst | 1 + doc/index.md | 23 ------------------- doc/index.rst | 10 ++++++++ doc/layer.md | 4 ---- doc/ui/api/trainer_config_helpers/layers.rst | 2 +- doc/user_guide.rst | 13 +++++++++++ .../paddle/trainer_config_helpers/layers.py | 1 + 15 files changed, 53 insertions(+), 47 deletions(-) create mode 100644 doc/algorithm/index.rst create mode 100644 doc/dev/index.rst create mode 100644 doc/dev/layer.md delete mode 100644 doc/dev/new_layer/index.rst delete mode 100644 doc/index.md create mode 100644 doc/index.rst delete mode 100644 doc/layer.md create mode 100644 doc/user_guide.rst diff --git a/doc/algorithm/index.rst b/doc/algorithm/index.rst new file mode 100644 index 0000000000..6073add3c0 --- /dev/null +++ b/doc/algorithm/index.rst @@ -0,0 +1,7 @@ +Algorithm Tutorial +================== + +.. toctree:: + :maxdepth: 1 + + rnn/rnn.rst diff --git a/doc/algorithm/rnn/rnn.rst b/doc/algorithm/rnn/rnn.rst index 343f55a20e..399c5da5ff 100644 --- a/doc/algorithm/rnn/rnn.rst +++ b/doc/algorithm/rnn/rnn.rst @@ -1,5 +1,5 @@ -Recurrent Neural Network Configuration -====================================== +RNN Configuration +================= This tutorial will guide you how to configure recurrent neural network in PaddlePaddle. PaddlePaddle supports highly flexible and efficient recurrent neural network configuration. In this tutorial, you will learn how to: diff --git a/doc/build/contribute_to_paddle.md b/doc/build/contribute_to_paddle.md index a9ab69c5f4..1d03eb7362 100644 --- a/doc/build/contribute_to_paddle.md +++ b/doc/build/contribute_to_paddle.md @@ -1,4 +1,4 @@ -# Contribute to PaddlePaddle +# Contribute Code We sincerely appreciate your contributions. You can use fork and pull request workflow to merge your code. diff --git a/doc/build/index.rst b/doc/build/index.rst index 511cdea145..b4fe459604 100644 --- a/doc/build/index.rst +++ b/doc/build/index.rst @@ -1,5 +1,5 @@ -Build And Install PaddlePaddle -================================ +Install and Build +================= Install PaddlePaddle ---------------------- @@ -18,11 +18,7 @@ Build from Source .. warning:: - Please use :code:`deb` package or :code:`docker` image to install paddle. The building guide is used for hacking or contributing to PaddlePaddle. - - -If you want to hack and contribute PaddlePaddle source code, following guides can help you\: - + Please use :code:`deb` package or :code:`docker` image to install paddle. The building guide is used for hacking or contributing PaddlePaddle source code. .. toctree:: :maxdepth: 1 @@ -30,4 +26,3 @@ If you want to hack and contribute PaddlePaddle source code, following guides ca build_from_source.md contribute_to_paddle.md - diff --git a/doc/demo/quick_start/index_en.md b/doc/demo/quick_start/index_en.md index e7d7451229..80d816a768 100644 --- a/doc/demo/quick_start/index_en.md +++ b/doc/demo/quick_start/index_en.md @@ -1,4 +1,4 @@ -# Quick Start Tutorial +# Quick Start This tutorial will teach the basics of deep learning (DL), including how to implement many different models in PaddlePaddle. You will learn how to: - Prepare data into the standardized format that PaddlePaddle accepts. diff --git a/doc/dev/index.rst b/doc/dev/index.rst new file mode 100644 index 0000000000..0468dd492b --- /dev/null +++ b/doc/dev/index.rst @@ -0,0 +1,9 @@ +Development Guide +================= + +.. toctree:: + :maxdepth: 1 + + layer.md + new_layer/new_layer.rst + ../source/index.md diff --git a/doc/dev/layer.md b/doc/dev/layer.md new file mode 100644 index 0000000000..930fb0de1a --- /dev/null +++ b/doc/dev/layer.md @@ -0,0 +1,4 @@ +# Layer Documents + +* [Layer Source Code Document](../source/gserver/layers/index.rst) +* [Layer Python API Document](../ui/api/trainer_config_helpers/index.rst) diff --git a/doc/dev/new_layer/index.rst b/doc/dev/new_layer/index.rst deleted file mode 100644 index 37dac3a14d..0000000000 --- a/doc/dev/new_layer/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Writing New Layers -================== - -.. toctree:: - :maxdepth: 3 - - new_layer.rst diff --git a/doc/dev/new_layer/new_layer.rst b/doc/dev/new_layer/new_layer.rst index bd4a4c46c8..2fa0073048 100644 --- a/doc/dev/new_layer/new_layer.rst +++ b/doc/dev/new_layer/new_layer.rst @@ -1,3 +1,4 @@ +================== Writing New Layers ================== diff --git a/doc/index.md b/doc/index.md deleted file mode 100644 index cbd08ba52a..0000000000 --- a/doc/index.md +++ /dev/null @@ -1,23 +0,0 @@ -PaddlePaddle Documentation -========================== - -User Guide ----------- -* [Introduction](introduction/index.md) -* [Quick Start](demo/quick_start/index_en.md) -* [Build and Installation](build/index.rst) -* [Contribute Code](build/contribute_to_paddle.md) -* [User Interface](ui/index.md) -* [Model Config Interface](ui/api/trainer_config_helpers/index.rst) -* [Example and Demo](demo/index.md) -* [Cluster Train](cluster/index.md) - -Development Guide ------------------ -* [Layer Documents](layer.md) -* [Writing New Layers](dev/new_layer/index.rst) -* [Source Code Documents](source/index.md) - -Algorithm Tutorial ------------------- -* [RNN Configuration](algorithm/rnn/rnn.rst) diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..668ad75a90 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,10 @@ +PaddlePaddle Documentation +========================== + +.. toctree:: + :maxdepth: 1 + + introduction/index.md + user_guide.rst + dev/index.rst + algorithm/index.rst diff --git a/doc/layer.md b/doc/layer.md deleted file mode 100644 index 45f2e2bad5..0000000000 --- a/doc/layer.md +++ /dev/null @@ -1,4 +0,0 @@ -# Layer Documents - -* [Layer Source Code Document](source/gserver/layers/index.rst) -* [Layer Python API Document](ui/api/trainer_config_helpers/layers_index.rst) diff --git a/doc/ui/api/trainer_config_helpers/layers.rst b/doc/ui/api/trainer_config_helpers/layers.rst index 4a02af3969..b487b739a7 100644 --- a/doc/ui/api/trainer_config_helpers/layers.rst +++ b/doc/ui/api/trainer_config_helpers/layers.rst @@ -192,7 +192,7 @@ embedding_layer :noindex: scaling_projection ------------------ +------------------ .. automodule:: paddle.trainer_config_helpers.layers :members: scaling_projection :noindex: diff --git a/doc/user_guide.rst b/doc/user_guide.rst new file mode 100644 index 0000000000..d4deb3ca5a --- /dev/null +++ b/doc/user_guide.rst @@ -0,0 +1,13 @@ +User Guide +========== + +.. toctree:: + :maxdepth: 1 + + demo/quick_start/index_en.md + build/index.rst + build/contribute_to_paddle.md + ui/index.md + ui/api/trainer_config_helpers/index.rst + demo/index.md + cluster/index.md diff --git a/python/paddle/trainer_config_helpers/layers.py b/python/paddle/trainer_config_helpers/layers.py index 7cd290023a..d984e84320 100644 --- a/python/paddle/trainer_config_helpers/layers.py +++ b/python/paddle/trainer_config_helpers/layers.py @@ -3807,6 +3807,7 @@ def linear_comb_layer(weights, vectors, size=None, name=None, layer_attr=None): .. math:: z(i) = \sum_{j=0}^{M-1} x(j) y(i+Nj) + where :math:`0 \le i \le N-1` Or in the matrix notation: -- GitLab