diff --git a/doc/source/api.rst b/doc/source/api.rst index 22fb5fb644a4c0f9042c3529beb79cd13da5bca8..30396c26b61827847cc5acc29cee1c3c8e7b226e 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -1,4 +1,4 @@ -Api +API === .. doxygenfile:: paddle/api/PaddleAPI.h diff --git a/doc/source/cuda/cuda.rst b/doc/source/cuda/cuda.rst deleted file mode 100644 index 77b6e4a4d286c5211f96ea77abd03c49dc1a6b0c..0000000000000000000000000000000000000000 --- a/doc/source/cuda/cuda.rst +++ /dev/null @@ -1,35 +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/index.rst b/doc/source/cuda/index.rst index d453f658a7182424dc80db2da1ad55813f081890..b0fed2e7f72c9a9671e56e114edfc88d72504dbe 100644 --- a/doc/source/cuda/index.rst +++ b/doc/source/cuda/index.rst @@ -1,10 +1,9 @@ -Cuda +CUDA ==== .. toctree:: :maxdepth: 2 - cuda.rst matrix.rst nn.rst utils.rst diff --git a/doc/source/cuda/nn.rst b/doc/source/cuda/nn.rst index 5ebd8632429a065d5082b5fa19929018285debb1..5577d01e72a5b22847bda40528c46a28cacc1490 100644 --- a/doc/source/cuda/nn.rst +++ b/doc/source/cuda/nn.rst @@ -10,10 +10,12 @@ Base .. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh .. 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 ---------------- diff --git a/doc/source/cuda/utils.rst b/doc/source/cuda/utils.rst index c5d4a45a448438f91a483ada9cbcd8bde58ae927..850e8bd1c6670947e2a5f1b6f9b0d5b252117cbf 100644 --- a/doc/source/cuda/utils.rst +++ b/doc/source/cuda/utils.rst @@ -1,10 +1,29 @@ 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 diff --git a/doc/source/gserver/dataproviders.rst b/doc/source/gserver/dataproviders.rst index 73e45f1f339c9aadafb65a2d41936ce972590680..c30d9d6a36a6fbb664ae001274b6a7b0e721070f 100644 --- a/doc/source/gserver/dataproviders.rst +++ b/doc/source/gserver/dataproviders.rst @@ -2,11 +2,11 @@ Data Providers ============== -Data Providers -============== +DataProviders +============= -Base DataProvider ------------------ +Base +---- .. doxygenclass:: paddle::DataProvider :members: @@ -73,8 +73,8 @@ IPyDataProvider .. doxygenclass:: paddle::PyDataProvider2 :members: -Proto Data Provider -=================== +ProtoDataProvider +================= ProtoDataProvider ---------------- diff --git a/doc/source/gserver/gradientmachines.rst b/doc/source/gserver/gradientmachines.rst index d67c8dbcbd4ae09b37a5b9f54759e1753c3f7912..04c8e91d0316a45ad10b0ed0513d3e8916b7c3d9 100644 --- a/doc/source/gserver/gradientmachines.rst +++ b/doc/source/gserver/gradientmachines.rst @@ -1,18 +1,18 @@ Gradient Machines ================= -Gradient Machine ----------------- +GradientMachine +--------------- .. doxygenclass:: paddle::GradientMachine :members: -Gradient Machine Mode ---------------------- +GradientMachineMode +------------------- .. doxygenclass:: paddle::IGradientMachineMode :members: -Multi Gradient Machine ----------------------- +MultiGradientMachine +-------------------- .. doxygenclass:: paddle::MultiGradientMachine :members: @@ -21,7 +21,7 @@ TrainerThread .. doxygenclass:: paddle::TrainerThread :members: -Recurrent Gradient Machine --------------------------- +RecurrentGradientMachine +------------------------ .. doxygenclass:: paddle::RecurrentGradientMachine :members: diff --git a/doc/source/gserver/index.rst b/doc/source/gserver/index.rst index b0b41e3ad18551643268cf602f8daa15b35d48ee..223b00b9a9dbf1db40ce702cf0e154e5e53a8644 100644 --- a/doc/source/gserver/index.rst +++ b/doc/source/gserver/index.rst @@ -1,4 +1,4 @@ -Gserver +GServer ======= .. toctree:: diff --git a/doc/source/index.rst b/doc/source/index.rst index 7aebcadd759b90827a670a805c5e113066de6ecc..36323c888ee65147f59f28160dc26ca29235ba63 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,7 +7,7 @@ Source Code Documents gserver/index.rst trainer.rst parameter/index.rst - pserver.rst + pserver/index.rst api.rst cuda/index.rst math/index.rst diff --git a/doc/source/math/vector.rst b/doc/source/math/vector.rst index 579ed7ba556b530e0dd62b65b1a2f94ee5fcef76..07f7062abaf4f30b8967b594f4e16ab881f5414f 100644 --- a/doc/source/math/vector.rst +++ b/doc/source/math/vector.rst @@ -21,13 +21,13 @@ GpuVector Template .. doxygenclass:: paddle::GpuVectorT :members: -Parallel CpuVector Template -``````````````````````````` +ParallelCpuVector Template +`````````````````````````` .. doxygenclass:: paddle::ParallelCpuVectorT :members: -Parallel GpuVector Template -``````````````````````````` +ParallelGpuVector Template +`````````````````````````` .. doxygenclass:: paddle::ParallelGpuVectorT :members: diff --git a/doc/source/pserver/index.rst b/doc/source/pserver/index.rst index 1cb3af32f89fbd1f155c5cae8dd8733fde9c7788..0031e9476bd063511cc2f0a8c209f35627cf44ba 100644 --- a/doc/source/pserver/index.rst +++ b/doc/source/pserver/index.rst @@ -1,4 +1,4 @@ -Pserver +PServer ======= .. toctree:: diff --git a/doc/source/pserver/network.rst b/doc/source/pserver/network.rst index cf6418bc1a13bfbd7b9bd059963120b29bb883b9..7004c9d91fa9f2af11e15791ef682c108761027e 100644 --- a/doc/source/pserver/network.rst +++ b/doc/source/pserver/network.rst @@ -1,27 +1,27 @@ Network ======= -Socket Server -------------- +SocketServer +------------ .. doxygenclass:: paddle::SocketServer :members: -Socket Worker -------------- +SocketWorker +------------ .. doxygenclass:: paddle::SocketWorker :members: -Socket Client -------------- +SocketClient +------------ .. doxygenclass:: paddle::SocketClient :members: -Socket Channel --------------- +SocketChannel +------------- .. doxygenclass:: paddle::SocketChannel :members: -Message Reader --------------- +MessageReader +------------- .. doxygenclass:: paddle::MsgReader :members: diff --git a/doc/source/utils/lock.rst b/doc/source/utils/lock.rst index 1dd3f4c0515c423289fd85f9713f03c75c38d6e0..f011acb9431f0f3dc3b2ba27fcfe71fe6eb07ae9 100644 --- a/doc/source/utils/lock.rst +++ b/doc/source/utils/lock.rst @@ -1,32 +1,32 @@ Lock ==== -class RWLock ------------- +RWLock +------ .. doxygenclass:: paddle::RWLock :members: -class ReadLockGuard -------------------- +ReadLockGuard +------------- .. doxygenclass:: paddle::ReadLockGuard :members: -class SpinLock --------------- +SpinLock +-------- .. doxygenclass:: paddle::SpinLock :members: -class Semaphore ---------------- +Semaphore +--------- .. doxygenclass:: paddle::Semaphore :members: -class ThreadBarrier -------------------- +ThreadBarrier +------------- .. doxygenclass:: paddle::ThreadBarrier :members: -class LockedCondition ---------------------- +LockedCondition +--------------- .. doxygenclass:: paddle::LockedCondition :members: diff --git a/doc/source/utils/queue.rst b/doc/source/utils/queue.rst index 5829028ebdc18288f567b088e7ef1c61c86f6e32..98192648e2d61e622c2337d10ba024dd676ee685 100644 --- a/doc/source/utils/queue.rst +++ b/doc/source/utils/queue.rst @@ -1,12 +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 09f826fa1d1cb7e12ad108c1b1e1012455ec0ef1..23d379a9894e5fc22bc6795a480a53d768e608e6 100644 --- a/doc/source/utils/thread.rst +++ b/doc/source/utils/thread.rst @@ -1,27 +1,27 @@ Thread ====== -class Thread ------------- +Thread +------ .. doxygenclass:: paddle::Thread :members: -class ThreadWorker ------------------- +ThreadWorker +------------ .. doxygenclass:: paddle::ThreadWorker :members: -class SyncThreadPool --------------------- +SyncThreadPool +-------------- .. doxygenclass:: paddle::SyncThreadPool :members: -class MultiThreadWorker ------------------------ +MultiThreadWorker +----------------- .. doxygenclass:: paddle::MultiThreadWorker :members: -class AsyncThreadPool ---------------------- +AsyncThreadPool +--------------- .. doxygenclass:: paddle::AsyncThreadPool :members: