“22cb62db862536a67162c56b7374367c643d033e”上不存在“develop/doc/api/v2/fluid/layers.html”
未验证 提交 d6157cff 编写于 作者: Y yuyang18

Refector gen_doc.py, add header anchor

上级 5a2a9963
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_average:
============= =============
fluid.average fluid.average
============= =============
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_backward:
============== ==============
fluid.backward fluid.backward
============== ==============
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_clip:
========== ==========
fluid.clip fluid.clip
========== ==========
...@@ -41,19 +43,3 @@ GradientClipByGlobalNorm ...@@ -41,19 +43,3 @@ GradientClipByGlobalNorm
:members: :members:
:noindex: :noindex:
.. _api_fluid_clip_append_gradient_clip_ops:
append_gradient_clip_ops
------------------------
.. autofunction:: paddle.fluid.clip.append_gradient_clip_ops
:noindex:
.. _api_fluid_clip_error_clip_callback:
error_clip_callback
-------------------
.. autofunction:: paddle.fluid.clip.error_clip_callback
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_data_feeder:
================= =================
fluid.data_feeder fluid.data_feeder
================= =================
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_executor:
============== ==============
fluid.executor fluid.executor
============== ==============
...@@ -30,12 +32,12 @@ scope_guard ...@@ -30,12 +32,12 @@ scope_guard
.. autofunction:: paddle.fluid.executor.scope_guard .. autofunction:: paddle.fluid.executor.scope_guard
:noindex: :noindex:
.. _api_fluid_executor_switch_scope: .. _api_fluid_executor__switch_scope:
switch_scope _switch_scope
------------ -------------
.. autofunction:: paddle.fluid.executor.switch_scope .. autofunction:: paddle.fluid.executor._switch_scope
:noindex: :noindex:
.. _api_fluid_executor_fetch_var: .. _api_fluid_executor_fetch_var:
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid:
===== =====
fluid fluid
===== =====
...@@ -65,22 +67,6 @@ program_guard ...@@ -65,22 +67,6 @@ program_guard
.. autofunction:: paddle.fluid.program_guard .. autofunction:: paddle.fluid.program_guard
:noindex: :noindex:
.. _api_fluid_switch_startup_program:
switch_startup_program
----------------------
.. autofunction:: paddle.fluid.switch_startup_program
:noindex:
.. _api_fluid_switch_main_program:
switch_main_program
-------------------
.. autofunction:: paddle.fluid.switch_main_program
:noindex:
.. _api_fluid_get_var: .. _api_fluid_get_var:
get_var get_var
...@@ -114,12 +100,12 @@ scope_guard ...@@ -114,12 +100,12 @@ scope_guard
.. autofunction:: paddle.fluid.scope_guard .. autofunction:: paddle.fluid.scope_guard
:noindex: :noindex:
.. _api_fluid_switch_scope: .. _api_fluid__switch_scope:
switch_scope _switch_scope
------------ -------------
.. autofunction:: paddle.fluid.switch_scope .. autofunction:: paddle.fluid._switch_scope
:noindex: :noindex:
.. _api_fluid_fetch_var: .. _api_fluid_fetch_var:
...@@ -243,6 +229,15 @@ Inferencer ...@@ -243,6 +229,15 @@ Inferencer
:members: :members:
:noindex: :noindex:
.. _api_fluid_DistributeTranspiler:
DistributeTranspiler
--------------------
.. autoclass:: paddle.fluid.DistributeTranspiler
:members:
:noindex:
.. _api_fluid_memory_optimize: .. _api_fluid_memory_optimize:
memory_optimize memory_optimize
...@@ -374,3 +369,12 @@ DataFeeder ...@@ -374,3 +369,12 @@ DataFeeder
:members: :members:
:noindex: :noindex:
.. _api_fluid_Scope:
Scope
-----
.. autoclass:: paddle.fluid.Scope
:members:
:noindex:
...@@ -48,7 +48,7 @@ class DocGenerator(object): ...@@ -48,7 +48,7 @@ class DocGenerator(object):
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
''') ''')
self._print_ref_raw_("_".join(self.module_name.split(".")))
self._print_header_(self.module_name, dot='=', is_title=True) self._print_header_(self.module_name, dot='=', is_title=True)
def print_submodule(self, submodule_name): def print_submodule(self, submodule_name):
...@@ -107,9 +107,10 @@ class DocGenerator(object): ...@@ -107,9 +107,10 @@ class DocGenerator(object):
self.stream.write('\n') self.stream.write('\n')
def _print_ref_(self, name): def _print_ref_(self, name):
self.stream.write(".. _api_{0}_{1}:\n\n".format( self._print_ref_raw_("_".join(self.module_name.split(".") + [name]))
"_".join(self.module_name.split(".")), name
)) def _print_ref_raw_(self, anchor):
self.stream.write(".. _api_{0}:\n\n".format(anchor))
def main(): def main():
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_initializer:
================= =================
fluid.initializer fluid.initializer
================= =================
...@@ -50,6 +52,15 @@ Bilinear ...@@ -50,6 +52,15 @@ Bilinear
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_MSRA:
MSRA
----
.. autoclass:: paddle.fluid.initializer.MSRA
:members:
:noindex:
.. _api_fluid_initializer_force_init_on_cpu: .. _api_fluid_initializer_force_init_on_cpu:
force_init_on_cpu force_init_on_cpu
...@@ -111,3 +122,12 @@ BilinearInitializer ...@@ -111,3 +122,12 @@ BilinearInitializer
:members: :members:
:noindex: :noindex:
.. _api_fluid_initializer_MSRAInitializer:
MSRAInitializer
---------------
.. autoclass:: paddle.fluid.initializer.MSRAInitializer
:members:
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_io:
======== ========
fluid.io fluid.io
======== ========
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_layers:
============ ============
fluid.layers fluid.layers
============ ============
...@@ -910,6 +912,14 @@ log ...@@ -910,6 +912,14 @@ log
.. autofunction:: paddle.fluid.layers.log .. autofunction:: paddle.fluid.layers.log
:noindex: :noindex:
.. _api_fluid_layers_crop:
crop
----
.. autofunction:: paddle.fluid.layers.crop
:noindex:
ops ops
=== ===
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_metrics:
============= =============
fluid.metrics fluid.metrics
============= =============
...@@ -23,6 +25,24 @@ CompositeMetric ...@@ -23,6 +25,24 @@ CompositeMetric
:members: :members:
:noindex: :noindex:
.. _api_fluid_metrics_Precision:
Precision
---------
.. autoclass:: paddle.fluid.metrics.Precision
:members:
:noindex:
.. _api_fluid_metrics_Recall:
Recall
------
.. autoclass:: paddle.fluid.metrics.Recall
:members:
:noindex:
.. _api_fluid_metrics_Accuracy: .. _api_fluid_metrics_Accuracy:
Accuracy Accuracy
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_nets:
========== ==========
fluid.nets fluid.nets
========== ==========
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_optimizer:
=============== ===============
fluid.optimizer fluid.optimizer
=============== ===============
...@@ -59,6 +61,15 @@ DecayedAdagrad ...@@ -59,6 +61,15 @@ DecayedAdagrad
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_Ftrl:
Ftrl
----
.. autoclass:: paddle.fluid.optimizer.Ftrl
:members:
:noindex:
.. _api_fluid_optimizer_SGDOptimizer: .. _api_fluid_optimizer_SGDOptimizer:
SGDOptimizer SGDOptimizer
...@@ -122,6 +133,15 @@ RMSPropOptimizer ...@@ -122,6 +133,15 @@ RMSPropOptimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_FtrlOptimizer:
FtrlOptimizer
-------------
.. autoclass:: paddle.fluid.optimizer.FtrlOptimizer
:members:
:noindex:
.. _api_fluid_optimizer_Adadelta: .. _api_fluid_optimizer_Adadelta:
Adadelta Adadelta
...@@ -149,3 +169,12 @@ Optimizer ...@@ -149,3 +169,12 @@ Optimizer
:members: :members:
:noindex: :noindex:
.. _api_fluid_optimizer_RMSPropOptimizer:
RMSPropOptimizer
----------------
.. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
:members:
:noindex:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_param_attr:
================ ================
fluid.param_attr fluid.param_attr
================ ================
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_profiler:
============== ==============
fluid.profiler fluid.profiler
============== ==============
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_recordio_writer:
===================== =====================
fluid.recordio_writer fluid.recordio_writer
===================== =====================
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_regularizer:
================= =================
fluid.regularizer fluid.regularizer
================= =================
...@@ -13,15 +15,6 @@ append_regularization_ops ...@@ -13,15 +15,6 @@ append_regularization_ops
.. autofunction:: paddle.fluid.regularizer.append_regularization_ops .. autofunction:: paddle.fluid.regularizer.append_regularization_ops
:noindex: :noindex:
.. _api_fluid_regularizer_WeightDecayRegularizer:
WeightDecayRegularizer
----------------------
.. autoclass:: paddle.fluid.regularizer.WeightDecayRegularizer
:members:
:noindex:
.. _api_fluid_regularizer_L1Decay: .. _api_fluid_regularizer_L1Decay:
L1Decay L1Decay
......
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY! !DO NOT EDIT THIS FILE MANUALLY!
.. _api_fluid_transpiler:
================ ================
fluid.transpiler fluid.transpiler
================ ================
.. _api_fluid_transpiler_DistributeTranspiler:
DistributeTranspiler
--------------------
.. autoclass:: paddle.fluid.transpiler.DistributeTranspiler
:members:
:noindex:
.. _api_fluid_transpiler_memory_optimize: .. _api_fluid_transpiler_memory_optimize:
memory_optimize memory_optimize
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册