Skip to content

Commit 5b2de50

Browse files
weixing02shanyi15
authored andcommitted
Add some new api documentations (#10637)
1 parent 0cd3d46 commit 5b2de50

File tree

10 files changed

+344
-69
lines changed

10 files changed

+344
-69
lines changed

doc/fluid/api/clip.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
2+
!DO NOT EDIT THIS FILE MANUALLY!
3+
4+
====
5+
clip
6+
====
7+
8+
ErrorClipByValue
9+
----------------
10+
11+
.. autoclass:: paddle.fluid.clip.ErrorClipByValue
12+
:members:
13+
:noindex:
14+
15+
GradientClipByValue
16+
-------------------
17+
18+
.. autoclass:: paddle.fluid.clip.GradientClipByValue
19+
:members:
20+
:noindex:
21+
22+
GradientClipByNorm
23+
------------------
24+
25+
.. autoclass:: paddle.fluid.clip.GradientClipByNorm
26+
:members:
27+
:noindex:
28+
29+
GradientClipByGlobalNorm
30+
------------------------
31+
32+
.. autoclass:: paddle.fluid.clip.GradientClipByGlobalNorm
33+
:members:
34+
:noindex:
35+
36+
append_gradient_clip_ops
37+
------------------------
38+
39+
.. autofunction:: paddle.fluid.clip.append_gradient_clip_ops
40+
:noindex:
41+
42+
error_clip_callback
43+
-------------------
44+
45+
.. autofunction:: paddle.fluid.clip.error_clip_callback
46+
:noindex:
47+

doc/fluid/api/evaluator.rst

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,3 @@
55
evaluator
66
=========
77

8-
ChunkEvaluator
9-
--------------
10-
11-
.. autoclass:: paddle.fluid.evaluator.ChunkEvaluator
12-
:members:
13-
:noindex:
14-
15-
EditDistance
16-
--------------
17-
18-
.. autoclass:: paddle.fluid.evaluator.EditDistance
19-
:members:
20-
:noindex:
21-
22-
DetectionMAP
23-
--------------
24-
25-
.. autoclass:: paddle.fluid.evaluator.DetectionMAP
26-
:members:
27-
:noindex:
28-

doc/fluid/api/executor.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,9 @@ switch_scope
3030
.. autofunction:: paddle.fluid.executor.switch_scope
3131
:noindex:
3232

33+
fetch_var
34+
---------
35+
36+
.. autofunction:: paddle.fluid.executor.fetch_var
37+
:noindex:
38+

doc/fluid/api/gen_doc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/bash
22
python gen_doc.py layers --submodules control_flow device io nn ops tensor > layers.rst
33

4-
for module in io data_feeder evaluator executor initializer io nets optimizer param_attr profiler regularizer
4+
for module in data_feeder clip metrics executor initializer io nets optimizer param_attr profiler regularizer
55
do
66
python gen_doc.py ${module} > ${module}.rst
77
done

doc/fluid/api/index_en.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ Fluid
99
data_feeder.rst
1010
executor.rst
1111
initializer.rst
12-
evaluator.rst
12+
metrics.rst
1313
nets.rst
14+
clip.rst
1415
optimizer.rst
1516
param_attr.rst
1617
profiler.rst

doc/fluid/api/initializer.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,16 @@ Xavier
3333
:members:
3434
:noindex:
3535

36-
MSRA
37-
------
36+
force_init_on_cpu
37+
-----------------
3838

39-
.. autoclass:: paddle.fluid.initializer.MSRA
40-
:members:
39+
.. autofunction:: paddle.fluid.initializer.force_init_on_cpu
40+
:noindex:
41+
42+
init_on_cpu
43+
-----------
44+
45+
.. autofunction:: paddle.fluid.initializer.init_on_cpu
4146
:noindex:
4247

4348
ConstantInitializer
@@ -68,9 +73,3 @@ XavierInitializer
6873
:members:
6974
:noindex:
7075

71-
72-
MSRAInitializer
73-
-----------------
74-
.. autoclass:: paddle.fluid.initializer.MSRAInitializer
75-
:members:
76-
:noindex:

0 commit comments

Comments
 (0)