Update FluidDoc of develop on 08/23 (PaddlePaddle#1121)

* test=document_preview * 0823 update FluidDoc,test=document_preview * add two files
zhhsplendid · Aug 26, 2019 · 6ac2199 · 6ac2199
1 parent 14c25ab
commit 6ac2199
Show file tree

Hide file tree

Showing 62 changed files with 429 additions and 33 deletions.
diff --git a/doc/fluid/api/fluid.rst b/doc/fluid/api/fluid.rst
@@ -5,8 +5,12 @@ fluid
 ..  toctree::
     :maxdepth: 1
 
+    fluid/append_backward.rst
+    fluid/backward.rst
     fluid/BuildStrategy.rst
+    fluid/clip.rst
     fluid/CompiledProgram.rst
+    fluid/contrib.rst
     fluid/cpu_places.rst
     fluid/CPUPlace.rst
     fluid/create_lod_tensor.rst
@@ -19,22 +23,44 @@ fluid
     fluid/DataFeeder.rst
     fluid/default_main_program.rst
     fluid/default_startup_program.rst
+    fluid/DistMultiTrainer.rst
     fluid/DistributeTranspiler.rst
     fluid/DistributeTranspilerConfig.rst
+    fluid/dygraph.rst
+    fluid/dygraph_grad_clip.rst
     fluid/ExecutionStrategy.rst
     fluid/Executor.rst
     fluid/global_scope.rst
     fluid/gradients.rst
+    fluid/HashName.rst
     fluid/in_dygraph_mode.rst
+    fluid/initializer.rst
+    fluid/install_check.rst
+    fluid/io.rst
+    fluid/is_compiled_with_cuda.rst
+    fluid/layers.rst
+    fluid/learning_rate_decay.rst
     fluid/LoDTensor.rst
     fluid/LoDTensorArray.rst
     fluid/memory_optimize.rst
+    fluid/MultiTrainer.rst
     fluid/name_scope.rst
+    fluid/nets.rst
+    fluid/optimizer.rst
     fluid/ParallelExecutor.rst
     fluid/ParamAttr.rst
+    fluid/PipelineTrainer.rst
+    fluid/profiler.rst
     fluid/Program.rst
     fluid/program_guard.rst
+    fluid/recordio_writer.rst
+    fluid/regularizer.rst
     fluid/release_memory.rst
+    fluid/RoundRobin.rst
+    fluid/Scope.rst
     fluid/scope_guard.rst
     fluid/Tensor.rst
+    fluid/TrainerDesc.rst
+    fluid/transpiler.rst
+    fluid/unique_name.rst
     fluid/WeightNormParamAttr.rst
diff --git a/doc/fluid/api/fluid/DistMultiTrainer.rst b/doc/fluid/api/fluid/DistMultiTrainer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/HashName.rst b/doc/fluid/api/fluid/HashName.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/MultiTrainer.rst b/doc/fluid/api/fluid/MultiTrainer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/PipelineTrainer.rst b/doc/fluid/api/fluid/PipelineTrainer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/RoundRobin.rst b/doc/fluid/api/fluid/RoundRobin.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/Scope.rst b/doc/fluid/api/fluid/Scope.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/TrainerDesc.rst b/doc/fluid/api/fluid/TrainerDesc.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/append_backward.rst b/doc/fluid/api/fluid/append_backward.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/backward.rst b/doc/fluid/api/fluid/backward.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/clip.rst b/doc/fluid/api/fluid/clip.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/contrib.rst b/doc/fluid/api/fluid/contrib.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/dygraph.rst b/doc/fluid/api/fluid/dygraph.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/dygraph_grad_clip.rst b/doc/fluid/api/fluid/dygraph_grad_clip.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/initializer.rst b/doc/fluid/api/fluid/initializer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/install_check.rst b/doc/fluid/api/fluid/install_check.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/io.rst b/doc/fluid/api/fluid/io.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/is_compiled_with_cuda.rst b/doc/fluid/api/fluid/is_compiled_with_cuda.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_is_compiled_with_cuda:
+
+is_compiled_with_cuda
+---------------------
+
+..  autofunction:: paddle.fluid.is_compiled_with_cuda
+    :noindex:
+
diff --git a/doc/fluid/api/fluid/layers.rst b/doc/fluid/api/fluid/layers.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/learning_rate_decay.rst b/doc/fluid/api/fluid/learning_rate_decay.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/nets.rst b/doc/fluid/api/fluid/nets.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/optimizer.rst b/doc/fluid/api/fluid/optimizer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/profiler.rst b/doc/fluid/api/fluid/profiler.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/recordio_writer.rst b/doc/fluid/api/fluid/recordio_writer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/regularizer.rst b/doc/fluid/api/fluid/regularizer.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/transpiler.rst b/doc/fluid/api/fluid/transpiler.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/fluid/unique_name.rst b/doc/fluid/api/fluid/unique_name.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/gen_doc.py b/doc/fluid/api/gen_doc.py
@@ -82,8 +82,8 @@ def print_item(self, name):
             self.print_method(name)
         else:
             self.stream.close()
-            path = os.getcwd()+"/fluid/"+name+".rst"
-            os.remove(path)
+            #path = os.getcwd()+"/fluid/"+name+".rst"
+            #os.remove(path)
 
     def print_class(self, name):
         self._print_ref_(name)

diff --git a/doc/fluid/api/index_en.rst b/doc/fluid/api/index_en.rst
@@ -5,7 +5,7 @@ API Reference
 ..  toctree::
     :maxdepth: 1
 
-
+    ../flags_en.rst
     ../api_guides/index_en.rst
     fluid.rst
     average.rst

diff --git a/doc/fluid/api/io.rst b/doc/fluid/api/io.rst
@@ -5,12 +5,25 @@ fluid.io
 ..  toctree::
     :maxdepth: 1
 
+    io/batch.rst
+    io/buffered.rst
+    io/cache.rst
+    io/chain.rst
+    io/compose.rst
+    io/ComposeNotAligned.rst
+    io/Fake.rst
+    io/firstn.rst
     io/load_inference_model.rst
     io/load_params.rst
     io/load_persistables.rst
     io/load_vars.rst
+    io/map_readers.rst
+    io/multiprocess_reader.rst
+    io/PipeReader.rst
     io/PyReader.rst
     io/save_inference_model.rst
     io/save_params.rst
     io/save_persistables.rst
     io/save_vars.rst
+    io/shuffle.rst
+    io/xmap_readers.rst
diff --git a/doc/fluid/api/io/ComposeNotAligned.rst b/doc/fluid/api/io/ComposeNotAligned.rst
@@ -0,0 +1,13 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_ComposeNotAligned:
+
+ComposeNotAligned
+-----------------
+
+..  autoclass:: paddle.fluid.io.ComposeNotAligned
+    :members:
+    :inherited-members:
+    :noindex:
+
diff --git a/doc/fluid/api/layers/Preprocessor.rst → doc/fluid/api/io/Fake.rst b/doc/fluid/api/layers/Preprocessor.rst → doc/fluid/api/io/Fake.rst
@@ -1,12 +1,12 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
-.. _api_fluid_layers_Preprocessor:
+.. _api_fluid_io_Fake:
 
-Preprocessor
-------------
+Fake
+----
 
-..  autoclass:: paddle.fluid.layers.Preprocessor
+..  autoclass:: paddle.fluid.io.Fake
     :members:
     :inherited-members:
     :noindex:

diff --git a/doc/fluid/api/io/PipeReader.rst b/doc/fluid/api/io/PipeReader.rst
@@ -0,0 +1,3 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
diff --git a/doc/fluid/api/layers/batch.rst → doc/fluid/api/io/batch.rst b/doc/fluid/api/layers/batch.rst → doc/fluid/api/io/batch.rst
@@ -1,11 +1,11 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
-.. _api_fluid_layers_batch:
+.. _api_fluid_io_batch:
 
 batch
 -----
 
-..  autofunction:: paddle.fluid.layers.batch
+..  autofunction:: paddle.fluid.io.batch
     :noindex:
 
diff --git a/doc/fluid/api/io/buffered.rst b/doc/fluid/api/io/buffered.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_buffered:
+
+buffered
+--------
+
+..  autofunction:: paddle.fluid.io.buffered
+    :noindex:
+
diff --git a/doc/fluid/api/io/cache.rst b/doc/fluid/api/io/cache.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_cache:
+
+cache
+-----
+
+..  autofunction:: paddle.fluid.io.cache
+    :noindex:
+
diff --git a/doc/fluid/api/io/chain.rst b/doc/fluid/api/io/chain.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_chain:
+
+chain
+-----
+
+..  autofunction:: paddle.fluid.io.chain
+    :noindex:
+
diff --git a/doc/fluid/api/io/compose.rst b/doc/fluid/api/io/compose.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_compose:
+
+compose
+-------
+
+..  autofunction:: paddle.fluid.io.compose
+    :noindex:
+
diff --git a/doc/fluid/api/io/firstn.rst b/doc/fluid/api/io/firstn.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_firstn:
+
+firstn
+------
+
+..  autofunction:: paddle.fluid.io.firstn
+    :noindex:
+
diff --git a/doc/fluid/api/io/map_readers.rst b/doc/fluid/api/io/map_readers.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_map_readers:
+
+map_readers
+-----------
+
+..  autofunction:: paddle.fluid.io.map_readers
+    :noindex:
+
diff --git a/doc/fluid/api/io/multiprocess_reader.rst b/doc/fluid/api/io/multiprocess_reader.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_multiprocess_reader:
+
+multiprocess_reader
+-------------------
+
+..  autofunction:: paddle.fluid.io.multiprocess_reader
+    :noindex:
+
diff --git a/doc/fluid/api/layers/shuffle.rst → doc/fluid/api/io/shuffle.rst b/doc/fluid/api/layers/shuffle.rst → doc/fluid/api/io/shuffle.rst
@@ -1,11 +1,11 @@
 ..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
     !DO NOT EDIT THIS FILE MANUALLY!
 
-.. _api_fluid_layers_shuffle:
+.. _api_fluid_io_shuffle:
 
 shuffle
 -------
 
-..  autofunction:: paddle.fluid.layers.shuffle
+..  autofunction:: paddle.fluid.io.shuffle
     :noindex:
 
diff --git a/doc/fluid/api/io/xmap_readers.rst b/doc/fluid/api/io/xmap_readers.rst
@@ -0,0 +1,11 @@
+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_fluid_io_xmap_readers:
+
+xmap_readers
+------------
+
+..  autofunction:: paddle.fluid.io.xmap_readers
+    :noindex:
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		.. THIS FILE IS GENERATED BY `gen_doc.{py\|sh}`
		!DO NOT EDIT THIS FILE MANUALLY!