Skip to content

Commit 1fe05c4

Browse files
authored
Generate docs for Fluid API (#6215)
* add doc config for fluid * fix typo * follow comments
1 parent 4786ad1 commit 1fe05c4

File tree

13 files changed

+522
-4
lines changed

13 files changed

+522
-4
lines changed

doc/api/index_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ API
77
v2/model_configs.rst
88
v2/data.rst
99
v2/run_logic.rst
10+
v2/fluid.rst

doc/api/v2/fluid.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
======================
2+
Fluid
3+
======================
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
8+
fluid/layers.rst
9+
fluid/data_feeder.rst
10+
fluid/executor.rst
11+
fluid/initializer.rst
12+
fluid/evaluator.rst
13+
fluid/nets.rst
14+
fluid/optimizer.rst
15+
fluid/param_attr.rst
16+
fluid/profiler.rst
17+
fluid/regularizer.rst
18+

doc/api/v2/fluid/data_feeder.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===========
2+
DataFeeder
3+
===========
4+
5+
DataFeeder
6+
-----------
7+
.. automodule:: paddle.v2.fluid.data_feeder
8+
:members: DataFeeder
9+
:noindex:

doc/api/v2/fluid/evaluator.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===========
2+
Evaluator
3+
===========
4+
5+
Evaluator
6+
-----------
7+
.. automodule:: paddle.v2.fluid.evaluator
8+
:members: Evaluator
9+
:noindex:

doc/api/v2/fluid/executor.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===========
2+
Executor
3+
===========
4+
5+
Executor
6+
-----------
7+
.. automodule:: paddle.v2.fluid.executor
8+
:members: Executor
9+
:noindex:

doc/api/v2/fluid/initializer.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
===========
2+
Initializer
3+
===========
4+
5+
6+
7+
Initializer
8+
-----------
9+
.. automodule:: paddle.v2.fluid.initializer
10+
:members: Initializer
11+
:noindex:
12+
13+
14+
15+
ConstantInitializer
16+
-------------------
17+
.. automodule:: paddle.v2.fluid.initializer
18+
:members: ConstantInitializer
19+
:noindex:
20+
21+
22+
23+
UniformInitializer
24+
------------------
25+
.. automodule:: paddle.v2.fluid.initializer
26+
:members: UniformInitializer
27+
:noindex:
28+
29+
30+
31+
NormalInitializer
32+
-----------------
33+
.. automodule:: paddle.v2.fluid.initializer
34+
:members: NormalInitializer
35+
:noindex:
36+
37+
38+
XavierInitializer
39+
-----------------
40+
.. automodule:: paddle.v2.fluid.initializer
41+
:members: XavierInitializer
42+
:noindex:
43+
44+
45+
MSRAInitializer
46+
---------------
47+
.. automodule:: paddle.v2.fluid.initializer
48+
:members: MSRAInitializer
49+
:noindex:
50+

0 commit comments

Comments
 (0)