Generate docs for Fluid API (#6215)
* add doc config for fluid * fix typo * follow commentsrelease/0.11.0
parent
4786ad1457
commit
1fe05c458f
@ -0,0 +1,18 @@
|
||||
======================
|
||||
Fluid
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
fluid/layers.rst
|
||||
fluid/data_feeder.rst
|
||||
fluid/executor.rst
|
||||
fluid/initializer.rst
|
||||
fluid/evaluator.rst
|
||||
fluid/nets.rst
|
||||
fluid/optimizer.rst
|
||||
fluid/param_attr.rst
|
||||
fluid/profiler.rst
|
||||
fluid/regularizer.rst
|
||||
|
@ -0,0 +1,9 @@
|
||||
===========
|
||||
DataFeeder
|
||||
===========
|
||||
|
||||
DataFeeder
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.data_feeder
|
||||
:members: DataFeeder
|
||||
:noindex:
|
@ -0,0 +1,9 @@
|
||||
===========
|
||||
Evaluator
|
||||
===========
|
||||
|
||||
Evaluator
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.evaluator
|
||||
:members: Evaluator
|
||||
:noindex:
|
@ -0,0 +1,9 @@
|
||||
===========
|
||||
Executor
|
||||
===========
|
||||
|
||||
Executor
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.executor
|
||||
:members: Executor
|
||||
:noindex:
|
@ -0,0 +1,50 @@
|
||||
===========
|
||||
Initializer
|
||||
===========
|
||||
|
||||
|
||||
|
||||
Initializer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: Initializer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
ConstantInitializer
|
||||
-------------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: ConstantInitializer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
UniformInitializer
|
||||
------------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: UniformInitializer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
NormalInitializer
|
||||
-----------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: NormalInitializer
|
||||
:noindex:
|
||||
|
||||
|
||||
XavierInitializer
|
||||
-----------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: XavierInitializer
|
||||
:noindex:
|
||||
|
||||
|
||||
MSRAInitializer
|
||||
---------------
|
||||
.. automodule:: paddle.v2.fluid.initializer
|
||||
:members: MSRAInitializer
|
||||
:noindex:
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,22 @@
|
||||
===========
|
||||
Nets
|
||||
===========
|
||||
|
||||
simple_img_conv_pool
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.nets.simple_img_conv_pool
|
||||
:noindex:
|
||||
|
||||
|
||||
img_conv_group
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.nets.img_conv_group
|
||||
:noindex:
|
||||
|
||||
|
||||
sequence_conv_pool
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.nets.sequence_conv_pool
|
||||
:noindex:
|
||||
|
||||
|
@ -0,0 +1,54 @@
|
||||
===========
|
||||
Optimizer
|
||||
===========
|
||||
|
||||
Optimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: Optimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
SGDOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: SGDOptimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
MomentumOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: MomentumOptimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
AdagradOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdagradOptimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
AdamOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdamOptimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
AdamaxOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: AdamaxOptimizer
|
||||
:noindex:
|
||||
|
||||
|
||||
DecayedAdagradOptimizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.optimizer
|
||||
:members: DecayedAdagradOptimizer
|
||||
:noindex:
|
||||
|
@ -0,0 +1,11 @@
|
||||
===========
|
||||
ParamAttr
|
||||
===========
|
||||
|
||||
|
||||
|
||||
ParamAttr
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.param_attr
|
||||
:members: ParamAttr
|
||||
:noindex:
|
@ -0,0 +1,10 @@
|
||||
===========
|
||||
Profiler
|
||||
===========
|
||||
|
||||
|
||||
|
||||
Profiler
|
||||
-----------
|
||||
.. autofunction:: paddle.v2.fluid.profiler.cuda_profiler
|
||||
:noindex:
|
@ -0,0 +1,25 @@
|
||||
===========
|
||||
Regularizer
|
||||
===========
|
||||
|
||||
WeightDecayRegularizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: WeightDecayRegularizer
|
||||
:noindex:
|
||||
|
||||
|
||||
L2DecayRegularizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: L2DecayRegularizer
|
||||
:noindex:
|
||||
|
||||
|
||||
|
||||
L1DecayRegularizer
|
||||
-----------
|
||||
.. automodule:: paddle.v2.fluid.regularizer
|
||||
:members: L1DecayRegularizer
|
||||
|
||||
|
Loading…
Reference in new issue