From 5c551f90558955fd8d05a3bee55af6c302ddc0aa Mon Sep 17 00:00:00 2001 From: liaogang Date: Tue, 29 Nov 2016 15:34:52 +0800 Subject: [PATCH] refine doc structure and revise some words --- doc/about/index.rst | 10 ++--- doc/api/data_provider/index.rst | 4 +- doc/api/data_provider/pydataprovider2.rst | 4 +- doc/api/index.md | 14 ------- doc/api/index.rst | 36 ++++++++++++++++++ doc/api/predict/swig_py_paddle_en.rst | 4 +- doc/api/trainer_config_helpers/attrs.rst | 4 +- doc/api/trainer_config_helpers/index.rst | 14 ------- .../basic_usage/basic_usage.rst | 0 .../basic_usage/parameters.png | Bin .../build_and_install/build_from_source.md | 0 .../build_and_install/cmake.png | Bin .../build_and_install/docker_install.rst | 0 .../build_and_install/index.rst | 0 .../build_and_install/ubuntu_install.rst | 0 doc/{introduction => getstarted}/index.rst | 2 +- doc/howto/algorithm/index.rst | 7 ---- doc/howto/algorithm/rnn/bi_lstm.jpg | 1 - .../rnn/encoder-decoder-attention-model.png | 1 - doc/howto/cluster/cluster_train.md | 2 +- .../arguments.md} | 0 .../detail_introduction.md | 0 .../{cmd_argument => cmd_parameter}/index.md | 4 +- .../use_case.md | 0 doc/howto/contribute_to_paddle.md | 2 +- doc/howto/deep_model/index.rst | 7 ++++ .../{algorithm => deep_model}/rnn/rnn.rst | 4 +- doc/howto/dev/index.rst | 9 ----- doc/howto/dev/layer.md | 5 --- doc/howto/index.rst | 27 ++++++++++--- .../{dev => }/new_layer/FullyConnected.jpg | Bin .../new_layer.rst => new_layer/index.rst} | 6 +-- doc/howto/optimization/index.rst | 4 +- doc/howto/{dev => }/source/api.rst | 0 doc/howto/{dev => }/source/cuda/index.rst | 0 doc/howto/{dev => }/source/cuda/matrix.rst | 0 doc/howto/{dev => }/source/cuda/nn.rst | 0 doc/howto/{dev => }/source/cuda/utils.rst | 0 .../{dev => }/source/gserver/activations.rst | 0 .../source/gserver/dataproviders.rst | 0 .../{dev => }/source/gserver/evaluators.rst | 0 .../source/gserver/gradientmachines.rst | 0 doc/howto/{dev => }/source/gserver/index.rst | 0 doc/howto/{dev => }/source/gserver/layers.rst | 0 .../{dev => }/source/gserver/neworks.rst | 0 doc/howto/{dev => }/source/index.rst | 0 doc/howto/{dev => }/source/math/functions.rst | 0 doc/howto/{dev => }/source/math/index.rst | 0 doc/howto/{dev => }/source/math/matrix.rst | 0 doc/howto/{dev => }/source/math/utils.rst | 0 doc/howto/{dev => }/source/math/vector.rst | 0 .../{dev => }/source/parameter/index.rst | 0 .../{dev => }/source/parameter/optimizer.rst | 0 .../{dev => }/source/parameter/parameter.rst | 0 .../{dev => }/source/parameter/updater.rst | 0 doc/howto/{dev => }/source/pserver/client.rst | 0 doc/howto/{dev => }/source/pserver/index.rst | 0 .../{dev => }/source/pserver/network.rst | 0 doc/howto/{dev => }/source/pserver/server.rst | 0 doc/howto/{dev => }/source/trainer.rst | 0 .../source/utils/customStackTrace.rst | 0 doc/howto/{dev => }/source/utils/enum.rst | 0 doc/howto/{dev => }/source/utils/index.rst | 0 doc/howto/{dev => }/source/utils/lock.rst | 0 doc/howto/{dev => }/source/utils/queue.rst | 0 doc/howto/{dev => }/source/utils/thread.rst | 0 doc/index.rst | 2 +- doc/tutorials/index.md | 2 +- 68 files changed, 92 insertions(+), 83 deletions(-) delete mode 100644 doc/api/index.md create mode 100644 doc/api/index.rst delete mode 100644 doc/api/trainer_config_helpers/index.rst rename doc/{introduction => getstarted}/basic_usage/basic_usage.rst (100%) rename doc/{introduction => getstarted}/basic_usage/parameters.png (100%) rename doc/{introduction => getstarted}/build_and_install/build_from_source.md (100%) rename doc/{introduction => getstarted}/build_and_install/cmake.png (100%) rename doc/{introduction => getstarted}/build_and_install/docker_install.rst (100%) rename doc/{introduction => getstarted}/build_and_install/index.rst (100%) rename doc/{introduction => getstarted}/build_and_install/ubuntu_install.rst (100%) rename doc/{introduction => getstarted}/index.rst (88%) delete mode 100644 doc/howto/algorithm/index.rst delete mode 120000 doc/howto/algorithm/rnn/bi_lstm.jpg delete mode 120000 doc/howto/algorithm/rnn/encoder-decoder-attention-model.png rename doc/howto/{cmd_argument/argument_outline.md => cmd_parameter/arguments.md} (100%) rename doc/howto/{cmd_argument => cmd_parameter}/detail_introduction.md (100%) rename doc/howto/{cmd_argument => cmd_parameter}/index.md (53%) rename doc/howto/{cmd_argument => cmd_parameter}/use_case.md (100%) create mode 100644 doc/howto/deep_model/index.rst rename doc/howto/{algorithm => deep_model}/rnn/rnn.rst (99%) delete mode 100644 doc/howto/dev/index.rst delete mode 100644 doc/howto/dev/layer.md rename doc/howto/{dev => }/new_layer/FullyConnected.jpg (100%) rename doc/howto/{dev/new_layer/new_layer.rst => new_layer/index.rst} (99%) rename doc/howto/{dev => }/source/api.rst (100%) rename doc/howto/{dev => }/source/cuda/index.rst (100%) rename doc/howto/{dev => }/source/cuda/matrix.rst (100%) rename doc/howto/{dev => }/source/cuda/nn.rst (100%) rename doc/howto/{dev => }/source/cuda/utils.rst (100%) rename doc/howto/{dev => }/source/gserver/activations.rst (100%) rename doc/howto/{dev => }/source/gserver/dataproviders.rst (100%) rename doc/howto/{dev => }/source/gserver/evaluators.rst (100%) rename doc/howto/{dev => }/source/gserver/gradientmachines.rst (100%) rename doc/howto/{dev => }/source/gserver/index.rst (100%) rename doc/howto/{dev => }/source/gserver/layers.rst (100%) rename doc/howto/{dev => }/source/gserver/neworks.rst (100%) rename doc/howto/{dev => }/source/index.rst (100%) rename doc/howto/{dev => }/source/math/functions.rst (100%) rename doc/howto/{dev => }/source/math/index.rst (100%) rename doc/howto/{dev => }/source/math/matrix.rst (100%) rename doc/howto/{dev => }/source/math/utils.rst (100%) rename doc/howto/{dev => }/source/math/vector.rst (100%) rename doc/howto/{dev => }/source/parameter/index.rst (100%) rename doc/howto/{dev => }/source/parameter/optimizer.rst (100%) rename doc/howto/{dev => }/source/parameter/parameter.rst (100%) rename doc/howto/{dev => }/source/parameter/updater.rst (100%) rename doc/howto/{dev => }/source/pserver/client.rst (100%) rename doc/howto/{dev => }/source/pserver/index.rst (100%) rename doc/howto/{dev => }/source/pserver/network.rst (100%) rename doc/howto/{dev => }/source/pserver/server.rst (100%) rename doc/howto/{dev => }/source/trainer.rst (100%) rename doc/howto/{dev => }/source/utils/customStackTrace.rst (100%) rename doc/howto/{dev => }/source/utils/enum.rst (100%) rename doc/howto/{dev => }/source/utils/index.rst (100%) rename doc/howto/{dev => }/source/utils/lock.rst (100%) rename doc/howto/{dev => }/source/utils/queue.rst (100%) rename doc/howto/{dev => }/source/utils/thread.rst (100%) diff --git a/doc/about/index.rst b/doc/about/index.rst index 511c1546413..8a372d2bc2b 100644 --- a/doc/about/index.rst +++ b/doc/about/index.rst @@ -1,14 +1,14 @@ -About +ABOUT ======= - -Credits --------- - PaddlPaddle is an easy-to-use, efficient, flexible and scalable deep learning platform, which is originally developed by Baidu scientists and engineers for the purpose of applying deep learning to many products at Baidu. PaddlePaddle is now open source but far from complete, which is intended to be built upon, improved, scaled, and extended. We hope to build an active open source community both by providing feedback and by actively contributing to the source code. + +Credits +-------- + We owe many thanks to `all contributors and developers `_ of PaddlePaddle! diff --git a/doc/api/data_provider/index.rst b/doc/api/data_provider/index.rst index 3db5b573762..5e7a49d6323 100644 --- a/doc/api/data_provider/index.rst +++ b/doc/api/data_provider/index.rst @@ -1,5 +1,5 @@ -DataProvider Introduction -========================= +Introduction +============== DataProvider is a module that loads training or testing data into cpu or gpu memory for the following triaining or testing process. diff --git a/doc/api/data_provider/pydataprovider2.rst b/doc/api/data_provider/pydataprovider2.rst index e105d3be308..b42cbca576e 100644 --- a/doc/api/data_provider/pydataprovider2.rst +++ b/doc/api/data_provider/pydataprovider2.rst @@ -1,5 +1,5 @@ -How to use PyDataProvider2 -========================== +PyDataProvider2 +================= We highly recommand users to use PyDataProvider2 to provide training or testing data to PaddlePaddle. The user only needs to focus on how to read a single diff --git a/doc/api/index.md b/doc/api/index.md deleted file mode 100644 index 8c4a65e0d5c..00000000000 --- a/doc/api/index.md +++ /dev/null @@ -1,14 +0,0 @@ -# API - -## Data Provider - -* [Introduction](data_provider/index.rst) -* [PyDataProvider2](data_provider/pydataprovider2.rst) - -## Trainer Configuration - -* [Model Config Interface](trainer_config_helpers/index.rst) - -## Predict - -* [Python Prediction API](predict/swig_py_paddle_en.rst) diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 00000000000..ccee7a0f1f3 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,36 @@ +API +==== + +DataProvider API +---------------- + +.. toctree:: + :maxdepth: 1 + + data_provider/index.rst + data_provider/pydataprovider2.rst + +Model Config API +---------------- + +.. toctree:: + :maxdepth: 1 + + trainer_config_helpers/index.rst + trainer_config_helpers/optimizers.rst + trainer_config_helpers/data_sources.rst + trainer_config_helpers/layers.rst + trainer_config_helpers/activations.rst + trainer_config_helpers/poolings.rst + trainer_config_helpers/networks.rst + trainer_config_helpers/evaluators.rst + trainer_config_helpers/attrs.rst + + +Applications API +---------------- + +.. toctree:: + :maxdepth: 1 + + predict/swig_py_paddle_en.rst \ No newline at end of file diff --git a/doc/api/predict/swig_py_paddle_en.rst b/doc/api/predict/swig_py_paddle_en.rst index b743fc45691..9845cd1607b 100644 --- a/doc/api/predict/swig_py_paddle_en.rst +++ b/doc/api/predict/swig_py_paddle_en.rst @@ -1,5 +1,5 @@ -Python Prediction API -===================== +Python Prediction +================== PaddlePaddle offers a set of clean prediction interfaces for python with the help of SWIG. The main steps of predict values in python are: diff --git a/doc/api/trainer_config_helpers/attrs.rst b/doc/api/trainer_config_helpers/attrs.rst index 44919aba90d..ac63127bf7d 100644 --- a/doc/api/trainer_config_helpers/attrs.rst +++ b/doc/api/trainer_config_helpers/attrs.rst @@ -1,5 +1,5 @@ -Parameter and Extra Layer Attribute -=================================== +Parameter Attributes +======================= .. automodule:: paddle.trainer_config_helpers.attrs :members: diff --git a/doc/api/trainer_config_helpers/index.rst b/doc/api/trainer_config_helpers/index.rst deleted file mode 100644 index 8395eb75710..00000000000 --- a/doc/api/trainer_config_helpers/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -Model Config Interface -====================== - -.. toctree:: - :maxdepth: 1 - - optimizers.rst - data_sources.rst - layers.rst - activations.rst - poolings.rst - networks.rst - evaluators.rst - attrs.rst diff --git a/doc/introduction/basic_usage/basic_usage.rst b/doc/getstarted/basic_usage/basic_usage.rst similarity index 100% rename from doc/introduction/basic_usage/basic_usage.rst rename to doc/getstarted/basic_usage/basic_usage.rst diff --git a/doc/introduction/basic_usage/parameters.png b/doc/getstarted/basic_usage/parameters.png similarity index 100% rename from doc/introduction/basic_usage/parameters.png rename to doc/getstarted/basic_usage/parameters.png diff --git a/doc/introduction/build_and_install/build_from_source.md b/doc/getstarted/build_and_install/build_from_source.md similarity index 100% rename from doc/introduction/build_and_install/build_from_source.md rename to doc/getstarted/build_and_install/build_from_source.md diff --git a/doc/introduction/build_and_install/cmake.png b/doc/getstarted/build_and_install/cmake.png similarity index 100% rename from doc/introduction/build_and_install/cmake.png rename to doc/getstarted/build_and_install/cmake.png diff --git a/doc/introduction/build_and_install/docker_install.rst b/doc/getstarted/build_and_install/docker_install.rst similarity index 100% rename from doc/introduction/build_and_install/docker_install.rst rename to doc/getstarted/build_and_install/docker_install.rst diff --git a/doc/introduction/build_and_install/index.rst b/doc/getstarted/build_and_install/index.rst similarity index 100% rename from doc/introduction/build_and_install/index.rst rename to doc/getstarted/build_and_install/index.rst diff --git a/doc/introduction/build_and_install/ubuntu_install.rst b/doc/getstarted/build_and_install/ubuntu_install.rst similarity index 100% rename from doc/introduction/build_and_install/ubuntu_install.rst rename to doc/getstarted/build_and_install/ubuntu_install.rst diff --git a/doc/introduction/index.rst b/doc/getstarted/index.rst similarity index 88% rename from doc/introduction/index.rst rename to doc/getstarted/index.rst index ff22f05a1b6..5f2787066ea 100644 --- a/doc/introduction/index.rst +++ b/doc/getstarted/index.rst @@ -1,4 +1,4 @@ -Introduction +GET STARTED ============ .. toctree:: diff --git a/doc/howto/algorithm/index.rst b/doc/howto/algorithm/index.rst deleted file mode 100644 index b4ecbc48470..00000000000 --- a/doc/howto/algorithm/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Algorithm Configuration -======================= - -.. toctree:: - :maxdepth: 1 - - rnn/rnn.rst diff --git a/doc/howto/algorithm/rnn/bi_lstm.jpg b/doc/howto/algorithm/rnn/bi_lstm.jpg deleted file mode 120000 index f8f3b17691c..00000000000 --- a/doc/howto/algorithm/rnn/bi_lstm.jpg +++ /dev/null @@ -1 +0,0 @@ -../../../tutorials/sentiment_analysis/bi_lstm.jpg \ No newline at end of file diff --git a/doc/howto/algorithm/rnn/encoder-decoder-attention-model.png b/doc/howto/algorithm/rnn/encoder-decoder-attention-model.png deleted file mode 120000 index 88a1d3e5ac4..00000000000 --- a/doc/howto/algorithm/rnn/encoder-decoder-attention-model.png +++ /dev/null @@ -1 +0,0 @@ -../../../tutorials/text_generation/encoder-decoder-attention-model.png \ No newline at end of file diff --git a/doc/howto/cluster/cluster_train.md b/doc/howto/cluster/cluster_train.md index 6b68596dc12..1de34a6a994 100644 --- a/doc/howto/cluster/cluster_train.md +++ b/doc/howto/cluster/cluster_train.md @@ -1,4 +1,4 @@ -# Distributed Training +# How to Run Distributed Training In this article, we explain how to run distributed Paddle training jobs on clusters. We will create the distributed version of the single-process training example, [recommendation](https://github.com/baidu/Paddle/tree/develop/demo/recommendation). diff --git a/doc/howto/cmd_argument/argument_outline.md b/doc/howto/cmd_parameter/arguments.md similarity index 100% rename from doc/howto/cmd_argument/argument_outline.md rename to doc/howto/cmd_parameter/arguments.md diff --git a/doc/howto/cmd_argument/detail_introduction.md b/doc/howto/cmd_parameter/detail_introduction.md similarity index 100% rename from doc/howto/cmd_argument/detail_introduction.md rename to doc/howto/cmd_parameter/detail_introduction.md diff --git a/doc/howto/cmd_argument/index.md b/doc/howto/cmd_parameter/index.md similarity index 53% rename from doc/howto/cmd_argument/index.md rename to doc/howto/cmd_parameter/index.md index 90472c44cb9..48cf835de14 100644 --- a/doc/howto/cmd_argument/index.md +++ b/doc/howto/cmd_parameter/index.md @@ -1,5 +1,5 @@ -# Command Line Argument +# How to Set Command-line Parameters * [Use Case](use_case.md) -* [Argument Outline](argument_outline.md) +* [Arguments](arguments.md) * [Detailed Descriptions](detail_introduction.md) diff --git a/doc/howto/cmd_argument/use_case.md b/doc/howto/cmd_parameter/use_case.md similarity index 100% rename from doc/howto/cmd_argument/use_case.md rename to doc/howto/cmd_parameter/use_case.md diff --git a/doc/howto/contribute_to_paddle.md b/doc/howto/contribute_to_paddle.md index 1d03eb7362b..d1f12c6ab2f 100644 --- a/doc/howto/contribute_to_paddle.md +++ b/doc/howto/contribute_to_paddle.md @@ -1,4 +1,4 @@ -# Contribute Code +# How to Contribute Code We sincerely appreciate your contributions. You can use fork and pull request workflow to merge your code. diff --git a/doc/howto/deep_model/index.rst b/doc/howto/deep_model/index.rst new file mode 100644 index 00000000000..06ef443f62f --- /dev/null +++ b/doc/howto/deep_model/index.rst @@ -0,0 +1,7 @@ +How to Configure Deep Models +============================ + +.. toctree:: + :maxdepth: 1 + + rnn/rnn.rst diff --git a/doc/howto/algorithm/rnn/rnn.rst b/doc/howto/deep_model/rnn/rnn.rst similarity index 99% rename from doc/howto/algorithm/rnn/rnn.rst rename to doc/howto/deep_model/rnn/rnn.rst index 01d2caefb5c..da29b8efadd 100644 --- a/doc/howto/algorithm/rnn/rnn.rst +++ b/doc/howto/deep_model/rnn/rnn.rst @@ -42,7 +42,7 @@ Simple Gated Recurrent Neural Network Recurrent neural network process a sequence at each time step sequentially. An example of the architecture of LSTM is listed below. -.. image:: ./bi_lstm.jpg +.. image:: ../../../tutorials/sentiment_analysis/bi_lstm.jpg :align: center Generally speaking, a recurrent network perform the following operations from :math:`t=1` to :math:`t=T`, or reversely from :math:`t=T` to :math:`t=1`. @@ -101,7 +101,7 @@ Sequence to Sequence Model with Attention ----------------------------------------- We will use the sequence to sequence model with attention as an example to demonstrate how you can configure complex recurrent neural network models. An illustration of the sequence to sequence model with attention is shown in the following figure. -.. image:: ./encoder-decoder-attention-model.png +.. image:: ../../../tutorials/text_generation/encoder-decoder-attention-model.png :align: center In this model, the source sequence :math:`S = \{s_1, \dots, s_T\}` is encoded with a bidirectional gated recurrent neural networks. The hidden states of the bidirectional gated recurrent neural network :math:`H_S = \{H_1, \dots, H_T\}` is called *encoder vector* The decoder is a gated recurrent neural network. When decoding each token :math:`y_t`, the gated recurrent neural network generates a set of weights :math:`W_S^t = \{W_1^t, \dots, W_T^t\}`, which are used to compute a weighted sum of the encoder vector. The weighted sum of the encoder vector is utilized to condition the generation of the token :math:`y_t`. diff --git a/doc/howto/dev/index.rst b/doc/howto/dev/index.rst deleted file mode 100644 index 876c42e9dbb..00000000000 --- a/doc/howto/dev/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Development Guide -================= - -.. toctree:: - :maxdepth: 2 - - layer.md - new_layer/new_layer.rst - source/index.rst diff --git a/doc/howto/dev/layer.md b/doc/howto/dev/layer.md deleted file mode 100644 index 1ce0cc5829d..00000000000 --- a/doc/howto/dev/layer.md +++ /dev/null @@ -1,5 +0,0 @@ -# Layer Documents - -* [Layer Python API](../../api/trainer_config_helpers/index.rst) -* [Layer Source Code](source/gserver/layers.rst) -* [Writing New Layers](new_layer/new_layer.rst) diff --git a/doc/howto/index.rst b/doc/howto/index.rst index ed8294b3c15..41877a64a56 100644 --- a/doc/howto/index.rst +++ b/doc/howto/index.rst @@ -1,12 +1,29 @@ -How to +HOW TO ======= +Usage +------- + .. toctree:: :maxdepth: 1 - cmd_argument/index.md + cmd_parameter/index.md + deep_model/index.rst cluster/cluster_train.md - algorithm/index.rst + +Development +------------ + +.. toctree:: + :maxdepth: 1 + + new_layer/index.rst + contribute_to_paddle.md + +Optimization +------------- + +.. toctree:: + :maxdepth: 1 + optimization/index.rst - dev/index.rst - contribute_to_paddle.md \ No newline at end of file diff --git a/doc/howto/dev/new_layer/FullyConnected.jpg b/doc/howto/new_layer/FullyConnected.jpg similarity index 100% rename from doc/howto/dev/new_layer/FullyConnected.jpg rename to doc/howto/new_layer/FullyConnected.jpg diff --git a/doc/howto/dev/new_layer/new_layer.rst b/doc/howto/new_layer/index.rst similarity index 99% rename from doc/howto/dev/new_layer/new_layer.rst rename to doc/howto/new_layer/index.rst index af8b76a3075..922bda5b0d8 100644 --- a/doc/howto/dev/new_layer/new_layer.rst +++ b/doc/howto/new_layer/index.rst @@ -1,6 +1,6 @@ -================== -Writing New Layers -================== +======================= +How to Write New Layers +======================= This tutorial will guide you to write customized layers in PaddlePaddle. We will utilize fully connected layer as an example to guide you through the following steps for writing a new layer. diff --git a/doc/howto/optimization/index.rst b/doc/howto/optimization/index.rst index c9e87e0778d..e2822a00982 100644 --- a/doc/howto/optimization/index.rst +++ b/doc/howto/optimization/index.rst @@ -1,5 +1,5 @@ -Performance Tuning -================== +How to Tune GPU Performance +=========================== .. toctree:: :maxdepth: 3 diff --git a/doc/howto/dev/source/api.rst b/doc/howto/source/api.rst similarity index 100% rename from doc/howto/dev/source/api.rst rename to doc/howto/source/api.rst diff --git a/doc/howto/dev/source/cuda/index.rst b/doc/howto/source/cuda/index.rst similarity index 100% rename from doc/howto/dev/source/cuda/index.rst rename to doc/howto/source/cuda/index.rst diff --git a/doc/howto/dev/source/cuda/matrix.rst b/doc/howto/source/cuda/matrix.rst similarity index 100% rename from doc/howto/dev/source/cuda/matrix.rst rename to doc/howto/source/cuda/matrix.rst diff --git a/doc/howto/dev/source/cuda/nn.rst b/doc/howto/source/cuda/nn.rst similarity index 100% rename from doc/howto/dev/source/cuda/nn.rst rename to doc/howto/source/cuda/nn.rst diff --git a/doc/howto/dev/source/cuda/utils.rst b/doc/howto/source/cuda/utils.rst similarity index 100% rename from doc/howto/dev/source/cuda/utils.rst rename to doc/howto/source/cuda/utils.rst diff --git a/doc/howto/dev/source/gserver/activations.rst b/doc/howto/source/gserver/activations.rst similarity index 100% rename from doc/howto/dev/source/gserver/activations.rst rename to doc/howto/source/gserver/activations.rst diff --git a/doc/howto/dev/source/gserver/dataproviders.rst b/doc/howto/source/gserver/dataproviders.rst similarity index 100% rename from doc/howto/dev/source/gserver/dataproviders.rst rename to doc/howto/source/gserver/dataproviders.rst diff --git a/doc/howto/dev/source/gserver/evaluators.rst b/doc/howto/source/gserver/evaluators.rst similarity index 100% rename from doc/howto/dev/source/gserver/evaluators.rst rename to doc/howto/source/gserver/evaluators.rst diff --git a/doc/howto/dev/source/gserver/gradientmachines.rst b/doc/howto/source/gserver/gradientmachines.rst similarity index 100% rename from doc/howto/dev/source/gserver/gradientmachines.rst rename to doc/howto/source/gserver/gradientmachines.rst diff --git a/doc/howto/dev/source/gserver/index.rst b/doc/howto/source/gserver/index.rst similarity index 100% rename from doc/howto/dev/source/gserver/index.rst rename to doc/howto/source/gserver/index.rst diff --git a/doc/howto/dev/source/gserver/layers.rst b/doc/howto/source/gserver/layers.rst similarity index 100% rename from doc/howto/dev/source/gserver/layers.rst rename to doc/howto/source/gserver/layers.rst diff --git a/doc/howto/dev/source/gserver/neworks.rst b/doc/howto/source/gserver/neworks.rst similarity index 100% rename from doc/howto/dev/source/gserver/neworks.rst rename to doc/howto/source/gserver/neworks.rst diff --git a/doc/howto/dev/source/index.rst b/doc/howto/source/index.rst similarity index 100% rename from doc/howto/dev/source/index.rst rename to doc/howto/source/index.rst diff --git a/doc/howto/dev/source/math/functions.rst b/doc/howto/source/math/functions.rst similarity index 100% rename from doc/howto/dev/source/math/functions.rst rename to doc/howto/source/math/functions.rst diff --git a/doc/howto/dev/source/math/index.rst b/doc/howto/source/math/index.rst similarity index 100% rename from doc/howto/dev/source/math/index.rst rename to doc/howto/source/math/index.rst diff --git a/doc/howto/dev/source/math/matrix.rst b/doc/howto/source/math/matrix.rst similarity index 100% rename from doc/howto/dev/source/math/matrix.rst rename to doc/howto/source/math/matrix.rst diff --git a/doc/howto/dev/source/math/utils.rst b/doc/howto/source/math/utils.rst similarity index 100% rename from doc/howto/dev/source/math/utils.rst rename to doc/howto/source/math/utils.rst diff --git a/doc/howto/dev/source/math/vector.rst b/doc/howto/source/math/vector.rst similarity index 100% rename from doc/howto/dev/source/math/vector.rst rename to doc/howto/source/math/vector.rst diff --git a/doc/howto/dev/source/parameter/index.rst b/doc/howto/source/parameter/index.rst similarity index 100% rename from doc/howto/dev/source/parameter/index.rst rename to doc/howto/source/parameter/index.rst diff --git a/doc/howto/dev/source/parameter/optimizer.rst b/doc/howto/source/parameter/optimizer.rst similarity index 100% rename from doc/howto/dev/source/parameter/optimizer.rst rename to doc/howto/source/parameter/optimizer.rst diff --git a/doc/howto/dev/source/parameter/parameter.rst b/doc/howto/source/parameter/parameter.rst similarity index 100% rename from doc/howto/dev/source/parameter/parameter.rst rename to doc/howto/source/parameter/parameter.rst diff --git a/doc/howto/dev/source/parameter/updater.rst b/doc/howto/source/parameter/updater.rst similarity index 100% rename from doc/howto/dev/source/parameter/updater.rst rename to doc/howto/source/parameter/updater.rst diff --git a/doc/howto/dev/source/pserver/client.rst b/doc/howto/source/pserver/client.rst similarity index 100% rename from doc/howto/dev/source/pserver/client.rst rename to doc/howto/source/pserver/client.rst diff --git a/doc/howto/dev/source/pserver/index.rst b/doc/howto/source/pserver/index.rst similarity index 100% rename from doc/howto/dev/source/pserver/index.rst rename to doc/howto/source/pserver/index.rst diff --git a/doc/howto/dev/source/pserver/network.rst b/doc/howto/source/pserver/network.rst similarity index 100% rename from doc/howto/dev/source/pserver/network.rst rename to doc/howto/source/pserver/network.rst diff --git a/doc/howto/dev/source/pserver/server.rst b/doc/howto/source/pserver/server.rst similarity index 100% rename from doc/howto/dev/source/pserver/server.rst rename to doc/howto/source/pserver/server.rst diff --git a/doc/howto/dev/source/trainer.rst b/doc/howto/source/trainer.rst similarity index 100% rename from doc/howto/dev/source/trainer.rst rename to doc/howto/source/trainer.rst diff --git a/doc/howto/dev/source/utils/customStackTrace.rst b/doc/howto/source/utils/customStackTrace.rst similarity index 100% rename from doc/howto/dev/source/utils/customStackTrace.rst rename to doc/howto/source/utils/customStackTrace.rst diff --git a/doc/howto/dev/source/utils/enum.rst b/doc/howto/source/utils/enum.rst similarity index 100% rename from doc/howto/dev/source/utils/enum.rst rename to doc/howto/source/utils/enum.rst diff --git a/doc/howto/dev/source/utils/index.rst b/doc/howto/source/utils/index.rst similarity index 100% rename from doc/howto/dev/source/utils/index.rst rename to doc/howto/source/utils/index.rst diff --git a/doc/howto/dev/source/utils/lock.rst b/doc/howto/source/utils/lock.rst similarity index 100% rename from doc/howto/dev/source/utils/lock.rst rename to doc/howto/source/utils/lock.rst diff --git a/doc/howto/dev/source/utils/queue.rst b/doc/howto/source/utils/queue.rst similarity index 100% rename from doc/howto/dev/source/utils/queue.rst rename to doc/howto/source/utils/queue.rst diff --git a/doc/howto/dev/source/utils/thread.rst b/doc/howto/source/utils/thread.rst similarity index 100% rename from doc/howto/dev/source/utils/thread.rst rename to doc/howto/source/utils/thread.rst diff --git a/doc/index.rst b/doc/index.rst index 36a410881ad..3555da1dfc8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,7 +4,7 @@ PaddlePaddle Documentation .. toctree:: :maxdepth: 1 - introduction/index.rst + getstarted/index.rst tutorials/index.md howto/index.rst api/index.rst diff --git a/doc/tutorials/index.md b/doc/tutorials/index.md index c845ca229cb..ebf5397391e 100644 --- a/doc/tutorials/index.md +++ b/doc/tutorials/index.md @@ -1,4 +1,4 @@ -# Tutorials +# TUTORIALS There are serveral examples and demos here. ## Image -- GitLab