diff --git a/doc/source/api/api.rst b/doc/source/api.rst similarity index 86% rename from doc/source/api/api.rst rename to doc/source/api.rst index 6fc450202d..22fb5fb644 100644 --- a/doc/source/api/api.rst +++ b/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 b/doc/source/cuda/cuda.rst similarity index 69% rename from doc/source/cuda/cuda/cuda.rst rename to doc/source/cuda/cuda.rst index 52f17c2b2e..77b6e4a4d2 100644 --- a/doc/source/cuda/cuda/cuda.rst +++ b/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 deleted file mode 100644 index 5fa38ff0fc..0000000000 --- a/doc/source/cuda/cuda/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -CUDA -==================== - -.. toctree:: - :maxdepth: 3 - - cuda.rst diff --git a/doc/source/cuda/index.rst b/doc/source/cuda/index.rst new file mode 100644 index 0000000000..d453f658a7 --- /dev/null +++ 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 b/doc/source/cuda/matrix.rst similarity index 76% rename from doc/source/cuda/matrix/matrix.rst rename to doc/source/cuda/matrix.rst index dd4f06599c..b7699c83ed 100644 --- a/doc/source/cuda/matrix/matrix.rst +++ b/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 deleted file mode 100644 index 63f95eb466..0000000000 --- a/doc/source/cuda/matrix/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Matrix -==================== - -.. toctree:: - :maxdepth: 3 - - matrix.rst diff --git a/doc/source/cuda/rnn/rnn.rst b/doc/source/cuda/nn.rst similarity index 80% rename from doc/source/cuda/rnn/rnn.rst rename to doc/source/cuda/nn.rst index ce8ed96692..5ebd863242 100644 --- a/doc/source/cuda/rnn/rnn.rst +++ b/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 deleted file mode 100644 index 4913e47ba1..0000000000 --- a/doc/source/cuda/rnn/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -RNN -==================== - -.. toctree:: - :maxdepth: 3 - - rnn.rst diff --git a/doc/source/cuda/utils/utils.rst b/doc/source/cuda/utils.rst similarity index 56% rename from doc/source/cuda/utils/utils.rst rename to doc/source/cuda/utils.rst index 1ea3e5404a..c5d4a45a44 100644 --- a/doc/source/cuda/utils/utils.rst +++ b/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 deleted file mode 100644 index 7a84cbe27d..0000000000 --- a/doc/source/cuda/utils/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Utils -==================== - -.. toctree:: - :maxdepth: 3 - - utils.rst diff --git a/doc/source/gserver/activations/index.rst b/doc/source/gserver/activations.rst similarity index 83% rename from doc/source/gserver/activations/index.rst rename to doc/source/gserver/activations.rst index ccdae41128..55b9d3be38 100644 --- a/doc/source/gserver/activations/index.rst +++ b/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 deleted file mode 100644 index 4f6077f122..0000000000 --- a/doc/source/gserver/dataprovider/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Data Providers Documents -========================== - -.. toctree:: - :maxdepth: 3 - - dataproviders.rst diff --git a/doc/source/gserver/dataprovider/dataproviders.rst b/doc/source/gserver/dataproviders.rst similarity index 89% rename from doc/source/gserver/dataprovider/dataproviders.rst rename to doc/source/gserver/dataproviders.rst index e8aa4bc356..73e45f1f33 100644 --- a/doc/source/gserver/dataprovider/dataproviders.rst +++ b/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 b/doc/source/gserver/evaluators.rst similarity index 96% rename from doc/source/gserver/evaluators/evaluators.rst rename to doc/source/gserver/evaluators.rst index 0c5cc85e7d..f5361f76cd 100644 --- a/doc/source/gserver/evaluators/evaluators.rst +++ b/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 deleted file mode 100644 index 298de3e1a3..0000000000 --- a/doc/source/gserver/evaluators/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Evaluators -========== - -.. toctree:: - :maxdepth: 3 - - evaluators.rst diff --git a/doc/source/gserver/gradientmachines.rst b/doc/source/gserver/gradientmachines.rst new file mode 100644 index 0000000000..d67c8dbcbd --- /dev/null +++ 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: diff --git a/doc/source/gserver/gradientmachines/gradientmachines.rst b/doc/source/gserver/gradientmachines/gradientmachines.rst deleted file mode 100644 index 3607664c85..0000000000 --- a/doc/source/gserver/gradientmachines/gradientmachines.rst +++ /dev/null @@ -1,40 +0,0 @@ -Gradient Machines -================ - -GradientMachine ---------------------- -.. doxygenclass:: paddle::GradientMachine - :members: - -GradientMachineModel --------------------- -.. doxygenclass:: paddle::IGradientMachineMode - :members: - -MultiGradientMachine ---------------------- -.. doxygenclass:: paddle::MultiGradientMachine - :members: - -TrainerThread -````````````` -.. doxygenclass:: paddle::TrainerThread - :members: - -Recurrent Gradient Machines ---------------------------- -.. doxygenclass:: paddle::RecurrentGradientMachine - :members: - -Networks -======== - -NeuralNetwork -------------- -.. doxygenclass:: paddle::NeuralNetwork - :members: - -ParallelNeuralNetwork ---------------------- -.. doxygenclass:: paddle::ParallelNeuralNetwork - :members: diff --git a/doc/source/gserver/gradientmachines/index.rst b/doc/source/gserver/gradientmachines/index.rst deleted file mode 100644 index 997c29a102..0000000000 --- a/doc/source/gserver/gradientmachines/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Gradient Machines Documents -============================= - -.. toctree:: - :maxdepth: 3 - - gradientmachines.rst diff --git a/doc/source/gserver/index.rst b/doc/source/gserver/index.rst new file mode 100644 index 0000000000..b0b41e3ad1 --- /dev/null +++ b/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 diff --git a/doc/source/gserver/layers/layer.rst b/doc/source/gserver/layers.rst similarity index 95% rename from doc/source/gserver/layers/layer.rst rename to doc/source/gserver/layers.rst index 4b8e149505..191b2bdff2 100644 --- a/doc/source/gserver/layers/layer.rst +++ b/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 diff --git a/doc/source/gserver/layers/index.rst b/doc/source/gserver/layers/index.rst deleted file mode 100644 index 559c5436b1..0000000000 --- a/doc/source/gserver/layers/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Layers Documents -==================== - -.. toctree:: - :maxdepth: 3 - - layer.rst diff --git a/doc/source/gserver/neworks.rst b/doc/source/gserver/neworks.rst new file mode 100644 index 0000000000..73fb60d549 --- /dev/null +++ b/doc/source/gserver/neworks.rst @@ -0,0 +1,12 @@ +Networks +======== + +NeuralNetwork +------------- +.. doxygenclass:: paddle::NeuralNetwork + :members: + +ParallelNeuralNetwork +--------------------- +.. doxygenclass:: paddle::ParallelNeuralNetwork + :members: diff --git a/doc/source/index.md b/doc/source/index.md deleted file mode 100644 index 55fcdeb3df..0000000000 --- a/doc/source/index.md +++ /dev/null @@ -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) diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000000..7aebcadd75 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,14 @@ +Source Code Documents +===================== + +.. toctree:: + :maxdepth: 1 + + gserver/index.rst + trainer.rst + parameter/index.rst + pserver.rst + api.rst + cuda/index.rst + math/index.rst + utils/index.rst diff --git a/doc/source/math/functions.rst b/doc/source/math/functions.rst new file mode 100644 index 0000000000..aef12e0f00 --- /dev/null +++ b/doc/source/math/functions.rst @@ -0,0 +1,10 @@ +Functions +========= + +MathFunctions +------------- +.. doxygenfile:: paddle/math/MathFunctions.h + +SIMDFunctions +------------- +.. doxygenfile:: paddle/math/SIMDFunctions.h diff --git a/doc/source/math/index.rst b/doc/source/math/index.rst new file mode 100644 index 0000000000..2ec16f2b44 --- /dev/null +++ b/doc/source/math/index.rst @@ -0,0 +1,10 @@ +Math +==== + +.. toctree:: + :maxdepth: 2 + + vector.rst + matrix.rst + functions.rst + utils.rst diff --git a/doc/source/math/matrix.rst b/doc/source/math/matrix.rst new file mode 100644 index 0000000000..9bb20f618d --- /dev/null +++ b/doc/source/math/matrix.rst @@ -0,0 +1,76 @@ +Matrix +====== + +Base +---- + +BaseMatrix Template +``````````````````` +.. doxygenclass:: paddle::BaseMatrixT + :members: + +Matrix +`````` +.. doxygenclass:: paddle::Matrix + :members: + +MatrixOffset +```````````` +.. doxygenclass:: paddle::MatrixOffset + :members: + +CpuMatrix +--------- + +CpuMatrix +````````` +.. doxygenclass:: paddle::CpuMatrix + :members: + +SharedCpuMatrix +``````````````` +.. doxygenclass:: paddle::SharedCpuMatrix + :members: + +GpuMatrix +--------- +.. doxygenclass:: paddle::GpuMatrix + :members: + +CpuSparseMatrix +--------------- + +CpuSparseMatrix +``````````````` +.. doxygenclass:: paddle::CpuSparseMatrix + :members: + +SparseRowCpuMatrix +`````````````````` +.. doxygenclass:: paddle::SparseRowCpuMatrix + :members: + +SparseAutoGrowRowCpuMatrix +`````````````````````````` +.. doxygenclass:: paddle::SparseAutoGrowRowCpuMatrix + :members: + +SparsePrefetchRowCpuMatrix +`````````````````````````` +.. doxygenclass:: paddle::SparsePrefetchRowCpuMatrix + :members: + +SparseRowIdsCpuMatrix +````````````````````` +.. doxygenclass:: paddle::SparseRowIdsCpuMatrix + :members: + +CacheRowCpuMatrix +````````````````` +.. doxygenclass:: paddle::CacheRowCpuMatrix + :members: + +GpuSparseMatrix +--------------- +.. doxygenclass:: paddle::GpuSparseMatrix + :members: diff --git a/doc/source/math/matrix/index.rst b/doc/source/math/matrix/index.rst deleted file mode 100644 index 68410f2a27..0000000000 --- a/doc/source/math/matrix/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Matrix Documents -==================== - -.. toctree:: - :maxdepth: 3 - - matrix.rst diff --git a/doc/source/math/matrix/matrix.rst b/doc/source/math/matrix/matrix.rst deleted file mode 100644 index b12e3934f4..0000000000 --- a/doc/source/math/matrix/matrix.rst +++ /dev/null @@ -1,20 +0,0 @@ -Matrix -======= - -Base --------- -.. doxygenfile:: paddle/math/BaseMatrix.h - -Sparse Matrix ----------------- -.. doxygenfile:: paddle/math/Matrix.h -.. doxygenfile:: paddle/math/Vector.h -.. doxygenfile:: paddle/math/MathUtils.h -.. doxygenfile:: paddle/math/SparseMatrix.h -.. doxygenfile:: paddle/math/SparseRowMatrix.h -.. doxygenfile:: paddle/math/CpuSparseMatrix.h - -Others ----------- -.. doxygenfile:: paddle/math/MathFunctions.h -.. doxygenfile:: paddle/math/SIMDFunctions.h diff --git a/doc/source/math/utils/utils.rst b/doc/source/math/utils.rst similarity index 62% rename from doc/source/math/utils/utils.rst rename to doc/source/math/utils.rst index 3df721a47b..55d9961a39 100644 --- a/doc/source/math/utils/utils.rst +++ b/doc/source/math/utils.rst @@ -1,9 +1,18 @@ -Utils -======= +Memory Manager +============== Memory Handle --------------- +------------- .. doxygenfile:: paddle/math/MemoryHandle.h + +Allocator +--------- .. doxygenfile:: paddle/math/Allocator.h + +PoolAllocator +````````````` .. doxygenfile:: paddle/math/PoolAllocator.h + +Storage +------- .. doxygenfile:: paddle/math/Storage.h diff --git a/doc/source/math/utils/index.rst b/doc/source/math/utils/index.rst deleted file mode 100644 index e5fe335da2..0000000000 --- a/doc/source/math/utils/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Utils Documents -==================== - -.. toctree:: - :maxdepth: 3 - - utils.rst diff --git a/doc/source/math/vector.rst b/doc/source/math/vector.rst new file mode 100644 index 0000000000..579ed7ba55 --- /dev/null +++ b/doc/source/math/vector.rst @@ -0,0 +1,37 @@ +Vector +====== + +BaseVector +`````````` +.. doxygenclass:: paddle::BaseVector + :members: + +Vector Template +``````````````` +.. doxygenclass:: paddle::VectorT + :members: + +CpuVector Template +`````````````````` +.. doxygenclass:: paddle::CpuVectorT + :members: + +GpuVector Template +`````````````````` +.. doxygenclass:: paddle::GpuVectorT + :members: + +Parallel CpuVector Template +``````````````````````````` +.. doxygenclass:: paddle::ParallelCpuVectorT + :members: + +Parallel GpuVector Template +``````````````````````````` +.. doxygenclass:: paddle::ParallelGpuVectorT + :members: + +CpuGpuVector Template +````````````````````` +.. doxygenclass:: paddle::CpuGpuVectorT + :members: diff --git a/doc/source/parameter/index.rst b/doc/source/parameter/index.rst new file mode 100644 index 0000000000..3bf6948dc3 --- /dev/null +++ b/doc/source/parameter/index.rst @@ -0,0 +1,9 @@ +Parameter +========= + +.. toctree:: + :maxdepth: 2 + + parameter.rst + optimizer.rst + updater.rst diff --git a/doc/source/parameter/optimizer.rst b/doc/source/parameter/optimizer.rst new file mode 100644 index 0000000000..b5b8b850b3 --- /dev/null +++ b/doc/source/parameter/optimizer.rst @@ -0,0 +1,22 @@ +Optimizer +========= + +ParameterOptimizer +------------------ +.. doxygenfile:: paddle/parameter/ParameterOptimizer.h + +Regularizer +----------- +.. doxygenfile:: paddle/parameter/Regularizer.h + +FirstOrderOptimizer +------------------- +.. doxygenfile:: paddle/parameter/FirstOrderOptimizer.h + +AverageOptimizer +---------------- +.. doxygenfile:: paddle/parameter/AverageOptimizer.h + +OptimizerWithRegularizer +------------------------ +.. doxygenfile:: paddle/parameter/OptimizerWithRegularizer.h diff --git a/doc/source/parameter/optimizer/index.rst b/doc/source/parameter/optimizer/index.rst deleted file mode 100644 index 3338af5608..0000000000 --- a/doc/source/parameter/optimizer/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Parameter Documents -==================== - -.. toctree:: - :maxdepth: 3 - - optimizer.rst diff --git a/doc/source/parameter/optimizer/optimizer.rst b/doc/source/parameter/optimizer/optimizer.rst deleted file mode 100644 index 3d9e49217e..0000000000 --- a/doc/source/parameter/optimizer/optimizer.rst +++ /dev/null @@ -1,7 +0,0 @@ -Optimizer -============ - -.. doxygenfile:: paddle/parameter/FirstOrderOptimizer.h -.. doxygenfile:: paddle/parameter/AverageOptimizer.h -.. doxygenfile:: paddle/parameter/ParameterOptimizer.h -.. doxygenfile:: paddle/parameter/OptimizerWithRegularizer.h diff --git a/doc/source/parameter/parameter/parameter.rst b/doc/source/parameter/parameter.rst similarity index 66% rename from doc/source/parameter/parameter/parameter.rst rename to doc/source/parameter/parameter.rst index 2b7afdb409..2daa62d4e6 100644 --- a/doc/source/parameter/parameter/parameter.rst +++ b/doc/source/parameter/parameter.rst @@ -1,16 +1,12 @@ Parameter -============= - -Weight --------- -.. doxygenfile:: paddle/parameter/Weight.h - -Regularizer ------------- -.. doxygenfile:: paddle/parameter/Regularizer.h +========= Parameter -------------- +--------- .. doxygenfile:: paddle/parameter/Argument.h .. doxygenfile:: paddle/parameter/Parameter.h .. doxygenfile:: paddle/parameter/ParallelParameter.h + +Weight +------ +.. doxygenfile:: paddle/parameter/Weight.h diff --git a/doc/source/parameter/parameter/index.rst b/doc/source/parameter/parameter/index.rst deleted file mode 100644 index e7ed70ec4c..0000000000 --- a/doc/source/parameter/parameter/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Parameter Documents -==================== - -.. toctree:: - :maxdepth: 3 - - parameter.rst diff --git a/doc/source/parameter/update/index.rst b/doc/source/parameter/update/index.rst deleted file mode 100644 index 1bbd733193..0000000000 --- a/doc/source/parameter/update/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Parameter Documents -==================== - -.. toctree:: - :maxdepth: 3 - - update.rst diff --git a/doc/source/parameter/update/update.rst b/doc/source/parameter/updater.rst similarity index 75% rename from doc/source/parameter/update/update.rst rename to doc/source/parameter/updater.rst index c417602f03..dfa22e8e7d 100644 --- a/doc/source/parameter/update/update.rst +++ b/doc/source/parameter/updater.rst @@ -1,7 +1,14 @@ -Update -========== +Updater +======= +Base +---- .. doxygenfile:: paddle/parameter/ParameterUpdaterBase.h + +Hook +---- .. doxygenfile:: paddle/parameter/ParameterUpdaterHook.h -.. doxygenfile:: paddle/parameter/ParameterUpdateFunctions.h +Functions +--------- +.. doxygenfile:: paddle/parameter/ParameterUpdateFunctions.h diff --git a/doc/source/pserver/client.rst b/doc/source/pserver/client.rst new file mode 100644 index 0000000000..e5bba0706a --- /dev/null +++ b/doc/source/pserver/client.rst @@ -0,0 +1,12 @@ +Client +====== + +BaseClient +---------- +.. doxygenclass:: paddle::BaseClient + :members: + +ParameterClient2 +---------------- +.. doxygenclass:: paddle::ParameterClient2 + :members: diff --git a/doc/source/pserver/client/client.rst b/doc/source/pserver/client/client.rst deleted file mode 100644 index fc7ed90d3d..0000000000 --- a/doc/source/pserver/client/client.rst +++ /dev/null @@ -1,14 +0,0 @@ -Client -========= - -.. doxygenclass:: paddle::BaseClient - :members: - :protected-members: - :private-members: - :undoc-members: - -.. doxygenclass:: paddle::ParameterClient2 - :members: - :protected-members: - :private-members: - :undoc-members: diff --git a/doc/source/pserver/client/index.rst b/doc/source/pserver/client/index.rst deleted file mode 100644 index dc924c9ca8..0000000000 --- a/doc/source/pserver/client/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Client Documents -==================== - -.. toctree:: - :maxdepth: 3 - - client.rst diff --git a/doc/source/pserver/index.rst b/doc/source/pserver/index.rst new file mode 100644 index 0000000000..1cb3af32f8 --- /dev/null +++ b/doc/source/pserver/index.rst @@ -0,0 +1,10 @@ +Pserver +======= + +.. toctree:: + :maxdepth: 2 + + client.rst + network.rst + server.rst + utils.rst diff --git a/doc/source/pserver/network.rst b/doc/source/pserver/network.rst new file mode 100644 index 0000000000..cf6418bc1a --- /dev/null +++ b/doc/source/pserver/network.rst @@ -0,0 +1,27 @@ +Network +======= + +Socket Server +------------- +.. doxygenclass:: paddle::SocketServer + :members: + +Socket Worker +------------- +.. doxygenclass:: paddle::SocketWorker + :members: + +Socket Client +------------- +.. doxygenclass:: paddle::SocketClient + :members: + +Socket Channel +-------------- +.. doxygenclass:: paddle::SocketChannel + :members: + +Message Reader +-------------- +.. doxygenclass:: paddle::MsgReader + :members: diff --git a/doc/source/pserver/network/index.rst b/doc/source/pserver/network/index.rst deleted file mode 100644 index 2fdf95e17d..0000000000 --- a/doc/source/pserver/network/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Network Documents -==================== - -.. toctree:: - :maxdepth: 3 - - network.rst diff --git a/doc/source/pserver/network/network.rst b/doc/source/pserver/network/network.rst deleted file mode 100644 index e000ff8dbb..0000000000 --- a/doc/source/pserver/network/network.rst +++ /dev/null @@ -1,42 +0,0 @@ -Network -========== - -Socket Server ----------------- -.. doxygenclass:: paddle::SocketServer - :members: - :protected-members: - :private-members: - :undoc-members: - -Socket Worker ----------------- -.. doxygenclass:: paddle::SocketWorker - :members: - :protected-members: - :private-members: - :undoc-members: - -Socket Client ----------------- -.. doxygenclass:: paddle::SocketClient - :members: - :protected-members: - :private-members: - :undoc-members: - -Socket Channel ---------------- -.. doxygenclass:: paddle::SocketChannel - :members: - :protected-members: - :private-members: - :undoc-members: - -Message Reader ---------------- -.. doxygenclass:: paddle::MsgReader - :members: - :protected-members: - :private-members: - :undoc-members: diff --git a/doc/source/pserver/server.rst b/doc/source/pserver/server.rst new file mode 100644 index 0000000000..35301acf8f --- /dev/null +++ b/doc/source/pserver/server.rst @@ -0,0 +1,12 @@ +Server +====== + +ProtoServer +----------- +.. doxygenclass:: paddle::ProtoServer + :members: + +ParameterServer2 +---------------- +.. doxygenclass:: paddle::ParameterServer2 + :members: diff --git a/doc/source/pserver/server/index.rst b/doc/source/pserver/server/index.rst deleted file mode 100644 index 09e3530bfe..0000000000 --- a/doc/source/pserver/server/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Server Documents -==================== - -.. toctree:: - :maxdepth: 3 - - server.rst diff --git a/doc/source/pserver/server/server.rst b/doc/source/pserver/server/server.rst deleted file mode 100644 index f3110fdd73..0000000000 --- a/doc/source/pserver/server/server.rst +++ /dev/null @@ -1,14 +0,0 @@ -Server -========== - -.. doxygenclass:: paddle::ProtoServer - :members: - :protected-members: - :private-members: - :undoc-members: - -.. doxygenclass:: paddle::ParameterServer2 - :members: - :protected-members: - :private-members: - :undoc-members: diff --git a/doc/source/trainer/trainer.rst b/doc/source/trainer.rst similarity index 94% rename from doc/source/trainer/trainer.rst rename to doc/source/trainer.rst index 12c24597e7..85f1feb4fc 100644 --- a/doc/source/trainer/trainer.rst +++ b/doc/source/trainer.rst @@ -14,7 +14,7 @@ RemoteParameterUpdater :members: ConcurrentRemoteParameterUpdater ---------------------------------- +-------------------------------- .. doxygenclass:: paddle::ConcurrentRemoteParameterUpdater :members: diff --git a/doc/source/utils/customStackTrace.rst b/doc/source/utils/customStackTrace.rst index a4e6f05a40..cdc8930739 100644 --- a/doc/source/utils/customStackTrace.rst +++ b/doc/source/utils/customStackTrace.rst @@ -1,9 +1,4 @@ CustomStackTrace ================ - - -class CustomStackTrace ----------------------- - .. doxygenclass:: paddle::CustomStackTrace :members: diff --git a/doc/source/utils/enum.rst b/doc/source/utils/enum.rst index 17166d35f7..e0da75afe1 100644 --- a/doc/source/utils/enum.rst +++ b/doc/source/utils/enum.rst @@ -1,9 +1,3 @@ -enumeration_wrapper +Enumeration wrapper =================== - - -namespace paddle::enumeration_wrapper -------------------------------------- - .. doxygennamespace:: paddle::enumeration_wrapper - diff --git a/doc/source/utils/index.rst b/doc/source/utils/index.rst new file mode 100644 index 0000000000..7ddc47d172 --- /dev/null +++ b/doc/source/utils/index.rst @@ -0,0 +1,11 @@ +Utils +===== + +.. toctree:: + :maxdepth: 2 + + lock.rst + queue.rst + thread.rst + customStackTrace.rst + enum.rst diff --git a/doc/source/utils/lock.rst b/doc/source/utils/lock.rst index 0b027e403f..1dd3f4c051 100644 --- a/doc/source/utils/lock.rst +++ b/doc/source/utils/lock.rst @@ -1,37 +1,32 @@ -Thread -====== +Lock +==== - -class Thread +class RWLock ------------ - -.. doxygenclass:: paddle::Thread +.. doxygenclass:: paddle::RWLock :members: - -class ThreadWorker ------------------- - -.. doxygenclass:: paddle::ThreadWorker +class ReadLockGuard +------------------- +.. doxygenclass:: paddle::ReadLockGuard :members: - -class SyncThreadPool --------------------- - -.. doxygenclass:: paddle::SyncThreadPool +class SpinLock +-------------- +.. doxygenclass:: paddle::SpinLock :members: - -class MultiThreadWorker ------------------------ +class Semaphore +--------------- +.. doxygenclass:: paddle::Semaphore + :members: -.. doxygenclass:: paddle::MultiThreadWorker +class ThreadBarrier +------------------- +.. doxygenclass:: paddle::ThreadBarrier :members: - -class AsyncThreadPool +class LockedCondition --------------------- - -.. doxygenclass:: paddle::AsyncThreadPool +.. doxygenclass:: paddle::LockedCondition :members: diff --git a/doc/source/utils/queue.rst b/doc/source/utils/queue.rst index 72a464ca67..5829028ebd 100644 --- a/doc/source/utils/queue.rst +++ b/doc/source/utils/queue.rst @@ -1,16 +1,12 @@ Queue ===== - class Queue ------------ - .. doxygenclass:: paddle::Queue :members: - class BlockingQueue ------------------- - .. doxygenclass:: paddle::BlockingQueue :members: diff --git a/doc/source/utils/thread.rst b/doc/source/utils/thread.rst index 2eb67dde6a..09f826fa1d 100644 --- a/doc/source/utils/thread.rst +++ b/doc/source/utils/thread.rst @@ -1,40 +1,27 @@ -Lock -==== +Thread +====== - -class RWLock +class Thread ------------ - -.. doxygenclass:: paddle::RWLock +.. doxygenclass:: paddle::Thread :members: -class ReadLockGuard -------------------- - -.. doxygenclass:: paddle::ReadLockGuard +class ThreadWorker +------------------ +.. doxygenclass:: paddle::ThreadWorker :members: -class SpinLock --------------- - -.. doxygenclass:: paddle::SpinLock +class SyncThreadPool +-------------------- +.. doxygenclass:: paddle::SyncThreadPool :members: - -class Semaphore ---------------- - -.. doxygenclass:: paddle::Semaphore + +class MultiThreadWorker +----------------------- +.. doxygenclass:: paddle::MultiThreadWorker :members: -class ThreadBarrier -------------------- - -.. doxygenclass:: paddle::ThreadBarrier - :members: - -class LockedCondition +class AsyncThreadPool --------------------- - -.. doxygenclass:: paddle::LockedCondition +.. doxygenclass:: paddle::AsyncThreadPool :members: -