diff --git a/doc/fluid/api/gen_doc.py b/doc/fluid/api/gen_doc.py index 638f6c338eb3d869f572234ef463b624a13e0471..a45f854ef38715f66d019a58edb4e17dcb1a74c5 100644 --- a/doc/fluid/api/gen_doc.py +++ b/doc/fluid/api/gen_doc.py @@ -94,6 +94,14 @@ class DocGenerator(object): :members: :noindex: +'''.format(self.module_prefix, name)) + elif "fluid.optimizer" in self.module_prefix: + self.stream.write('''.. autoclass:: paddle.{0}.{1} + :members: + :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load + :noindex: + '''.format(self.module_prefix, name)) else: self.stream.write('''.. autoclass:: paddle.{0}.{1} diff --git a/doc/fluid/api/optimizer/AdagradOptimizer.rst b/doc/fluid/api/optimizer/AdagradOptimizer.rst index 16cb1ca17f7bc11e5014a37274e842d313393ab7..e52a9de102f86f386ceb38c65325e7ac53c34982 100644 --- a/doc/fluid/api/optimizer/AdagradOptimizer.rst +++ b/doc/fluid/api/optimizer/AdagradOptimizer.rst @@ -9,5 +9,6 @@ AdagradOptimizer .. autoclass:: paddle.fluid.optimizer.AdagradOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/AdamOptimizer.rst b/doc/fluid/api/optimizer/AdamOptimizer.rst index 4cf6d3383a3ebd15db481a196f803dd8ac9a2c1c..9a966f54c29bbef6153c099e373797deb3ae8995 100644 --- a/doc/fluid/api/optimizer/AdamOptimizer.rst +++ b/doc/fluid/api/optimizer/AdamOptimizer.rst @@ -9,5 +9,6 @@ AdamOptimizer .. autoclass:: paddle.fluid.optimizer.AdamOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/AdamaxOptimizer.rst b/doc/fluid/api/optimizer/AdamaxOptimizer.rst index 2a55ce94b47ee5d459d4988a3b2b04c60ad6acac..b27b7aab44cb76f611ffa2e5512dd5e98597a602 100644 --- a/doc/fluid/api/optimizer/AdamaxOptimizer.rst +++ b/doc/fluid/api/optimizer/AdamaxOptimizer.rst @@ -9,5 +9,6 @@ AdamaxOptimizer .. autoclass:: paddle.fluid.optimizer.AdamaxOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/DecayedAdagradOptimizer.rst b/doc/fluid/api/optimizer/DecayedAdagradOptimizer.rst index a40df74fd7fedff39b1d415a4c8b9c7f69de4756..f0aa277010fcbbc11642be3f6f50f97e1c5a7197 100644 --- a/doc/fluid/api/optimizer/DecayedAdagradOptimizer.rst +++ b/doc/fluid/api/optimizer/DecayedAdagradOptimizer.rst @@ -9,5 +9,6 @@ DecayedAdagradOptimizer .. autoclass:: paddle.fluid.optimizer.DecayedAdagradOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/ModelAverage.rst b/doc/fluid/api/optimizer/ModelAverage.rst index 4608f391ce0df9e38783bf3cbd0bb1b250b27887..7c11858ace040bfc2458bc32adca6a66235492b5 100644 --- a/doc/fluid/api/optimizer/ModelAverage.rst +++ b/doc/fluid/api/optimizer/ModelAverage.rst @@ -8,6 +8,5 @@ ModelAverage .. autoclass:: paddle.fluid.optimizer.ModelAverage :members: - :inherited-members: :noindex: diff --git a/doc/fluid/api/optimizer/MomentumOptimizer.rst b/doc/fluid/api/optimizer/MomentumOptimizer.rst index d5ce332405a8050bb6cf15516e669c41711a6a46..1f0c6c632918b8ed7a32c8c16a1dad642ed2e64f 100644 --- a/doc/fluid/api/optimizer/MomentumOptimizer.rst +++ b/doc/fluid/api/optimizer/MomentumOptimizer.rst @@ -9,5 +9,6 @@ MomentumOptimizer .. autoclass:: paddle.fluid.optimizer.MomentumOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/RMSPropOptimizer.rst b/doc/fluid/api/optimizer/RMSPropOptimizer.rst index 9bf9e71f2ffb0cee8a2dc75b018974cd4287a88c..237c4ea71e45039063acce502b9c0bd9800e9ffd 100644 --- a/doc/fluid/api/optimizer/RMSPropOptimizer.rst +++ b/doc/fluid/api/optimizer/RMSPropOptimizer.rst @@ -9,5 +9,6 @@ RMSPropOptimizer .. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: diff --git a/doc/fluid/api/optimizer/SGDOptimizer.rst b/doc/fluid/api/optimizer/SGDOptimizer.rst index e1626d6e68f2c9efc0d8d767f218352b97b0f6a4..c6ec7ea6fd0d64b50676584c3b60733b274986fe 100644 --- a/doc/fluid/api/optimizer/SGDOptimizer.rst +++ b/doc/fluid/api/optimizer/SGDOptimizer.rst @@ -9,5 +9,6 @@ SGDOptimizer .. autoclass:: paddle.fluid.optimizer.SGDOptimizer :members: :inherited-members: + :exclude-members: apply_gradients, apply_optimize, backward, load :noindex: