diff --git a/doc/algorithm/index.rst b/doc/algorithm/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..6073add3c0cbb12529eabb0f8d8a051bcb84e628 --- /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 343f55a20e464f63f054ebe724b5ef90f848d5e9..399c5da5fffc20dda78b9eefb2629308cabd748e 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 a9ab69c5f42b8d341dca87479a642e28ca58fbf4..1d03eb7362b1b6f2fcdac7b53f8b7f93fb75e49c 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 511cdea145c7fd0e41566d0a85115dbb06f84058..b4fe4596047c7d201fdf36bc76c26d5134611560 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 e7d74512292c89233373c48d05895794d56702d8..80d816a768a71156ce72cda6ea92b749fbcdbe1f 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 0000000000000000000000000000000000000000..0468dd492b6246cfe0771a05c3597ddee95b3ddd --- /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 0000000000000000000000000000000000000000..930fb0de1ac074b15d06197ed0e732f92288b411 --- /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 37dac3a14dedf2aaa99335e1b0ebe110dc746174..0000000000000000000000000000000000000000 --- 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 bd4a4c46c87f6429338b4d220a80b6265a1f253f..2fa00730486dbe1f2c9585872068a77efa09f004 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 cbd08ba52abe529aec84f6b1c2e35300496878a5..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..668ad75a902bdd14c6198c41380ae93e29cec0d3 --- /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 45f2e2bad542ff5c29c89201b356728cf7ca8c1c..0000000000000000000000000000000000000000 --- 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 4a02af396993207d305be488c993ce94cf20fe1d..b487b739a719e9f7118efcc143301da36f7a978e 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 0000000000000000000000000000000000000000..d4deb3ca5a4523b509ea5082f32be8a315570dea --- /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 7cd290023aba10eba63d307b96aac57734d043c0..d984e843204c1cd99ee5b8941dc056c091504869 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: