diff --git a/README.md b/README.md index 81ff8c7122ab8f1e39ef14a056532bb85cc57c77..e8679fb55fc22559d933a416e8706b7baf536ead 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ developed by Baidu scientists and engineers for the purpose of applying deep learning to many products at Baidu. Our vision is to enable deep learning for everyone via PaddlePaddle. -Please refer to our [release announcement](https://github.com/baidu/Paddle/releases) to track the latest feature of PaddlePaddle. +Please refer to our [release announcement](https://github.com/baidu/Paddle/releases) to track the latest feature of PaddlePaddle. ## Features @@ -26,15 +26,15 @@ Please refer to our [release announcement](https://github.com/baidu/Paddle/relea connection. - **Efficiency** - + In order to unleash the power of heterogeneous computing resource, optimization occurs at different levels of PaddlePaddle, including computing, memory, architecture and communication. The following are some examples: - Optimized math operations through SSE/AVX intrinsics, BLAS libraries - (e.g. MKL, ATLAS, cuBLAS) or customized CPU/GPU kernels. - - Highly optimized recurrent networks which can handle **variable-length** + (e.g. MKL, ATLAS, cuBLAS) or customized CPU/GPU kernels. + - Highly optimized recurrent networks which can handle **variable-length** sequence without padding. - Optimized local and distributed training for models with high dimensional sparse data. @@ -57,41 +57,39 @@ Please refer to our [release announcement](https://github.com/baidu/Paddle/relea ## Installation Check out the [Install Guide](http://paddlepaddle.org/doc/build/) to install from -pre-built packages (**docker image**, **deb package**) or +pre-built packages (**docker image**, **deb package**) or directly build on **Linux** and **Mac OS X** from the source code. - + ## Documentation Both [English Docs](http://paddlepaddle.org/doc/) and [Chinese Docs](http://paddlepaddle.org/doc_cn/) are provided for our users and developers. - [Quick Start](http://paddlepaddle.org/doc/demo/quick_start/index_en)
You can follow the quick start tutorial to learn how use PaddlePaddle step-by-step. - + - [Example and Demo](http://paddlepaddle.org/doc/demo/)
We provide five demos, including: image classification, sentiment analysis, - sequence to sequence model, recommendation, semantic role labeling. - + sequence to sequence model, recommendation, semantic role labeling. + - [Distributed Training](http://paddlepaddle.org/doc/cluster)
This system supports training deep learning models on multiple machines with data parallelism. - + - [Python API](http://paddlepaddle.org/doc/ui/)
PaddlePaddle supports using either Python interface or C++ to build your system. We also use SWIG to wrap C++ source code to create a user friendly interface for Python. You can also use SWIG to create interface for your favorite programming language. - + - [How to Contribute](http://paddlepaddle.org/doc/build/contribute_to_paddle.html)
We sincerely appreciate your interest and contributions. If you would like to - contribute, please read the contribution guide. + contribute, please read the contribution guide. - [Source Code Documents](http://paddlepaddle.org/doc/source/)
## Ask Questions -Please join the [**gitter chat**](https://gitter.im/PaddlePaddle/Deep_Learning) or send email to -**paddle-dev@baidu.com** to ask questions and talk about methods and models. -Framework development discussions and -bug reports are collected on [Issues](https://github.com/baidu/paddle/issues). + +You are welcome to submit questions and bug reports as [Github Issues](https://github.com/baidu/paddle/issues). ## Copyright and License PaddlePaddle is provided under the [Apache-2.0 license](LICENSE). diff --git a/doc/source/api/api.rst b/doc/source/api.rst similarity index 90% rename from doc/source/api/api.rst rename to doc/source/api.rst index 6fc450202df73f5ca99c2c52f257243aa37c90d4..30396c26b61827847cc5acc29cee1c3c8e7b226e 100644 --- a/doc/source/api/api.rst +++ b/doc/source/api.rst @@ -1,5 +1,5 @@ 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/cuda.rst deleted file mode 100644 index 52f17c2b2e48aec8e6fc8d5a7e4f443ad72d96a6..0000000000000000000000000000000000000000 --- a/doc/source/cuda/cuda/cuda.rst +++ /dev/null @@ -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 - - - - diff --git a/doc/source/cuda/cuda/index.rst b/doc/source/cuda/cuda/index.rst deleted file mode 100644 index 5fa38ff0fc8cea2b97262ea5493dea27b322dc1c..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..b0fed2e7f72c9a9671e56e114edfc88d72504dbe --- /dev/null +++ b/doc/source/cuda/index.rst @@ -0,0 +1,9 @@ +CUDA +==== + +.. toctree:: + :maxdepth: 2 + + 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 dd4f06599c5af29a0278617ffd1bd9f6ae6b222e..b7699c83eda15d9003506f5fc57b51d52e7af823 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 63f95eb46618fd43a1140e4d857ae7e2fc89a6ae..0000000000000000000000000000000000000000 --- 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 79% rename from doc/source/cuda/rnn/rnn.rst rename to doc/source/cuda/nn.rst index ce8ed96692bcb79eec0e5e6ae52a8bf5f6573418..5577d01e72a5b22847bda40528c46a28cacc1490 100644 --- a/doc/source/cuda/rnn/rnn.rst +++ b/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 - - diff --git a/doc/source/cuda/rnn/index.rst b/doc/source/cuda/rnn/index.rst deleted file mode 100644 index 4913e47ba1cbc1c2b93fe3e128626a8e66aedc62..0000000000000000000000000000000000000000 --- 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.rst b/doc/source/cuda/utils.rst new file mode 100644 index 0000000000000000000000000000000000000000..850e8bd1c6670947e2a5f1b6f9b0d5b252117cbf --- /dev/null +++ b/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 diff --git a/doc/source/cuda/utils/index.rst b/doc/source/cuda/utils/index.rst deleted file mode 100644 index 7a84cbe27dd21e326add1a0a1774cbaa089e195f..0000000000000000000000000000000000000000 --- a/doc/source/cuda/utils/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Utils -==================== - -.. toctree:: - :maxdepth: 3 - - utils.rst diff --git a/doc/source/cuda/utils/utils.rst b/doc/source/cuda/utils/utils.rst deleted file mode 100644 index 1ea3e5404aa5fc792075aa09c7fd7a1986332c79..0000000000000000000000000000000000000000 --- a/doc/source/cuda/utils/utils.rst +++ /dev/null @@ -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 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 ccdae41128cd6b4edddda0ac44a825082d7495c9..55b9d3be383c07842d7066280cc0e174788db1fb 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 4f6077f1224f90f693515d3414da4d96dc652345..0000000000000000000000000000000000000000 --- 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 87% rename from doc/source/gserver/dataprovider/dataproviders.rst rename to doc/source/gserver/dataproviders.rst index e8aa4bc35634a0c6ede192a15b276564f7a2c13e..c30d9d6a36a6fbb664ae001274b6a7b0e721070f 100644 --- a/doc/source/gserver/dataprovider/dataproviders.rst +++ b/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: @@ -69,8 +73,8 @@ IPyDataProvider .. doxygenclass:: paddle::PyDataProvider2 :members: -Proto Data Provider -=================== +ProtoDataProvider +================= ProtoDataProvider ---------------- @@ -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 0c5cc85e7dff31693bdc9d2ee44ef470a0fc5f90..f5361f76cd2b1c9c004221c03ea05b2c1f3a652e 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 298de3e1a32d36b9102f5ad64cc1b968f418041b..0000000000000000000000000000000000000000 --- 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/gradientmachines.rst b/doc/source/gserver/gradientmachines.rst similarity index 54% rename from doc/source/gserver/gradientmachines/gradientmachines.rst rename to doc/source/gserver/gradientmachines.rst index 3607664c850cdf4df4e10151b05f15e275adceaf..04c8e91d0316a45ad10b0ed0513d3e8916b7c3d9 100644 --- a/doc/source/gserver/gradientmachines/gradientmachines.rst +++ b/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: diff --git a/doc/source/gserver/gradientmachines/index.rst b/doc/source/gserver/gradientmachines/index.rst deleted file mode 100644 index 997c29a102f53c165c70ff11cd9650b83bcecf44..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..223b00b9a9dbf1db40ce702cf0e154e5e53a8644 --- /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 4b8e149505f0695ad2fa4be967a50d1a0ac48b43..191b2bdff26ed17437370a12036f9dbb174dae15 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 559c5436b10a5977ac347611639b32d43f1ed123..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..73fb60d549cc88f61d2e2d18c9ec31c37cf4fa9a --- /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 55fcdeb3dfcedd8589bf7986682708a957c05746..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..36323c888ee65147f59f28160dc26ca29235ba63 --- /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/index.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 0000000000000000000000000000000000000000..aef12e0f005226c6d40d74d0e858a11585339758 --- /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 0000000000000000000000000000000000000000..2ec16f2b4450c870f9590aea4ad4ca7dc415b75d --- /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 0000000000000000000000000000000000000000..9bb20f618d229e1baea15e26378bf40d7c6e1783 --- /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 68410f2a27b68c87087f2c17de351495ac6a6cd0..0000000000000000000000000000000000000000 --- 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 b12e3934f4705d4a2b7d3d790873701ddfe27d9f..0000000000000000000000000000000000000000 --- 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 3df721a47b93bce950185f2d6ffe22d4a801af30..55d9961a390c205563a9ae4fbd87ac4ae90fc314 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 e5fe335da29b957706ed52662682d11c425e5908..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..07f7062abaf4f30b8967b594f4e16ab881f5414f --- /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: + +ParallelCpuVector Template +`````````````````````````` +.. doxygenclass:: paddle::ParallelCpuVectorT + :members: + +ParallelGpuVector 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 0000000000000000000000000000000000000000..3bf6948dc3478574d8d125d8461235f8827e4e42 --- /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 0000000000000000000000000000000000000000..b5b8b850b349d547c9e5508d3ebec3d7e00ea310 --- /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 3338af5608a03ee853e3a5f16d2483b810215514..0000000000000000000000000000000000000000 --- 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 3d9e49217eb17541c14d8d64715278e62c99d2b4..0000000000000000000000000000000000000000 --- 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 2b7afdb4093753598d73c686b1dc81b970d199d5..2daa62d4e63b952cd93bba35ee32ce35ce768a0d 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 e7ed70ec4c87b3613cd8450f1e7fca1fb974afca..0000000000000000000000000000000000000000 --- 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 1bbd73319396e7b8ea32c78e0fe3569919bacf2d..0000000000000000000000000000000000000000 --- 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 c417602f0338dbd84ae2bd2ca4eb09330202a0e8..dfa22e8e7d1d6f0713974835de93194d2cc58e6f 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 0000000000000000000000000000000000000000..e5bba0706a1d919104b85e23861ba490a2c828db --- /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 fc7ed90d3dc8beb0baa30d63ccc956fbba2a4e4c..0000000000000000000000000000000000000000 --- 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 dc924c9ca8e7b9965638fd299dc2f5e78591c91b..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..0031e9476bd063511cc2f0a8c209f35627cf44ba --- /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 0000000000000000000000000000000000000000..7004c9d91fa9f2af11e15791ef682c108761027e --- /dev/null +++ b/doc/source/pserver/network.rst @@ -0,0 +1,27 @@ +Network +======= + +SocketServer +------------ +.. doxygenclass:: paddle::SocketServer + :members: + +SocketWorker +------------ +.. doxygenclass:: paddle::SocketWorker + :members: + +SocketClient +------------ +.. doxygenclass:: paddle::SocketClient + :members: + +SocketChannel +------------- +.. doxygenclass:: paddle::SocketChannel + :members: + +MessageReader +------------- +.. 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 2fdf95e17d339d69de8e027d92cbb385e2bd51ec..0000000000000000000000000000000000000000 --- 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 e000ff8dbbdc37e9d638d18d20a8ba53e21dd245..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..35301acf8ffe3d97e6124c37cf8fe1b43071e14e --- /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 09e3530bfeaf56ebbadb1694a69a036813e8970f..0000000000000000000000000000000000000000 --- 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 f3110fdd731d246ce4211d05e32ddd98584bdbb7..0000000000000000000000000000000000000000 --- 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 12c24597e7f99cd489204602ae25a89d7b960630..85f1feb4fc941f94e65a6b1d037445d2367f65ec 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 a4e6f05a406f33256548fc0ef32bbbf3daff1536..cdc8930739eb4b4d6308ff1fbce170d2977d42e8 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 17166d35f7cfa63e51058cc5f86165b1e22bbe1e..e0da75afe164f9dab59b862faa7230fc57423e50 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 0000000000000000000000000000000000000000..7ddc47d1726f7627852be922d2b769d0752aa799 --- /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 0b027e403f49fc1720904cf4b502d81e4148e1e3..f011acb9431f0f3dc3b2ba27fcfe71fe6eb07ae9 100644 --- a/doc/source/utils/lock.rst +++ b/doc/source/utils/lock.rst @@ -1,37 +1,32 @@ -Thread -====== +Lock +==== - -class Thread ------------- - -.. doxygenclass:: paddle::Thread +RWLock +------ +.. doxygenclass:: paddle::RWLock :members: - -class ThreadWorker ------------------- - -.. doxygenclass:: paddle::ThreadWorker +ReadLockGuard +------------- +.. doxygenclass:: paddle::ReadLockGuard :members: - -class SyncThreadPool --------------------- - -.. doxygenclass:: paddle::SyncThreadPool +SpinLock +-------- +.. doxygenclass:: paddle::SpinLock :members: - - -class MultiThreadWorker ------------------------ -.. doxygenclass:: paddle::MultiThreadWorker +Semaphore +--------- +.. doxygenclass:: paddle::Semaphore :members: - -class AsyncThreadPool ---------------------- +ThreadBarrier +------------- +.. doxygenclass:: paddle::ThreadBarrier + :members: -.. doxygenclass:: paddle::AsyncThreadPool +LockedCondition +--------------- +.. doxygenclass:: paddle::LockedCondition :members: diff --git a/doc/source/utils/queue.rst b/doc/source/utils/queue.rst index 72a464ca67288d0d0e24980d59c3bbc85f111081..98192648e2d61e622c2337d10ba024dd676ee685 100644 --- a/doc/source/utils/queue.rst +++ b/doc/source/utils/queue.rst @@ -1,16 +1,12 @@ Queue ===== - -class Queue ------------- - +Queue +----- .. doxygenclass:: paddle::Queue :members: - -class BlockingQueue -------------------- - +BlockingQueue +------------- .. doxygenclass:: paddle::BlockingQueue :members: diff --git a/doc/source/utils/thread.rst b/doc/source/utils/thread.rst index 2eb67dde6a945cc8e250989f7fc8cefed942950e..23d379a9894e5fc22bc6795a480a53d768e608e6 100644 --- a/doc/source/utils/thread.rst +++ b/doc/source/utils/thread.rst @@ -1,40 +1,27 @@ -Lock -==== +Thread +====== - -class RWLock ------------- - -.. doxygenclass:: paddle::RWLock +Thread +------ +.. doxygenclass:: paddle::Thread :members: -class ReadLockGuard -------------------- - -.. doxygenclass:: paddle::ReadLockGuard +ThreadWorker +------------ +.. doxygenclass:: paddle::ThreadWorker :members: -class SpinLock +SyncThreadPool -------------- - -.. doxygenclass:: paddle::SpinLock +.. doxygenclass:: paddle::SyncThreadPool :members: - -class Semaphore ---------------- - -.. doxygenclass:: paddle::Semaphore - :members: - -class ThreadBarrier -------------------- - -.. doxygenclass:: paddle::ThreadBarrier + +MultiThreadWorker +----------------- +.. doxygenclass:: paddle::MultiThreadWorker :members: -class LockedCondition ---------------------- - -.. doxygenclass:: paddle::LockedCondition +AsyncThreadPool +--------------- +.. doxygenclass:: paddle::AsyncThreadPool :members: -