Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new fluid api documents #10637

Merged
merged 9 commits into from
May 24, 2018
47 changes: 47 additions & 0 deletions doc/fluid/api/clip.rst
Original file line number Diff line number Diff line change
@@ -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:

21 changes: 0 additions & 21 deletions doc/fluid/api/evaluator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,3 @@
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:

6 changes: 6 additions & 0 deletions doc/fluid/api/executor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,9 @@ switch_scope
.. autofunction:: paddle.fluid.executor.switch_scope
:noindex:

fetch_var
---------

.. autofunction:: paddle.fluid.executor.fetch_var
:noindex:

2 changes: 1 addition & 1 deletion doc/fluid/api/gen_doc.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
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
python gen_doc.py ${module} > ${module}.rst
done
3 changes: 2 additions & 1 deletion doc/fluid/api/index_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ Fluid
data_feeder.rst
executor.rst
initializer.rst
evaluator.rst
metrics.rst
nets.rst
clip.rst
optimizer.rst
param_attr.rst
profiler.rst
Expand Down
19 changes: 9 additions & 10 deletions doc/fluid/api/initializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,16 @@ Xavier
:members:
:noindex:

MSRA
------
force_init_on_cpu
-----------------

.. autoclass:: paddle.fluid.initializer.MSRA
:members:
.. autofunction:: paddle.fluid.initializer.force_init_on_cpu
:noindex:

init_on_cpu
-----------

.. autofunction:: paddle.fluid.initializer.init_on_cpu
:noindex:

ConstantInitializer
Expand Down Expand Up @@ -68,9 +73,3 @@ XavierInitializer
:members:
:noindex:


MSRAInitializer
-----------------
.. autoclass:: paddle.fluid.initializer.MSRAInitializer
:members:
:noindex:
Loading