m53297601
/
Paddle
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

proper nouns begin with a capital letter, and remove spaces in class name

Browse Source
avx_docs
Luo Tao 9 years ago
parent cad67febc1
commit 7f07e830e2
15 changed files with 80 additions and 95 deletions
Show Stats Download Patch File Download Diff File

2
doc/source/api.rst
Unescape View File

@ -1,4 +1,4 @@
Api API
=== ===
.. doxygenfile:: paddle/api/PaddleAPI.h .. doxygenfile:: paddle/api/PaddleAPI.h

35
doc/source/cuda/cuda.rst
Unescape View File

@ -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

3
doc/source/cuda/index.rst
Unescape View File

@ -1,10 +1,9 @@
Cuda CUDA
==== ====
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
cuda.rst
matrix.rst matrix.rst
nn.rst nn.rst
utils.rst utils.rst

2
doc/source/cuda/nn.rst
Unescape View File

@ -10,10 +10,12 @@ Base
.. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh .. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh
.. doxygenfile:: paddle/cuda/include/hl_activation_functions.h .. doxygenfile:: paddle/cuda/include/hl_activation_functions.h
CNN Related APIs CNN Related APIs
---------------- ----------------
.. doxygenfile:: paddle/cuda/include/hl_cnn.h .. doxygenfile:: paddle/cuda/include/hl_cnn.h
.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h .. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph
RNN Related APIs RNN Related APIs
---------------- ----------------

19
doc/source/cuda/utils.rst
Unescape View File

@ -1,10 +1,29 @@
Utils 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 HPPL Base
--------- ---------
.. doxygenfile:: paddle/cuda/include/hl_base.h .. doxygenfile:: paddle/cuda/include/hl_base.h
CUBLAS Wrapper
--------------
.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
Timer Timer
----- -----
.. doxygenfile:: paddle/cuda/include/hl_time.h .. doxygenfile:: paddle/cuda/include/hl_time.h

12
doc/source/gserver/dataproviders.rst
Unescape View File

@ -2,11 +2,11 @@
Data Providers Data Providers
============== ==============
Data Providers DataProviders
============== =============
Base DataProvider Base
----------------- ----
.. doxygenclass:: paddle::DataProvider .. doxygenclass:: paddle::DataProvider
:members: :members:
@ -73,8 +73,8 @@ IPyDataProvider
.. doxygenclass:: paddle::PyDataProvider2 .. doxygenclass:: paddle::PyDataProvider2
:members: :members:
Proto Data Provider ProtoDataProvider
=================== =================
ProtoDataProvider ProtoDataProvider
---------------- ----------------

16
doc/source/gserver/gradientmachines.rst
Unescape View File

@ -1,18 +1,18 @@
Gradient Machines Gradient Machines
================= =================
Gradient Machine GradientMachine
---------------- ---------------
.. doxygenclass:: paddle::GradientMachine .. doxygenclass:: paddle::GradientMachine
:members: :members:
Gradient Machine Mode GradientMachineMode
--------------------- -------------------
.. doxygenclass:: paddle::IGradientMachineMode .. doxygenclass:: paddle::IGradientMachineMode
:members: :members:
Multi Gradient Machine MultiGradientMachine
---------------------- --------------------
.. doxygenclass:: paddle::MultiGradientMachine .. doxygenclass:: paddle::MultiGradientMachine
:members: :members:
@ -21,7 +21,7 @@ TrainerThread
.. doxygenclass:: paddle::TrainerThread .. doxygenclass:: paddle::TrainerThread
:members: :members:
Recurrent Gradient Machine RecurrentGradientMachine
-------------------------- ------------------------
.. doxygenclass:: paddle::RecurrentGradientMachine .. doxygenclass:: paddle::RecurrentGradientMachine
:members: :members:

2
doc/source/gserver/index.rst
Unescape View File

@ -1,4 +1,4 @@
Gserver GServer
======= =======
.. toctree:: .. toctree::

2
doc/source/index.rst
Unescape View File

@ -7,7 +7,7 @@ Source Code Documents
gserver/index.rst gserver/index.rst
trainer.rst trainer.rst
parameter/index.rst parameter/index.rst
pserver.rst pserver/index.rst
api.rst api.rst
cuda/index.rst cuda/index.rst
math/index.rst math/index.rst

8
doc/source/math/vector.rst
Unescape View File

@ -21,13 +21,13 @@ GpuVector Template
.. doxygenclass:: paddle::GpuVectorT .. doxygenclass:: paddle::GpuVectorT
:members: :members:
Parallel CpuVector Template ParallelCpuVector Template
``````````````````````````` ``````````````````````````
.. doxygenclass:: paddle::ParallelCpuVectorT .. doxygenclass:: paddle::ParallelCpuVectorT
:members: :members:
Parallel GpuVector Template ParallelGpuVector Template
``````````````````````````` ``````````````````````````
.. doxygenclass:: paddle::ParallelGpuVectorT .. doxygenclass:: paddle::ParallelGpuVectorT
:members: :members:

2
doc/source/pserver/index.rst
Unescape View File

@ -1,4 +1,4 @@
Pserver PServer
======= =======
.. toctree:: .. toctree::

20
doc/source/pserver/network.rst
Unescape View File

@ -1,27 +1,27 @@
Network Network
======= =======
Socket Server SocketServer
------------- ------------
.. doxygenclass:: paddle::SocketServer .. doxygenclass:: paddle::SocketServer
:members: :members:
Socket Worker SocketWorker
------------- ------------
.. doxygenclass:: paddle::SocketWorker .. doxygenclass:: paddle::SocketWorker
:members: :members:
Socket Client SocketClient
------------- ------------
.. doxygenclass:: paddle::SocketClient .. doxygenclass:: paddle::SocketClient
:members: :members:
Socket Channel SocketChannel
-------------- -------------
.. doxygenclass:: paddle::SocketChannel .. doxygenclass:: paddle::SocketChannel
:members: :members:
Message Reader MessageReader
-------------- -------------
.. doxygenclass:: paddle::MsgReader .. doxygenclass:: paddle::MsgReader
:members: :members:

24
doc/source/utils/lock.rst
Unescape View File

@ -1,32 +1,32 @@
Lock Lock
==== ====
class RWLock RWLock
------------ ------
.. doxygenclass:: paddle::RWLock .. doxygenclass:: paddle::RWLock
:members: :members:
class ReadLockGuard ReadLockGuard
------------------- -------------
.. doxygenclass:: paddle::ReadLockGuard .. doxygenclass:: paddle::ReadLockGuard
:members: :members:
class SpinLock SpinLock
-------------- --------
.. doxygenclass:: paddle::SpinLock .. doxygenclass:: paddle::SpinLock
:members: :members:
class Semaphore Semaphore
--------------- ---------
.. doxygenclass:: paddle::Semaphore .. doxygenclass:: paddle::Semaphore
:members: :members:
class ThreadBarrier ThreadBarrier
------------------- -------------
.. doxygenclass:: paddle::ThreadBarrier .. doxygenclass:: paddle::ThreadBarrier
:members: :members:
class LockedCondition LockedCondition
--------------------- ---------------
.. doxygenclass:: paddle::LockedCondition .. doxygenclass:: paddle::LockedCondition
:members: :members:

8
doc/source/utils/queue.rst
Unescape View File

@ -1,12 +1,12 @@
Queue Queue
===== =====
class Queue Queue
------------ -----
.. doxygenclass:: paddle::Queue .. doxygenclass:: paddle::Queue
:members: :members:
class BlockingQueue BlockingQueue
------------------- -------------
.. doxygenclass:: paddle::BlockingQueue .. doxygenclass:: paddle::BlockingQueue
:members: :members:

20
doc/source/utils/thread.rst
Unescape View File

@ -1,27 +1,27 @@
Thread Thread
====== ======
class Thread Thread
------------ ------
.. doxygenclass:: paddle::Thread .. doxygenclass:: paddle::Thread
:members: :members:
class ThreadWorker ThreadWorker
------------------ ------------
.. doxygenclass:: paddle::ThreadWorker .. doxygenclass:: paddle::ThreadWorker
:members: :members:
class SyncThreadPool SyncThreadPool
-------------------- --------------
.. doxygenclass:: paddle::SyncThreadPool .. doxygenclass:: paddle::SyncThreadPool
:members: :members:
class MultiThreadWorker MultiThreadWorker
----------------------- -----------------
.. doxygenclass:: paddle::MultiThreadWorker .. doxygenclass:: paddle::MultiThreadWorker
:members: :members:
class AsyncThreadPool AsyncThreadPool
--------------------- ---------------
.. doxygenclass:: paddle::AsyncThreadPool .. doxygenclass:: paddle::AsyncThreadPool
:members: :members:

Write Preview
Loading…
Cancel
Save