modify directory structure in source code

PaddlePaddle · Nov 18, 2016 · 66fba67 · 66fba67
1 parent d0a908d
commit 66fba67
Show file tree

Hide file tree

Showing 57 changed files with 484 additions and 473 deletions.
diff --git a/doc/source/api/api.rst → doc/source/api.rst b/doc/source/api/api.rst → doc/source/api.rst
@@ -1,5 +1,5 @@
-API
-========
+Api
+===
 
 .. doxygenfile:: paddle/api/PaddleAPI.h
 .. doxygenfile:: paddle/api/Internal.h
diff --git a/doc/source/cuda/cuda/cuda.rst → doc/source/cuda/cuda.rst b/doc/source/cuda/cuda/cuda.rst → doc/source/cuda/cuda.rst
@@ -1,39 +1,35 @@
 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
-
-
-
-
diff --git a/doc/source/cuda/cuda/index.rst b/doc/source/cuda/cuda/index.rst
diff --git a/doc/source/cuda/index.rst b/doc/source/cuda/index.rst
@@ -0,0 +1,10 @@
+Cuda
+====
+
+.. toctree::
+  :maxdepth: 2
+
+  cuda.rst
+  matrix.rst
+  nn.rst
+  utils.rst
diff --git a/doc/source/cuda/matrix/matrix.rst → doc/source/cuda/matrix.rst b/doc/source/cuda/matrix/matrix.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
-``````````````````
-.. doxygenfile:: paddle/cuda/include/hl_top_k.h
+Sparse Matrix
+-------------
 
+hl_sparse.h
+```````````
+.. doxygenfile:: paddle/cuda/include/hl_sparse.h
 
+hl_sparse.ph
+````````````
+.. doxygenfile:: paddle/cuda/include/hl_sparse.ph
diff --git a/doc/source/cuda/matrix/index.rst b/doc/source/cuda/matrix/index.rst
diff --git a/doc/source/cuda/rnn/rnn.rst → doc/source/cuda/nn.rst b/doc/source/cuda/rnn/rnn.rst → doc/source/cuda/nn.rst
@@ -1,36 +1,37 @@
-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
+
 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
-
-
diff --git a/doc/source/cuda/rnn/index.rst b/doc/source/cuda/rnn/index.rst
diff --git a/doc/source/cuda/utils/utils.rst → doc/source/cuda/utils.rst b/doc/source/cuda/utils/utils.rst → doc/source/cuda/utils.rst
@@ -1,23 +1,18 @@
-Utilities
-===========
+Utils
+=====
 
 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
+
+Device Function
+---------------
+.. doxygenfile:: paddle/cuda/include/hl_device_functions.cuh
diff --git a/doc/source/cuda/utils/index.rst b/doc/source/cuda/utils/index.rst
diff --git a/doc/source/gserver/activations/index.rst → doc/source/gserver/activations.rst b/doc/source/gserver/activations/index.rst → doc/source/gserver/activations.rst
@@ -1,5 +1,5 @@
 Activations
-=============
+===========
 
 ..  doxygenclass:: paddle::ActivationFunction
     :members:
diff --git a/doc/source/gserver/dataprovider/index.rst b/doc/source/gserver/dataprovider/index.rst
diff --git a/...ce/gserver/dataprovider/dataproviders.rst → doc/source/gserver/dataproviders.rst b/...ce/gserver/dataprovider/dataproviders.rst → doc/source/gserver/dataproviders.rst
@@ -1,23 +1,27 @@
+==============
 Data Providers
-================
+==============
+
+Data Providers
+==============
 
 Base DataProvider
-------------------
+-----------------
 ..  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:
 
@@ -78,6 +82,6 @@ ProtoDataProvider
     :members:
 
 ProtoSequenceDataProvider
-----------------
+-------------------------
 ..  doxygenclass:: paddle::ProtoSequenceDataProvider
     :members:
diff --git a/doc/source/gserver/evaluators/evaluators.rst → doc/source/gserver/evaluators.rst b/doc/source/gserver/evaluators/evaluators.rst → doc/source/gserver/evaluators.rst
@@ -1,14 +1,15 @@
-Base Evaluator
-==============
+==========
+Evaluators
+==========
+
+Base
+====
 
-Evaluator
----------
 ..  doxygenclass:: paddle::Evaluator
     :members:
 
-
-Utils
-=====
+Sum
+===
 
 SumEvaluator
 ------------

diff --git a/doc/source/gserver/evaluators/index.rst b/doc/source/gserver/evaluators/index.rst
diff --git a/doc/source/gserver/gradientmachines.rst b/doc/source/gserver/gradientmachines.rst
@@ -0,0 +1,27 @@
+Gradient Machines
+=================
+
+Gradient Machine
+----------------
+..  doxygenclass:: paddle::GradientMachine
+    :members:
+
+Gradient Machine Mode
+---------------------
+..  doxygenclass:: paddle::IGradientMachineMode
+    :members:
+
+Multi Gradient Machine
+----------------------
+..  doxygenclass:: paddle::MultiGradientMachine
+    :members:
+
+TrainerThread
+`````````````
+..  doxygenclass:: paddle::TrainerThread
+    :members:
+
+Recurrent Gradient Machine
+--------------------------
+..  doxygenclass:: paddle::RecurrentGradientMachine
+    :members: