Merge pull request #519 from luotao1/doc2

modify directory structure in source code

doc/source/api.rst

@@ -1,5 +1,5 @@
 API
-========
+===
 
 .. doxygenfile:: paddle/api/PaddleAPI.h
 .. doxygenfile:: paddle/api/Internal.h

doc/source/cuda/cuda/cuda.rst

@@ -1,39 +0,0 @@
-Cuda
-=============
-
-Dynamic Link Libs
---------------------------
-
-hl_dso_loader.h
-``````````````````
-.. doxygenfile:: paddle/cuda/include/hl_dso_loader.h
-
-GPU Resources
-----------------
-
-hl_cuda.ph
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.ph
-
-hl_cuda.h
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.h
-
-CUDA Wrapper
---------------
-
-hl_cuda_cublas.h
-``````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
-
-hl_cuda_cudnn.h
-``````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
-
-hl_cuda_cudnn.h
-``````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph
-
-
-
-

doc/source/cuda/cuda/index.rst

@@ -1,7 +0,0 @@
-CUDA
-====================
-
-.. toctree::
-  :maxdepth: 3
-
-  cuda.rst

doc/source/cuda/index.rst

@@ -0,0 +1,9 @@
+CUDA
+====
+
+.. toctree::
+  :maxdepth: 2
+
+  matrix.rst
+  nn.rst
+  utils.rst

doc/source/cuda/matrix.rst

@@ -1,61 +1,59 @@
 Matrix
-=======
+======
 
-Base Matrix
+Base
--------------
+----
 
 hl_matrix.h
-``````````````````
+```````````
 .. doxygenfile:: paddle/cuda/include/hl_matrix.h
 
 hl_matrix_base.h
-``````````````````
+````````````````
 .. doxygenfile:: paddle/cuda/include/hl_matrix_base.cuh
 
 hl_matrix_apply.cuh
-``````````````````````
+```````````````````
 .. doxygenfile:: paddle/cuda/include/hl_matrix_apply.cuh
 
 hl_matrix_ops.cuh
-``````````````````````
+`````````````````
 .. doxygenfile:: paddle/cuda/include/hl_matrix_ops.cuh
 
 hl_matrix_type.cuh
-``````````````````````
+``````````````````
 .. doxygenfile:: paddle/cuda/include/hl_matrix_type.cuh
 
 hl_sse_matrix_kernel.cuh
-``````````````````````````
+````````````````````````
 .. doxygenfile:: paddle/cuda/include/hl_sse_matrix_kernel.cuh
 
+Matrix Function 
+---------------
+
 hl_batch_transpose.h
-``````````````````````````
+````````````````````
 .. doxygenfile:: paddle/cuda/include/hl_batch_transpose.h
 
-Sparse Matrix
---------------
-
-hl_sparse.h
-``````````````````
-.. doxygenfile:: paddle/cuda/include/hl_sparse.h
-
-hl_sparse.ph
-``````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_sparse.ph
-
-Others
----------------
-
 hl_aggregate.h
-``````````````````
+``````````````
 .. doxygenfile:: paddle/cuda/include/hl_aggregate.h
 
+hl_top_k.h
+``````````
+.. doxygenfile:: paddle/cuda/include/hl_top_k.h
+
 hl_table_apply.h
-``````````````````
+````````````````
 .. doxygenfile:: paddle/cuda/include/hl_table_apply.h
 
-hl_top_k.h
+Sparse Matrix
-``````````````````
+-------------
-.. doxygenfile:: paddle/cuda/include/hl_top_k.h
 
+hl_sparse.h
+```````````
+.. doxygenfile:: paddle/cuda/include/hl_sparse.h
 
+hl_sparse.ph
+````````````
+.. doxygenfile:: paddle/cuda/include/hl_sparse.ph

doc/source/cuda/matrix/index.rst

@@ -1,7 +0,0 @@
-Matrix
-====================
-
-.. toctree::
-  :maxdepth: 3
-
-  matrix.rst

