From 7f07e830e22879c7ebfd2d9670d367e68abe0c7c Mon Sep 17 00:00:00 2001 From: Luo Tao Date: Fri, 18 Nov 2016 15:19:55 +0800 Subject: [PATCH] proper nouns begin with a capital letter, and remove spaces in class name --- doc/source/api.rst | 2 +- doc/source/cuda/cuda.rst | 35 ------------------------- doc/source/cuda/index.rst | 3 +-- doc/source/cuda/nn.rst | 2 ++ doc/source/cuda/utils.rst | 19 ++++++++++++++ doc/source/gserver/dataproviders.rst | 12 ++++----- doc/source/gserver/gradientmachines.rst | 16 +++++------ doc/source/gserver/index.rst | 2 +- doc/source/index.rst | 2 +- doc/source/math/vector.rst | 8 +++--- doc/source/pserver/index.rst | 2 +- doc/source/pserver/network.rst | 20 +++++++------- doc/source/utils/lock.rst | 24 ++++++++--------- doc/source/utils/queue.rst | 8 +++--- doc/source/utils/thread.rst | 20 +++++++------- 15 files changed, 80 insertions(+), 95 deletions(-) delete mode 100644 doc/source/cuda/cuda.rst diff --git a/doc/source/api.rst b/doc/source/api.rst index 22fb5fb644a..30396c26b61 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 77b6e4a4d28..00000000000 --- 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 d453f658a71..b0fed2e7f72 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 5ebd8632429..5577d01e72a 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 c5d4a45a448..850e8bd1c66 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 73e45f1f339..c30d9d6a36a 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 d67c8dbcbd4..04c8e91d031 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 b0b41e3ad18..223b00b9a9d 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 7aebcadd759..36323c888ee 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 579ed7ba556..07f7062abaf 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 1cb3af32f89..0031e9476bd 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 cf6418bc1a1..7004c9d91fa 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 1dd3f4c0515..f011acb9431 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 5829028ebdc..98192648e2d 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 09f826fa1d1..23d379a9894 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: -- GitLab