未验证 提交 73fb9d57 编写于 作者: C Chen Weihang 提交者: GitHub

Remove needless methods api in English doc (#1461)

* add filter to simplify optimizer api doc

* update related optimizer doc
上级 076dcc1b
......@@ -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}
......
......@@ -9,5 +9,6 @@ AdagradOptimizer
.. autoclass:: paddle.fluid.optimizer.AdagradOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -9,5 +9,6 @@ AdamOptimizer
.. autoclass:: paddle.fluid.optimizer.AdamOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -9,5 +9,6 @@ AdamaxOptimizer
.. autoclass:: paddle.fluid.optimizer.AdamaxOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -9,5 +9,6 @@ DecayedAdagradOptimizer
.. autoclass:: paddle.fluid.optimizer.DecayedAdagradOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -8,6 +8,5 @@ ModelAverage
.. autoclass:: paddle.fluid.optimizer.ModelAverage
:members:
:inherited-members:
:noindex:
......@@ -9,5 +9,6 @@ MomentumOptimizer
.. autoclass:: paddle.fluid.optimizer.MomentumOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -9,5 +9,6 @@ RMSPropOptimizer
.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
......@@ -9,5 +9,6 @@ SGDOptimizer
.. autoclass:: paddle.fluid.optimizer.SGDOptimizer
:members:
:inherited-members:
:exclude-members: apply_gradients, apply_optimize, backward, load
:noindex:
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册