doc/source/cuda/nn.rst

@@ -1,36 +1,39 @@
-Neural Networks
+Neural Network
-==================
+==============
 
 Base
--------
+----
+
 .. doxygenfile:: paddle/cuda/include/hl_gpu.h
-.. doxygenfile:: paddle/cuda/include/hl_cnn.h
 .. doxygenfile:: paddle/cuda/include/hl_functions.h
 .. doxygenfile:: paddle/cuda/include/hl_avx_functions.h
-.. doxygenfile:: paddle/cuda/include/hl_device_functions.cuh
 .. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh
-
-Activation Functions
------------------------
 .. doxygenfile:: paddle/cuda/include/hl_activation_functions.h
 
+
+CNN Related APIs
+----------------
+.. doxygenfile:: paddle/cuda/include/hl_cnn.h
+.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
+.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph
+
 RNN Related APIs
------------------
+----------------
 
 .. doxygenfile:: paddle/cuda/include/hl_recurrent_apply.cuh
 .. doxygenfile:: paddle/cuda/include/hl_sequence.h
 
 LSTM Model
-``````````````
+``````````
+
 .. doxygenfile:: paddle/cuda/include/hl_lstm.h
 .. dpxygenfile:: paddle/cuda/include/hl_cpu_lstm.cuh
 .. doxygenfile:: paddle/cuda/include/hl_gpu_lstm.cuh
 .. doxygenfile:: paddle/cuda/include/hl_lstm_ops.cuh
 
 GRU Model
-````````````````
+`````````
+
 .. doxygenfile:: paddle/cuda/include/hl_gru_ops.cuh
 .. doxygenfile:: paddle/cuda/include/hl_cpu_gru.cuh
 .. doxygenfile:: paddle/cuda/include/hl_gpu_gru.cuh
-
-

doc/source/cuda/rnn/index.rst

@@ -1,7 +0,0 @@
-RNN
-====================
-
-.. toctree::
-  :maxdepth: 3
-
-  rnn.rst

doc/source/cuda/utils.rst

@@ -0,0 +1,37 @@
+Utils
+=====
+
+Dynamic Link Libs
+-----------------
+.. doxygenfile:: paddle/cuda/include/hl_dso_loader.h
+
+GPU Resources
+-------------
+
+hl_cuda.ph
+``````````
+.. doxygenfile:: paddle/cuda/include/hl_cuda.ph
+
+hl_cuda.h
+`````````
+.. doxygenfile:: paddle/cuda/include/hl_cuda.h
+
+HPPL Base
+---------
+.. doxygenfile:: paddle/cuda/include/hl_base.h
+
+CUBLAS Wrapper
+--------------
+.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
+
+Timer
+-----
+.. doxygenfile:: paddle/cuda/include/hl_time.h
+
+Thread Resource
+---------------
+.. doxygenfile:: paddle/cuda/include/hl_thread.ph
+
+Device Function
+---------------
+.. doxygenfile:: paddle/cuda/include/hl_device_functions.cuh

doc/source/cuda/utils/index.rst

@@ -1,7 +0,0 @@
-Utils
-====================
-
-.. toctree::
-  :maxdepth: 3
-
-  utils.rst

doc/source/cuda/utils/utils.rst

@@ -1,23 +0,0 @@
-Utilities
-===========
-
-HPPL Base
-------------
-
-hl_base.h
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_base.h
-
-Timer
------------
-
-hl_time.h
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_time.h
-
-Thread Resource
------------
-
-hl_thread.ph
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_thread.ph

doc/source/gserver/activations.rst

@@ -1,5 +1,5 @@
 Activations
-=============
+===========
 
 ..  doxygenclass:: paddle::ActivationFunction
     :members:

doc/source/gserver/dataprovider/index.rst

@@ -1,7 +0,0 @@
-Data Providers Documents
-==========================
-
-.. toctree::
-  :maxdepth: 3
-
-  dataproviders.rst

doc/source/gserver/dataproviders.rst

@@ -1,23 +1,27 @@
+==============
 Data Providers
-================
+==============
 
-Base DataProvider
+DataProviders
-------------------
+=============
+
+Base
+----
 ..  doxygenclass:: paddle::DataProvider
     :members:
 
 DataProviderGroup
--------------------
+-----------------
 ..  doxygenclass:: paddle::DataProviderGroup
     :members:
 
 MultiDataProvider
--------------------
+-----------------
 ..  doxygenclass:: paddle::MultiDataProvider
     :members:
 
 PyDataProvider
-===================
+==============
 
 IFieldScanner
 -------------
@@ -45,7 +49,7 @@ SparseValueScanner
     :members:
 
 SequenceScanner
-------------------
+---------------
 ..  doxygenclass:: paddle::SparseValueScanner
     :members:
 
@@ -70,7 +74,7 @@ IPyDataProvider
     :members:
 
 ProtoDataProvider
-===================
+=================
 
 ProtoDataProvider
 ----------------
@@ -78,6 +82,6 @@ ProtoDataProvider
     :members:
 
 ProtoSequenceDataProvider
-----------------
+-------------------------
 ..  doxygenclass:: paddle::ProtoSequenceDataProvider
     :members:

doc/source/gserver/evaluators.rst

@@ -1,14 +1,15 @@
-Base Evaluator
+==========
-==============
+Evaluators
+==========
+
+Base
+====
 
-Evaluator
----------
 ..  doxygenclass:: paddle::Evaluator
     :members:
 
-
+Sum
-Utils
+===
-=====
 
 SumEvaluator
 ------------

doc/source/gserver/evaluators/index.rst

@@ -1,7 +0,0 @@
-Evaluators
-==========
-
-.. toctree::
-  :maxdepth: 3
-
-  evaluators.rst

doc/source/gserver/gradientmachines.rst

@@ -1,18 +1,18 @@
 Gradient Machines
-================
+=================
 
 GradientMachine
----------------------
+---------------
 ..  doxygenclass:: paddle::GradientMachine
     :members:
 
-GradientMachineModel
+GradientMachineMode
---------------------
+-------------------
 ..  doxygenclass:: paddle::IGradientMachineMode
     :members:
 
 MultiGradientMachine
----------------------
+--------------------
 ..  doxygenclass:: paddle::MultiGradientMachine
     :members:
 
@@ -21,20 +21,7 @@ TrainerThread
 ..  doxygenclass:: paddle::TrainerThread
     :members:
 
-Recurrent Gradient Machines
+RecurrentGradientMachine
----------------------------
+------------------------
 ..  doxygenclass:: paddle::RecurrentGradientMachine
     :members:
-
-Networks
-========
-
-NeuralNetwork
--------------
-..  doxygenclass:: paddle::NeuralNetwork
-    :members:
-
-ParallelNeuralNetwork
----------------------
-..  doxygenclass:: paddle::ParallelNeuralNetwork
-    :members:

doc/source/gserver/gradientmachines/index.rst

@@ -1,7 +0,0 @@
-Gradient Machines Documents
-=============================
-
-.. toctree::
-  :maxdepth: 3
-
-  gradientmachines.rst

doc/source/gserver/index.rst

@@ -0,0 +1,12 @@
+GServer
+=======
+
+.. toctree::
+  :maxdepth: 2
+
+  activations.rst
+  dataproviders.rst
+  evaluators.rst
+  gradientmachines.rst
+  layers.rst
+  neworks.rst

doc/source/gserver/layers.rst

@@ -1,6 +1,10 @@
-Base
+======
+Layers
 ======
 
+Base
+====
+
 Layer 
 -----
 ..  doxygenclass:: paddle::Layer
@@ -17,7 +21,7 @@ Operator
     :members:
     
 Data Layer
-===========
+==========
 
 ..  doxygenclass:: paddle::DataLayer
     :members:
@@ -58,6 +62,11 @@ CudnnConvLayer
 ..  doxygenclass:: paddle::CudnnConvLayer
     :members:
 
+ExpandConvBaseLayer
+-------------------
+..  doxygenclass:: paddle::ExpandConvBaseLayer
+    :members:
+
 ExpandConvLayer
 ---------------
 ..  doxygenclass:: paddle::ExpandConvLayer
@@ -86,6 +95,16 @@ CudnnPoolLayer
 ..  doxygenclass:: paddle::CudnnPoolLayer
     :members:
 
+SpatialPyramidPoolLayer
+-----------------------
+..  doxygenclass:: paddle::SpatialPyramidPoolLayer
+    :members:
+
+MaxOutLayer
+-----------
+..  doxygenclass:: paddle::MaxOutLayer
+    :members:
+
 Norm Layers
 ===========
 
@@ -402,6 +421,11 @@ TransLayer
 Sampling Layers
 ===============
 
+BilinearInterpLayer
+-------------------
+..  doxygenclass:: paddle::BilinearInterpLayer
+    :members:
+
 MultinomialSampler
 ------------------
 ..  doxygenclass:: paddle::MultinomialSampler

doc/source/gserver/layers/index.rst

@@ -1,7 +0,0 @@
-Layers Documents
-====================
-
-.. toctree::
-  :maxdepth: 3
-
-  layer.rst

doc/source/gserver/neworks.rst

@@ -0,0 +1,12 @@
+Networks
+========
+
+NeuralNetwork
+-------------
+..  doxygenclass:: paddle::NeuralNetwork
+    :members:
+
+ParallelNeuralNetwork
+---------------------
+..  doxygenclass:: paddle::ParallelNeuralNetwork
+    :members:

doc/source/index.md

@@ -1,49 +0,0 @@
-# Source Code Documents
-
-## cuda
-
-- [CUDA](cuda/cuda/index.rst)
-- [Matrix](cuda/matrix/index.rst)
-- [RNN](cuda/rnn/index.rst)
-- [Utils](cuda/utils/index.rst)
-
-## gserver
-
-- [Activations](gserver/activations/index.rst)
-- [Data Providers](gserver/dataprovider/index.rst)
-- [Evaluators](gserver/evaluators/index.rst)
-- [Gradient Machines](gserver/gradientmachines/index.rst)
-- [Layers](gserver/layers/index.rst)
-
-## math
-
-- [Matrix](math/matrix/index.rst)
-- [Utils](math/utils/index.rst)
-
-## parameter
-
-- [Parameter](parameter/parameter/index.rst)
-- [Update](parameter/update/index.rst)
-- [Optimizer](parameter/optimizer/index.rst)
-
-## pserver
-
-- [Client](pserver/client/index.rst)
-- [Network](pserver/network/index.rst)
-- [Server](pserver/server/index.rst)
-
-## trainer
-
-- [Trainer](trainer/trainer.rst)
-
-## api
-
-- [API](api/api.rst)
-
-## utils
-
-- [CustomStackTrace](utils/customStackTrace.rst)
-- [Enumeration wrapper](utils/enum.rst)
-- [Lock](utils/lock.rst)
-- [Queue](utils/queue.rst)
-- [Thread](utils/thread.rst)

doc/source/index.rst

@@ -0,0 +1,14 @@
+Source Code Documents
+=====================
+
+.. toctree::
+  :maxdepth: 1
+
+  gserver/index.rst
+  trainer.rst
+  parameter/index.rst
+  pserver/index.rst
+  api.rst
+  cuda/index.rst
+  math/index.rst
+  utils/index.rst

doc/source/math/functions.rst

@@ -0,0 +1,10 @@
+Functions
+=========
+
+MathFunctions
+-------------
+.. doxygenfile:: paddle/math/MathFunctions.h
+
+SIMDFunctions
+-------------
+.. doxygenfile:: paddle/math/SIMDFunctions.h