Skip to content

Generate docs for Fluid API #6215

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.

Sign up for GitHub

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

Merged
QiJune merged 3 commits into from
Dec 4, 2017
Merged

Generate docs for Fluid API #6215

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bbbc9a
add doc config for fluid
QiJune Dec 4, 2017
ed41062
fix typo
QiJune Dec 4, 2017
c0080a6
follow comments
QiJune Dec 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/api/index_en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ API
v2/model_configs.rst
v2/data.rst
v2/run_logic.rst
v2/fluid.rst
18 changes: 18 additions & 0 deletions doc/api/v2/fluid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

@luotao1 luotao1 Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should adjust the order in next PRs

Copy link
Member Author

@QiJune QiJune Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we can merge this PR first. And then more developers can join in and we can make iterative document polishing.


11 changes: 11 additions & 0 deletions doc/api/v2/fluid/data_feeder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
===========
DataFeeder
===========

Copy link
Contributor

@luotao1 luotao1 Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of blank lines in rst.
You can delete these, for example, line 5-6.

Copy link
Member Author

@QiJune QiJune Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done



DataFeeder
-----------
.. automodule:: paddle.v2.fluid.data_feeder
:members: DataFeeder
:noindex:
11 changes: 11 additions & 0 deletions doc/api/v2/fluid/evaluator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
===========
Evaluator
===========



Evaluator
-----------
.. automodule:: paddle.v2.fluid.evaluator
:members: Evaluator
:noindex:
11 changes: 11 additions & 0 deletions doc/api/v2/fluid/executor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
===========
Executor
===========



Executor
-----------
.. automodule:: paddle.v2.fluid.executor
:members: Executor
:noindex:
50 changes: 50 additions & 0 deletions doc/api/v2/fluid/initializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
===========
Initializer
===========



Initializer
-----------
.. automodule:: paddle.v2.fluid.initializer
:members: Initializer
:noindex:



ConstantInitializer
-----------
Copy link
Contributor

@luotao1 luotao1 Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 16 should be longer than line 15, otherwise, there will be warnings when compile paddle_docs

Copy link
Member Author

@QiJune QiJune Dec 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

.. 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:

Loading