diff --git a/source/api_reference/clip.rst b/source/api_reference/clip.rst index 3ba096388fc87dda3096a9030fe5749e61112c06..f198470165595373c9c320a3f3836fbd8f968da3 100644 --- a/source/api_reference/clip.rst +++ b/source/api_reference/clip.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -==== -clip -==== +========== +fluid.clip +========== ErrorClipByValue ---------------- diff --git a/source/api_reference/data_feeder.rst b/source/api_reference/data_feeder.rst index 3df5c0307ffed9d101da58b385840b115920e906..36d0cc55c5af96ca5c56f976806bc3480712e5e9 100644 --- a/source/api_reference/data_feeder.rst +++ b/source/api_reference/data_feeder.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -=========== -data_feeder -=========== +================= +fluid.data_feeder +================= DataFeeder ---------- diff --git a/source/api_reference/executor.rst b/source/api_reference/executor.rst index f67a14c49f372e67d18ec8e6f87da01109376d22..1159f95a632d53a65ed958f355842bf6f2be8327 100644 --- a/source/api_reference/executor.rst +++ b/source/api_reference/executor.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -======== -executor -======== +============== +fluid.executor +============== Executor -------- diff --git a/source/api_reference/fluid.rst b/source/api_reference/fluid.rst index 2c657de115238fba9b57c8b02af1b6d6ac926641..0bddd75490c5226581927dab1f1c518101aad2bc 100644 --- a/source/api_reference/fluid.rst +++ b/source/api_reference/fluid.rst @@ -8,283 +8,283 @@ fluid Block ----- -.. autoclass:: paddle.fluid.fluid.Block +.. autoclass:: paddle.fluid.Block :members: :noindex: Variable -------- -.. autoclass:: paddle.fluid.fluid.Variable +.. autoclass:: paddle.fluid.Variable :members: :noindex: Program ------- -.. autoclass:: paddle.fluid.fluid.Program +.. autoclass:: paddle.fluid.Program :members: :noindex: Operator -------- -.. autoclass:: paddle.fluid.fluid.Operator +.. autoclass:: paddle.fluid.Operator :members: :noindex: default_startup_program ----------------------- -.. autofunction:: paddle.fluid.fluid.default_startup_program +.. autofunction:: paddle.fluid.default_startup_program :noindex: default_main_program -------------------- -.. autofunction:: paddle.fluid.fluid.default_main_program +.. autofunction:: paddle.fluid.default_main_program :noindex: program_guard ------------- -.. autofunction:: paddle.fluid.fluid.program_guard +.. autofunction:: paddle.fluid.program_guard :noindex: switch_startup_program ---------------------- -.. autofunction:: paddle.fluid.fluid.switch_startup_program +.. autofunction:: paddle.fluid.switch_startup_program :noindex: switch_main_program ------------------- -.. autofunction:: paddle.fluid.fluid.switch_main_program +.. autofunction:: paddle.fluid.switch_main_program :noindex: get_var ------- -.. autofunction:: paddle.fluid.fluid.get_var +.. autofunction:: paddle.fluid.get_var :noindex: Executor -------- -.. autoclass:: paddle.fluid.fluid.Executor +.. autoclass:: paddle.fluid.Executor :members: :noindex: global_scope ------------ -.. autofunction:: paddle.fluid.fluid.global_scope +.. autofunction:: paddle.fluid.global_scope :noindex: scope_guard ----------- -.. autofunction:: paddle.fluid.fluid.scope_guard +.. autofunction:: paddle.fluid.scope_guard :noindex: switch_scope ------------ -.. autofunction:: paddle.fluid.fluid.switch_scope +.. autofunction:: paddle.fluid.switch_scope :noindex: fetch_var --------- -.. autofunction:: paddle.fluid.fluid.fetch_var +.. autofunction:: paddle.fluid.fetch_var :noindex: Go -- -.. autoclass:: paddle.fluid.fluid.Go +.. autoclass:: paddle.fluid.Go :members: :noindex: make_channel ------------ -.. autofunction:: paddle.fluid.fluid.make_channel +.. autofunction:: paddle.fluid.make_channel :noindex: channel_send ------------ -.. autofunction:: paddle.fluid.fluid.channel_send +.. autofunction:: paddle.fluid.channel_send :noindex: channel_recv ------------ -.. autofunction:: paddle.fluid.fluid.channel_recv +.. autofunction:: paddle.fluid.channel_recv :noindex: channel_close ------------- -.. autofunction:: paddle.fluid.fluid.channel_close +.. autofunction:: paddle.fluid.channel_close :noindex: Select ------ -.. autoclass:: paddle.fluid.fluid.Select +.. autoclass:: paddle.fluid.Select :members: :noindex: Trainer ------- -.. autoclass:: paddle.fluid.fluid.Trainer +.. autoclass:: paddle.fluid.Trainer :members: :noindex: BeginEpochEvent --------------- -.. autoclass:: paddle.fluid.fluid.BeginEpochEvent +.. autoclass:: paddle.fluid.BeginEpochEvent :members: :noindex: EndEpochEvent ------------- -.. autoclass:: paddle.fluid.fluid.EndEpochEvent +.. autoclass:: paddle.fluid.EndEpochEvent :members: :noindex: BeginStepEvent -------------- -.. autoclass:: paddle.fluid.fluid.BeginStepEvent +.. autoclass:: paddle.fluid.BeginStepEvent :members: :noindex: EndStepEvent ------------ -.. autoclass:: paddle.fluid.fluid.EndStepEvent +.. autoclass:: paddle.fluid.EndStepEvent :members: :noindex: CheckpointConfig ---------------- -.. autoclass:: paddle.fluid.fluid.CheckpointConfig +.. autoclass:: paddle.fluid.CheckpointConfig :members: :noindex: Inferencer ---------- -.. autoclass:: paddle.fluid.fluid.Inferencer +.. autoclass:: paddle.fluid.Inferencer :members: :noindex: memory_optimize --------------- -.. autofunction:: paddle.fluid.fluid.memory_optimize +.. autofunction:: paddle.fluid.memory_optimize :noindex: release_memory -------------- -.. autofunction:: paddle.fluid.fluid.release_memory +.. autofunction:: paddle.fluid.release_memory :noindex: ParallelExecutor ---------------- -.. autoclass:: paddle.fluid.fluid.ParallelExecutor +.. autoclass:: paddle.fluid.ParallelExecutor :members: :noindex: ExecutionStrategy ----------------- -.. autoclass:: paddle.fluid.fluid.ExecutionStrategy +.. autoclass:: paddle.fluid.ExecutionStrategy :members: :noindex: BuildStrategy ------------- -.. autoclass:: paddle.fluid.fluid.BuildStrategy +.. autoclass:: paddle.fluid.BuildStrategy :members: :noindex: create_lod_tensor ----------------- -.. autofunction:: paddle.fluid.fluid.create_lod_tensor +.. autofunction:: paddle.fluid.create_lod_tensor :noindex: create_random_int_lodtensor --------------------------- -.. autofunction:: paddle.fluid.fluid.create_random_int_lodtensor +.. autofunction:: paddle.fluid.create_random_int_lodtensor :noindex: LoDTensor --------- -.. autoclass:: paddle.fluid.fluid.LoDTensor +.. autoclass:: paddle.fluid.LoDTensor :members: :noindex: CPUPlace -------- -.. autoclass:: paddle.fluid.fluid.CPUPlace +.. autoclass:: paddle.fluid.CPUPlace :members: :noindex: CUDAPlace --------- -.. autoclass:: paddle.fluid.fluid.CUDAPlace +.. autoclass:: paddle.fluid.CUDAPlace :members: :noindex: CUDAPinnedPlace --------------- -.. autoclass:: paddle.fluid.fluid.CUDAPinnedPlace +.. autoclass:: paddle.fluid.CUDAPinnedPlace :members: :noindex: Tensor ------ -.. autoclass:: paddle.fluid.fluid.Tensor +.. autoclass:: paddle.fluid.Tensor :members: :noindex: ParamAttr --------- -.. autoclass:: paddle.fluid.fluid.ParamAttr +.. autoclass:: paddle.fluid.ParamAttr :members: :noindex: WeightNormParamAttr ------------------- -.. autoclass:: paddle.fluid.fluid.WeightNormParamAttr +.. autoclass:: paddle.fluid.WeightNormParamAttr :members: :noindex: DataFeeder ---------- -.. autoclass:: paddle.fluid.fluid.DataFeeder +.. autoclass:: paddle.fluid.DataFeeder :members: :noindex: diff --git a/source/api_reference/gen_doc.py b/source/api_reference/gen_doc.py index d4982d5441fead40ef8e610265692a916cb94226..529ee0de7773b43932e8a2abe628b8f8a263de26 100644 --- a/source/api_reference/gen_doc.py +++ b/source/api_reference/gen_doc.py @@ -36,7 +36,7 @@ class DocGenerator(object): if module_name is None: self.module_name = "fluid" else: - self.module_name = module_name + self.module_name = "fluid." + module_name if module_name is None: self.module = fluid else: @@ -80,7 +80,7 @@ class DocGenerator(object): def print_class(self, name): self._print_header_(name, dot='-', is_title=False) - self.stream.write('''.. autoclass:: paddle.fluid.{0}.{1} + self.stream.write('''.. autoclass:: paddle.{0}.{1} :members: :noindex: @@ -88,7 +88,7 @@ class DocGenerator(object): def print_method(self, name): self._print_header_(name, dot='-', is_title=False) - self.stream.write('''.. autofunction:: paddle.fluid.{0}.{1} + self.stream.write('''.. autofunction:: paddle.{0}.{1} :noindex: '''.format(self.module_name, name)) diff --git a/source/api_reference/initializer.rst b/source/api_reference/initializer.rst index c49a98c744cdf907630ea8c74791ff2021d996e8..f5ae96a9631b208cec975971ed4787907a23b20b 100644 --- a/source/api_reference/initializer.rst +++ b/source/api_reference/initializer.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -=========== -initializer -=========== +================= +fluid.initializer +================= Constant -------- diff --git a/source/api_reference/io.rst b/source/api_reference/io.rst index 21334c9edaada4398ec53455e31625d29f67dc54..7f0e3f9db2ea257b2e144ce725c15cd94e268a81 100644 --- a/source/api_reference/io.rst +++ b/source/api_reference/io.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -== -io -== +======== +fluid.io +======== save_vars --------- diff --git a/source/api_reference/layers.rst b/source/api_reference/layers.rst index 67efa97d069356bb70475d89ca75a1afb68871df..308e08eeea43548d03aa069daf705ad79e5d4b50 100644 --- a/source/api_reference/layers.rst +++ b/source/api_reference/layers.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -====== -layers -====== +============ +fluid.layers +============ control_flow ============ diff --git a/source/api_reference/metrics.rst b/source/api_reference/metrics.rst index ddf07775d7ea293acd421b8549d03b277ff0611d..a5779bf8f44ce941b4a2ec1d96fb1054c379fe69 100644 --- a/source/api_reference/metrics.rst +++ b/source/api_reference/metrics.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -======= -metrics -======= +============= +fluid.metrics +============= MetricBase ---------- diff --git a/source/api_reference/nets.rst b/source/api_reference/nets.rst index 7ae3187304f386a08c5cb8a4ba093423a58a7f36..50f47e078873064ffa80eee62c62cd6855d9cf0a 100644 --- a/source/api_reference/nets.rst +++ b/source/api_reference/nets.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -==== -nets -==== +========== +fluid.nets +========== simple_img_conv_pool -------------------- diff --git a/source/api_reference/optimizer.rst b/source/api_reference/optimizer.rst index 6ad44bb6905b6e3f2b6e4aeb3701ced5d18e2005..aca2aed4ff21f8347919ebdd54c2ce04d6be5467 100644 --- a/source/api_reference/optimizer.rst +++ b/source/api_reference/optimizer.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -========= -optimizer -========= +=============== +fluid.optimizer +=============== SGD --- diff --git a/source/api_reference/param_attr.rst b/source/api_reference/param_attr.rst index 8e4ddb2b0492d0fcfcade199fdd6dfe43faa7075..b446e3a2c3c367d52a116e2a7a9cde2bc5e8db11 100644 --- a/source/api_reference/param_attr.rst +++ b/source/api_reference/param_attr.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -========== -param_attr -========== +================ +fluid.param_attr +================ ParamAttr --------- diff --git a/source/api_reference/profiler.rst b/source/api_reference/profiler.rst index 39fda65863471a78895503184848a754828b71a1..5b9a0de22e2179a292d70258b1a46247c8ce25df 100644 --- a/source/api_reference/profiler.rst +++ b/source/api_reference/profiler.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -======== -profiler -======== +============== +fluid.profiler +============== cuda_profiler ------------- diff --git a/source/api_reference/regularizer.rst b/source/api_reference/regularizer.rst index 756bc53baa0625aef48dad0c35e7ae57421a70d0..736fe94b3b4274f9369a384f83fd9c840eac03c4 100644 --- a/source/api_reference/regularizer.rst +++ b/source/api_reference/regularizer.rst @@ -1,9 +1,9 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -=========== -regularizer -=========== +================= +fluid.regularizer +================= append_regularization_ops -------------------------