Merge pull request PaddlePaddle#15 from pkuyym/configure_simple_net

Add doc for simple model configuration.
zhhsplendid · Jun 27, 2018 · 690efc6 · 690efc6
2 parents 7d5e0e2 + 9c8a4ef
commit 690efc6
Show file tree

Hide file tree

Showing 21 changed files with 257 additions and 58 deletions.
diff --git a/source/api_reference/average.rst b/source/api_reference/average.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_average:
+
 =============
 fluid.average
 =============

diff --git a/source/api_reference/backward.rst b/source/api_reference/backward.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_backward:
+
 ==============
 fluid.backward
 ==============

diff --git a/source/api_reference/clip.rst b/source/api_reference/clip.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_clip:
+
 ==========
 fluid.clip
 ==========
@@ -41,19 +43,3 @@ GradientClipByGlobalNorm
     :members:
     :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:
-
diff --git a/source/api_reference/data_feeder.rst b/source/api_reference/data_feeder.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_data_feeder:
+
 =================
 fluid.data_feeder
 =================

diff --git a/source/api_reference/executor.rst b/source/api_reference/executor.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_executor:
+
 ==============
 fluid.executor
 ==============
@@ -30,12 +32,12 @@ scope_guard
 ..  autofunction:: paddle.fluid.executor.scope_guard
     :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:
 
 .. _api_fluid_executor_fetch_var:

diff --git a/source/api_reference/fluid.rst b/source/api_reference/fluid.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid:
+
 =====
 fluid
 =====
@@ -65,22 +67,6 @@ program_guard
 ..  autofunction:: paddle.fluid.program_guard
     :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:
 
 get_var
@@ -114,12 +100,12 @@ scope_guard
 ..  autofunction:: paddle.fluid.scope_guard
     :noindex:
 
-.. _api_fluid_switch_scope:
+.. _api_fluid__switch_scope:
 
-switch_scope
-------------
+_switch_scope
+-------------
 
-..  autofunction:: paddle.fluid.switch_scope
+..  autofunction:: paddle.fluid._switch_scope
     :noindex:
 
 .. _api_fluid_fetch_var:
@@ -243,6 +229,15 @@ Inferencer
     :members:
     :noindex:
 
+.. _api_fluid_DistributeTranspiler:
+
+DistributeTranspiler
+--------------------
+
+..  autoclass:: paddle.fluid.DistributeTranspiler
+    :members:
+    :noindex:
+
 .. _api_fluid_memory_optimize:
 
 memory_optimize
@@ -374,3 +369,12 @@ DataFeeder
     :members:
     :noindex:
 
+.. _api_fluid_Scope:
+
+Scope
+-----
+
+..  autoclass:: paddle.fluid.Scope
+    :members:
+    :noindex:
+
diff --git a/source/api_reference/gen_doc.py b/source/api_reference/gen_doc.py
@@ -48,7 +48,7 @@ def __init__(self, module_name=None, stream=sys.stdout):
     !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)
 
     def print_submodule(self, submodule_name):
@@ -107,9 +107,10 @@ def _print_header_(self, name, dot, is_title):
         self.stream.write('\n')
 
     def _print_ref_(self, name):
-        self.stream.write(".. _api_{0}_{1}:\n\n".format(
-          "_".join(self.module_name.split(".")), name
-        ))
+        self._print_ref_raw_("_".join(self.module_name.split(".") + [name]))
+
+    def _print_ref_raw_(self, anchor):
+        self.stream.write(".. _api_{0}:\n\n".format(anchor))
 
 
 def main():

diff --git a/source/api_reference/initializer.rst b/source/api_reference/initializer.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_initializer:
+
 =================
 fluid.initializer
 =================
@@ -50,6 +52,15 @@ Bilinear
     :members:
     :noindex:
 
+.. _api_fluid_initializer_MSRA:
+
+MSRA
+----
+
+..  autoclass:: paddle.fluid.initializer.MSRA
+    :members:
+    :noindex:
+
 .. _api_fluid_initializer_force_init_on_cpu:
 
 force_init_on_cpu
@@ -111,3 +122,12 @@ BilinearInitializer
     :members:
     :noindex:
 
+.. _api_fluid_initializer_MSRAInitializer:
+
+MSRAInitializer
+---------------
+
+..  autoclass:: paddle.fluid.initializer.MSRAInitializer
+    :members:
+    :noindex:
+
diff --git a/source/api_reference/io.rst b/source/api_reference/io.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_io:
+
 ========
 fluid.io
 ========

diff --git a/source/api_reference/layers.rst b/source/api_reference/layers.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_layers:
+
 ============
 fluid.layers
 ============
@@ -910,6 +912,14 @@ log
 ..  autofunction:: paddle.fluid.layers.log
     :noindex:
 
+.. _api_fluid_layers_crop:
+
+crop
+----
+
+..  autofunction:: paddle.fluid.layers.crop
+    :noindex:
+
 ops
 ===
 

diff --git a/source/api_reference/metrics.rst b/source/api_reference/metrics.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_metrics:
+
 =============
 fluid.metrics
 =============
@@ -23,6 +25,24 @@ CompositeMetric
     :members:
     :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:
 
 Accuracy

diff --git a/source/api_reference/nets.rst b/source/api_reference/nets.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_nets:
+
 ==========
 fluid.nets
 ==========

diff --git a/source/api_reference/optimizer.rst b/source/api_reference/optimizer.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_optimizer:
+
 ===============
 fluid.optimizer
 ===============
@@ -59,6 +61,15 @@ DecayedAdagrad
     :members:
     :noindex:
 
+.. _api_fluid_optimizer_Ftrl:
+
+Ftrl
+----
+
+..  autoclass:: paddle.fluid.optimizer.Ftrl
+    :members:
+    :noindex:
+
 .. _api_fluid_optimizer_SGDOptimizer:
 
 SGDOptimizer
@@ -122,6 +133,15 @@ RMSPropOptimizer
     :members:
     :noindex:
 
+.. _api_fluid_optimizer_FtrlOptimizer:
+
+FtrlOptimizer
+-------------
+
+..  autoclass:: paddle.fluid.optimizer.FtrlOptimizer
+    :members:
+    :noindex:
+
 .. _api_fluid_optimizer_Adadelta:
 
 Adadelta
@@ -149,3 +169,12 @@ Optimizer
     :members:
     :noindex:
 
+.. _api_fluid_optimizer_RMSPropOptimizer:
+
+RMSPropOptimizer
+----------------
+
+..  autoclass:: paddle.fluid.optimizer.RMSPropOptimizer
+    :members:
+    :noindex:
+
diff --git a/source/api_reference/param_attr.rst b/source/api_reference/param_attr.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_param_attr:
+
 ================
 fluid.param_attr
 ================

diff --git a/source/api_reference/profiler.rst b/source/api_reference/profiler.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_profiler:
+
 ==============
 fluid.profiler
 ==============

diff --git a/source/api_reference/recordio_writer.rst b/source/api_reference/recordio_writer.rst
@@ -1,6 +1,8 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
+.. _api_fluid_recordio_writer:
+
 =====================
 fluid.recordio_writer
 =====================