Add some new api documentations (#10637)

shanyi15-patch-3
weixing 7 years ago committed by Shan Yi
parent 0cd3d46147
commit 5b2de50c41

@ -0,0 +1,47 @@
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
====
clip
====
ErrorClipByValue
----------------
.. autoclass:: paddle.fluid.clip.ErrorClipByValue
:members:
:noindex:
GradientClipByValue
-------------------
.. autoclass:: paddle.fluid.clip.GradientClipByValue
:members:
:noindex:
GradientClipByNorm
------------------
.. autoclass:: paddle.fluid.clip.GradientClipByNorm
:members:
:noindex:
GradientClipByGlobalNorm
------------------------
.. autoclass:: paddle.fluid.clip.GradientClipByGlobalNorm
:members:
:noindex:
append_gradient_clip_ops
------------------------
.. autofunction:: paddle.fluid.clip.append_gradient_clip_ops
:noindex:
error_clip_callback
-------------------
.. autofunction:: paddle.fluid.clip.error_clip_callback
:noindex:

@ -5,24 +5,3 @@
evaluator evaluator
========= =========
ChunkEvaluator
--------------
.. autoclass:: paddle.fluid.evaluator.ChunkEvaluator
:members:
:noindex:
EditDistance
--------------
.. autoclass:: paddle.fluid.evaluator.EditDistance
:members:
:noindex:
DetectionMAP
--------------
.. autoclass:: paddle.fluid.evaluator.DetectionMAP
:members:
:noindex:

@ -30,3 +30,9 @@ switch_scope
.. autofunction:: paddle.fluid.executor.switch_scope .. autofunction:: paddle.fluid.executor.switch_scope
:noindex: :noindex:
fetch_var
---------
.. autofunction:: paddle.fluid.executor.fetch_var
:noindex:

@ -1,7 +1,7 @@
#!/bin/bash #!/bin/bash
python gen_doc.py layers --submodules control_flow device io nn ops tensor > layers.rst python gen_doc.py layers --submodules control_flow device io nn ops tensor > layers.rst
for module in io data_feeder evaluator executor initializer io nets optimizer param_attr profiler regularizer for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer
do do
python gen_doc.py ${module} > ${module}.rst python gen_doc.py ${module} > ${module}.rst
done done

@ -9,8 +9,9 @@ Fluid
data_feeder.rst data_feeder.rst
executor.rst executor.rst
initializer.rst initializer.rst
evaluator.rst metrics.rst
nets.rst nets.rst
clip.rst
optimizer.rst optimizer.rst
param_attr.rst param_attr.rst
profiler.rst profiler.rst

@ -33,11 +33,16 @@ Xavier
:members: :members:
:noindex: :noindex:
MSRA force_init_on_cpu
------ -----------------
.. autoclass:: paddle.fluid.initializer.MSRA .. autofunction:: paddle.fluid.initializer.force_init_on_cpu
:members: :noindex:
init_on_cpu
-----------
.. autofunction:: paddle.fluid.initializer.init_on_cpu
:noindex: :noindex:
ConstantInitializer ConstantInitializer
@ -68,9 +73,3 @@ XavierInitializer
:members: :members:
:noindex: :noindex:
MSRAInitializer
-----------------
.. autoclass:: paddle.fluid.initializer.MSRAInitializer
:members:
:noindex:

File diff suppressed because it is too large Load Diff

@ -0,0 +1,56 @@
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
=======
metrics
=======
MetricBase
----------
.. autoclass:: paddle.fluid.metrics.MetricBase
:members:
:noindex:
CompositeMetric
---------------
.. autoclass:: paddle.fluid.metrics.CompositeMetric
:members:
:noindex:
Accuracy
--------
.. autoclass:: paddle.fluid.metrics.Accuracy
:members:
:noindex:
ChunkEvaluator
--------------
.. autoclass:: paddle.fluid.metrics.ChunkEvaluator
:members:
:noindex:
EditDistance
------------
.. autoclass:: paddle.fluid.metrics.EditDistance
:members:
:noindex:
DetectionMAP
------------
.. autoclass:: paddle.fluid.metrics.DetectionMAP
:members:
:noindex:
Auc
---
.. autoclass:: paddle.fluid.metrics.Auc
:members:
:noindex:

@ -111,6 +111,7 @@ DecayedAdagradOptimizer
:members: :members:
:noindex: :noindex:
AdadeltaOptimizer AdadeltaOptimizer
----------------- -----------------
@ -118,9 +119,17 @@ AdadeltaOptimizer
:members: :members:
:noindex: :noindex:
RMSPropOptimizer RMSPropOptimizer
----------------- -----------------
.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer .. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
:members: :members:
:noindex: :noindex:
Optimizer
---------
.. autoclass:: paddle.fluid.optimizer.Optimizer
:members:
:noindex:

@ -11,6 +11,13 @@ append_regularization_ops
.. autofunction:: paddle.fluid.regularizer.append_regularization_ops .. autofunction:: paddle.fluid.regularizer.append_regularization_ops
:noindex: :noindex:
WeightDecayRegularizer
----------------------
.. autoclass:: paddle.fluid.regularizer.WeightDecayRegularizer
:members:
:noindex:
L1Decay L1Decay
------- -------
@ -26,15 +33,16 @@ L2Decay
:noindex: :noindex:
L1DecayRegularizer L1DecayRegularizer
--------------------- ------------------
.. autoclass:: paddle.fluid.regularizer.L1DecayRegularizer .. autoclass:: paddle.fluid.regularizer.L1DecayRegularizer
:members: :members:
:noindex: :noindex:
L2DecayRegularizer L2DecayRegularizer
--------------------- ------------------
.. autoclass:: paddle.fluid.regularizer.L2DecayRegularizer .. autoclass:: paddle.fluid.regularizer.L2DecayRegularizer
:members: :members:
:noindex: :noindex:

Loading…
Cancel
Save