From 63f48e9a393f5a538d218d313e4aa87f63ba96d9 Mon Sep 17 00:00:00 2001 From: Zeng Jinle <32832641+sneaxiy@users.noreply.github.com> Date: Thu, 27 Jun 2019 19:55:07 +0800 Subject: [PATCH] add parent method in doc,test=develop (#904) --- doc/fluid/api/average.rst | 1 + doc/fluid/api/backward.rst | 8 +++++ doc/fluid/api/clip.rst | 4 +++ doc/fluid/api/data_feeder.rst | 1 + doc/fluid/api/dataset.rst | 3 ++ doc/fluid/api/executor.rst | 1 + doc/fluid/api/fluid.rst | 26 +++++++++++++++ doc/fluid/api/gen_doc.py | 1 + doc/fluid/api/gen_index.py | 7 ++-- doc/fluid/api/initializer.rst | 15 +++++++++ doc/fluid/api/io.rst | 1 + doc/fluid/api/layers/control_flow.rst | 5 +++ doc/fluid/api/layers/detection.rst | 32 ++++++++++++++----- doc/fluid/api/layers/io.rst | 1 + doc/fluid/api/layers/nn.rst | 2 ++ .../api/layers/nn/deformable_roi_pooling.rst | 11 +++++++ doc/fluid/api/layers/nn/unfold.rst | 11 +++++++ doc/fluid/api/metrics.rst | 9 ++++++ doc/fluid/api/optimizer.rst | 32 +++++++++++++++++++ doc/fluid/api/regularizer.rst | 4 +++ doc/fluid/api/transpiler.rst | 4 +++ 21 files changed, 168 insertions(+), 11 deletions(-) create mode 100644 doc/fluid/api/layers/nn/deformable_roi_pooling.rst create mode 100644 doc/fluid/api/layers/nn/unfold.rst diff --git a/doc/fluid/api/average.rst b/doc/fluid/api/average.rst index 496f5b298..943dd8297 100644 --- a/doc/fluid/api/average.rst +++ b/doc/fluid/api/average.rst @@ -12,5 +12,6 @@ WeightedAverage .. autoclass:: paddle.fluid.average.WeightedAverage :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/backward.rst b/doc/fluid/api/backward.rst index 007639454..e422f9977 100644 --- a/doc/fluid/api/backward.rst +++ b/doc/fluid/api/backward.rst @@ -13,3 +13,11 @@ append_backward .. autofunction:: paddle.fluid.backward.append_backward :noindex: +.. _api_fluid_backward_gradients: + +gradients +--------- + +.. autofunction:: paddle.fluid.backward.gradients + :noindex: + diff --git a/doc/fluid/api/clip.rst b/doc/fluid/api/clip.rst index 8597d40ca..1e4a1e718 100644 --- a/doc/fluid/api/clip.rst +++ b/doc/fluid/api/clip.rst @@ -12,6 +12,7 @@ ErrorClipByValue .. autoclass:: paddle.fluid.clip.ErrorClipByValue :members: + :inherited-members: :noindex: .. _api_fluid_clip_GradientClipByGlobalNorm: @@ -21,6 +22,7 @@ GradientClipByGlobalNorm .. autoclass:: paddle.fluid.clip.GradientClipByGlobalNorm :members: + :inherited-members: :noindex: .. _api_fluid_clip_GradientClipByNorm: @@ -30,6 +32,7 @@ GradientClipByNorm .. autoclass:: paddle.fluid.clip.GradientClipByNorm :members: + :inherited-members: :noindex: .. _api_fluid_clip_GradientClipByValue: @@ -39,5 +42,6 @@ GradientClipByValue .. autoclass:: paddle.fluid.clip.GradientClipByValue :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/data_feeder.rst b/doc/fluid/api/data_feeder.rst index 11d2890f5..83547366f 100644 --- a/doc/fluid/api/data_feeder.rst +++ b/doc/fluid/api/data_feeder.rst @@ -12,5 +12,6 @@ DataFeeder .. autoclass:: paddle.fluid.data_feeder.DataFeeder :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/dataset.rst b/doc/fluid/api/dataset.rst index d4404597e..73cf601b8 100644 --- a/doc/fluid/api/dataset.rst +++ b/doc/fluid/api/dataset.rst @@ -12,6 +12,7 @@ DatasetFactory .. autoclass:: paddle.fluid.dataset.DatasetFactory :members: + :inherited-members: :noindex: .. _api_fluid_dataset_InMemoryDataset: @@ -21,6 +22,7 @@ InMemoryDataset .. autoclass:: paddle.fluid.dataset.InMemoryDataset :members: + :inherited-members: :noindex: .. _api_fluid_dataset_QueueDataset: @@ -30,5 +32,6 @@ QueueDataset .. autoclass:: paddle.fluid.dataset.QueueDataset :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/executor.rst b/doc/fluid/api/executor.rst index 82e8a8f82..4b4bc5aa9 100644 --- a/doc/fluid/api/executor.rst +++ b/doc/fluid/api/executor.rst @@ -12,6 +12,7 @@ Executor .. autoclass:: paddle.fluid.executor.Executor :members: + :inherited-members: :noindex: .. _api_fluid_executor_global_scope: diff --git a/doc/fluid/api/fluid.rst b/doc/fluid/api/fluid.rst index 4b1d0cc60..a27cc729d 100644 --- a/doc/fluid/api/fluid.rst +++ b/doc/fluid/api/fluid.rst @@ -12,6 +12,7 @@ BuildStrategy .. autoclass:: paddle.fluid.BuildStrategy :members: + :inherited-members: :noindex: .. _api_fluid_CompiledProgram: @@ -21,6 +22,7 @@ CompiledProgram .. autoclass:: paddle.fluid.CompiledProgram :members: + :inherited-members: :noindex: .. _api_fluid_cpu_places: @@ -38,6 +40,7 @@ CPUPlace .. autoclass:: paddle.fluid.CPUPlace :members: + :inherited-members: :noindex: .. _api_fluid_create_lod_tensor: @@ -79,6 +82,7 @@ CUDAPinnedPlace .. autoclass:: paddle.fluid.CUDAPinnedPlace :members: + :inherited-members: :noindex: .. _api_fluid_CUDAPlace: @@ -88,6 +92,7 @@ CUDAPlace .. autoclass:: paddle.fluid.CUDAPlace :members: + :inherited-members: :noindex: .. _api_fluid_DataFeedDesc: @@ -97,6 +102,7 @@ DataFeedDesc .. autoclass:: paddle.fluid.DataFeedDesc :members: + :inherited-members: :noindex: .. _api_fluid_DataFeeder: @@ -106,6 +112,7 @@ DataFeeder .. autoclass:: paddle.fluid.DataFeeder :members: + :inherited-members: :noindex: .. _api_fluid_default_main_program: @@ -131,6 +138,7 @@ DistributeTranspiler .. autoclass:: paddle.fluid.DistributeTranspiler :members: + :inherited-members: :noindex: .. _api_fluid_DistributeTranspilerConfig: @@ -140,6 +148,7 @@ DistributeTranspilerConfig .. autoclass:: paddle.fluid.DistributeTranspilerConfig :members: + :inherited-members: :noindex: .. _api_fluid_ExecutionStrategy: @@ -149,6 +158,7 @@ ExecutionStrategy .. autoclass:: paddle.fluid.ExecutionStrategy :members: + :inherited-members: :noindex: .. _api_fluid_Executor: @@ -158,6 +168,7 @@ Executor .. autoclass:: paddle.fluid.Executor :members: + :inherited-members: :noindex: .. _api_fluid_global_scope: @@ -168,6 +179,14 @@ global_scope .. autofunction:: paddle.fluid.global_scope :noindex: +.. _api_fluid_gradients: + +gradients +--------- + +.. autofunction:: paddle.fluid.gradients + :noindex: + .. _api_fluid_in_dygraph_mode: in_dygraph_mode @@ -183,6 +202,7 @@ LoDTensor .. autoclass:: paddle.fluid.LoDTensor :members: + :inherited-members: :noindex: .. _api_fluid_LoDTensorArray: @@ -192,6 +212,7 @@ LoDTensorArray .. autoclass:: paddle.fluid.LoDTensorArray :members: + :inherited-members: :noindex: .. _api_fluid_memory_optimize: @@ -217,6 +238,7 @@ ParallelExecutor .. autoclass:: paddle.fluid.ParallelExecutor :members: + :inherited-members: :noindex: .. _api_fluid_ParamAttr: @@ -226,6 +248,7 @@ ParamAttr .. autoclass:: paddle.fluid.ParamAttr :members: + :inherited-members: :noindex: .. _api_fluid_Program: @@ -235,6 +258,7 @@ Program .. autoclass:: paddle.fluid.Program :members: + :inherited-members: :noindex: .. _api_fluid_program_guard: @@ -268,6 +292,7 @@ Tensor .. autoclass:: paddle.fluid.Tensor :members: + :inherited-members: :noindex: .. _api_fluid_WeightNormParamAttr: @@ -277,5 +302,6 @@ WeightNormParamAttr .. autoclass:: paddle.fluid.WeightNormParamAttr :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/gen_doc.py b/doc/fluid/api/gen_doc.py index f0d2bf696..981396a8e 100644 --- a/doc/fluid/api/gen_doc.py +++ b/doc/fluid/api/gen_doc.py @@ -91,6 +91,7 @@ class DocGenerator(object): self._print_header_(name, dot='-', is_title=False) self.stream.write('''.. autoclass:: paddle.{0}.{1} :members: + :inherited-members: :noindex: '''.format(self.module_prefix, name)) diff --git a/doc/fluid/api/gen_index.py b/doc/fluid/api/gen_index.py index 07a8c032d..27ce81e9c 100644 --- a/doc/fluid/api/gen_index.py +++ b/doc/fluid/api/gen_index.py @@ -13,10 +13,11 @@ API Reference .. toctree:: :maxdepth: 1 + ../flags_en.rst + ../api_guides/index_en.rst + fluid.rst ''') - file_object.write(' ../api_guides/index_en.rst'+'\n') - file_object.write(' fluid.rst'+'\n') - + target_dirs = ['.', 'data'] file_names = [] diff --git a/doc/fluid/api/initializer.rst b/doc/fluid/api/initializer.rst index 6a5ef6eb8..c3ea01223 100644 --- a/doc/fluid/api/initializer.rst +++ b/doc/fluid/api/initializer.rst @@ -12,6 +12,7 @@ Bilinear .. autoclass:: paddle.fluid.initializer.Bilinear :members: + :inherited-members: :noindex: .. _api_fluid_initializer_BilinearInitializer: @@ -21,6 +22,7 @@ BilinearInitializer .. autoclass:: paddle.fluid.initializer.BilinearInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_Constant: @@ -30,6 +32,7 @@ Constant .. autoclass:: paddle.fluid.initializer.Constant :members: + :inherited-members: :noindex: .. _api_fluid_initializer_ConstantInitializer: @@ -39,6 +42,7 @@ ConstantInitializer .. autoclass:: paddle.fluid.initializer.ConstantInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_force_init_on_cpu: @@ -64,6 +68,7 @@ MSRA .. autoclass:: paddle.fluid.initializer.MSRA :members: + :inherited-members: :noindex: .. _api_fluid_initializer_MSRAInitializer: @@ -73,6 +78,7 @@ MSRAInitializer .. autoclass:: paddle.fluid.initializer.MSRAInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_Normal: @@ -82,6 +88,7 @@ Normal .. autoclass:: paddle.fluid.initializer.Normal :members: + :inherited-members: :noindex: .. _api_fluid_initializer_NormalInitializer: @@ -91,6 +98,7 @@ NormalInitializer .. autoclass:: paddle.fluid.initializer.NormalInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_NumpyArrayInitializer: @@ -100,6 +108,7 @@ NumpyArrayInitializer .. autoclass:: paddle.fluid.initializer.NumpyArrayInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_TruncatedNormal: @@ -109,6 +118,7 @@ TruncatedNormal .. autoclass:: paddle.fluid.initializer.TruncatedNormal :members: + :inherited-members: :noindex: .. _api_fluid_initializer_TruncatedNormalInitializer: @@ -118,6 +128,7 @@ TruncatedNormalInitializer .. autoclass:: paddle.fluid.initializer.TruncatedNormalInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_Uniform: @@ -127,6 +138,7 @@ Uniform .. autoclass:: paddle.fluid.initializer.Uniform :members: + :inherited-members: :noindex: .. _api_fluid_initializer_UniformInitializer: @@ -136,6 +148,7 @@ UniformInitializer .. autoclass:: paddle.fluid.initializer.UniformInitializer :members: + :inherited-members: :noindex: .. _api_fluid_initializer_Xavier: @@ -145,6 +158,7 @@ Xavier .. autoclass:: paddle.fluid.initializer.Xavier :members: + :inherited-members: :noindex: .. _api_fluid_initializer_XavierInitializer: @@ -154,5 +168,6 @@ XavierInitializer .. autoclass:: paddle.fluid.initializer.XavierInitializer :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/io.rst b/doc/fluid/api/io.rst index df548a49e..e5e132e88 100644 --- a/doc/fluid/api/io.rst +++ b/doc/fluid/api/io.rst @@ -44,6 +44,7 @@ PyReader .. autoclass:: paddle.fluid.io.PyReader :members: + :inherited-members: :noindex: .. _api_fluid_io_save_inference_model: diff --git a/doc/fluid/api/layers/control_flow.rst b/doc/fluid/api/layers/control_flow.rst index 69dfcd676..7d8e4d41a 100644 --- a/doc/fluid/api/layers/control_flow.rst +++ b/doc/fluid/api/layers/control_flow.rst @@ -44,6 +44,7 @@ DynamicRNN .. autoclass:: paddle.fluid.layers.DynamicRNN :members: + :inherited-members: :noindex: .. _api_fluid_layers_equal: @@ -77,6 +78,7 @@ IfElse .. autoclass:: paddle.fluid.layers.IfElse :members: + :inherited-members: :noindex: .. _api_fluid_layers_increment: @@ -142,6 +144,7 @@ StaticRNN .. autoclass:: paddle.fluid.layers.StaticRNN :members: + :inherited-members: :noindex: .. _api_fluid_layers_Switch: @@ -151,6 +154,7 @@ Switch .. autoclass:: paddle.fluid.layers.Switch :members: + :inherited-members: :noindex: .. _api_fluid_layers_While: @@ -160,5 +164,6 @@ While .. autoclass:: paddle.fluid.layers.While :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/layers/detection.rst b/doc/fluid/api/layers/detection.rst index b70cd75ce..adb31c095 100644 --- a/doc/fluid/api/layers/detection.rst +++ b/doc/fluid/api/layers/detection.rst @@ -61,14 +61,6 @@ density_prior_box .. autofunction:: paddle.fluid.layers.density_prior_box :noindex: -.. _api_fluid_layers_detection_map: - -detection_map -------------- - -.. autofunction:: paddle.fluid.layers.detection_map - :noindex: - .. _api_fluid_layers_detection_output: detection_output @@ -149,6 +141,22 @@ prior_box .. autofunction:: paddle.fluid.layers.prior_box :noindex: +.. _api_fluid_layers_retinanet_detection_output: + +retinanet_detection_output +-------------------------- + +.. autofunction:: paddle.fluid.layers.retinanet_detection_output + :noindex: + +.. _api_fluid_layers_retinanet_target_assign: + +retinanet_target_assign +----------------------- + +.. autofunction:: paddle.fluid.layers.retinanet_target_assign + :noindex: + .. _api_fluid_layers_roi_perspective_transform: roi_perspective_transform @@ -165,6 +173,14 @@ rpn_target_assign .. autofunction:: paddle.fluid.layers.rpn_target_assign :noindex: +.. _api_fluid_layers_sigmoid_focal_loss: + +sigmoid_focal_loss +------------------ + +.. autofunction:: paddle.fluid.layers.sigmoid_focal_loss + :noindex: + .. _api_fluid_layers_ssd_loss: ssd_loss diff --git a/doc/fluid/api/layers/io.rst b/doc/fluid/api/layers/io.rst index 23d7859fb..beb2f4a24 100644 --- a/doc/fluid/api/layers/io.rst +++ b/doc/fluid/api/layers/io.rst @@ -60,6 +60,7 @@ Preprocessor .. autoclass:: paddle.fluid.layers.Preprocessor :members: + :inherited-members: :noindex: .. _api_fluid_layers_py_reader: diff --git a/doc/fluid/api/layers/nn.rst b/doc/fluid/api/layers/nn.rst index 5f99980fe..9475a3352 100644 --- a/doc/fluid/api/layers/nn.rst +++ b/doc/fluid/api/layers/nn.rst @@ -32,6 +32,7 @@ nn nn/ctc_greedy_decoder.rst nn/data_norm.rst nn/deformable_conv.rst + nn/deformable_roi_pooling.rst nn/dice_loss.rst nn/dropout.rst nn/dynamic_gru.rst @@ -167,6 +168,7 @@ nn nn/topk.rst nn/transpose.rst nn/tree_conv.rst + nn/unfold.rst nn/uniform_random_batch_size_like.rst nn/unsqueeze.rst nn/unstack.rst diff --git a/doc/fluid/api/layers/nn/deformable_roi_pooling.rst b/doc/fluid/api/layers/nn/deformable_roi_pooling.rst new file mode 100644 index 000000000..41a602166 --- /dev/null +++ b/doc/fluid/api/layers/nn/deformable_roi_pooling.rst @@ -0,0 +1,11 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +.. _api_fluid_layers_deformable_roi_pooling: + +deformable_roi_pooling +---------------------- + +.. autofunction:: paddle.fluid.layers.deformable_roi_pooling + :noindex: + diff --git a/doc/fluid/api/layers/nn/unfold.rst b/doc/fluid/api/layers/nn/unfold.rst new file mode 100644 index 000000000..70f5d09bb --- /dev/null +++ b/doc/fluid/api/layers/nn/unfold.rst @@ -0,0 +1,11 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +.. _api_fluid_layers_unfold: + +unfold +------ + +.. autofunction:: paddle.fluid.layers.unfold + :noindex: + diff --git a/doc/fluid/api/metrics.rst b/doc/fluid/api/metrics.rst index 5b5f7bc3b..4536359eb 100644 --- a/doc/fluid/api/metrics.rst +++ b/doc/fluid/api/metrics.rst @@ -12,6 +12,7 @@ Accuracy .. autoclass:: paddle.fluid.metrics.Accuracy :members: + :inherited-members: :noindex: .. _api_fluid_metrics_Auc: @@ -21,6 +22,7 @@ Auc .. autoclass:: paddle.fluid.metrics.Auc :members: + :inherited-members: :noindex: .. _api_fluid_metrics_ChunkEvaluator: @@ -30,6 +32,7 @@ ChunkEvaluator .. autoclass:: paddle.fluid.metrics.ChunkEvaluator :members: + :inherited-members: :noindex: .. _api_fluid_metrics_CompositeMetric: @@ -39,6 +42,7 @@ CompositeMetric .. autoclass:: paddle.fluid.metrics.CompositeMetric :members: + :inherited-members: :noindex: .. _api_fluid_metrics_DetectionMAP: @@ -48,6 +52,7 @@ DetectionMAP .. autoclass:: paddle.fluid.metrics.DetectionMAP :members: + :inherited-members: :noindex: .. _api_fluid_metrics_EditDistance: @@ -57,6 +62,7 @@ EditDistance .. autoclass:: paddle.fluid.metrics.EditDistance :members: + :inherited-members: :noindex: .. _api_fluid_metrics_MetricBase: @@ -66,6 +72,7 @@ MetricBase .. autoclass:: paddle.fluid.metrics.MetricBase :members: + :inherited-members: :noindex: .. _api_fluid_metrics_Precision: @@ -75,6 +82,7 @@ Precision .. autoclass:: paddle.fluid.metrics.Precision :members: + :inherited-members: :noindex: .. _api_fluid_metrics_Recall: @@ -84,5 +92,6 @@ Recall .. autoclass:: paddle.fluid.metrics.Recall :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/optimizer.rst b/doc/fluid/api/optimizer.rst index bc56ea442..60bf90663 100644 --- a/doc/fluid/api/optimizer.rst +++ b/doc/fluid/api/optimizer.rst @@ -12,6 +12,7 @@ Adadelta .. autoclass:: paddle.fluid.optimizer.Adadelta :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_Adagrad: @@ -21,6 +22,7 @@ Adagrad .. autoclass:: paddle.fluid.optimizer.Adagrad :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_AdagradOptimizer: @@ -30,6 +32,7 @@ AdagradOptimizer .. autoclass:: paddle.fluid.optimizer.AdagradOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_Adam: @@ -39,6 +42,7 @@ Adam .. autoclass:: paddle.fluid.optimizer.Adam :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_Adamax: @@ -48,6 +52,7 @@ Adamax .. autoclass:: paddle.fluid.optimizer.Adamax :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_AdamaxOptimizer: @@ -57,6 +62,7 @@ AdamaxOptimizer .. autoclass:: paddle.fluid.optimizer.AdamaxOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_AdamOptimizer: @@ -66,6 +72,7 @@ AdamOptimizer .. autoclass:: paddle.fluid.optimizer.AdamOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_DecayedAdagrad: @@ -75,6 +82,7 @@ DecayedAdagrad .. autoclass:: paddle.fluid.optimizer.DecayedAdagrad :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_DecayedAdagradOptimizer: @@ -84,6 +92,7 @@ DecayedAdagradOptimizer .. autoclass:: paddle.fluid.optimizer.DecayedAdagradOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_DGCMomentumOptimizer: @@ -93,6 +102,7 @@ DGCMomentumOptimizer .. autoclass:: paddle.fluid.optimizer.DGCMomentumOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_ExponentialMovingAverage: @@ -102,6 +112,7 @@ ExponentialMovingAverage .. autoclass:: paddle.fluid.optimizer.ExponentialMovingAverage :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_Ftrl: @@ -111,6 +122,7 @@ Ftrl .. autoclass:: paddle.fluid.optimizer.Ftrl :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_FtrlOptimizer: @@ -120,6 +132,7 @@ FtrlOptimizer .. autoclass:: paddle.fluid.optimizer.FtrlOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_LambOptimizer: @@ -129,6 +142,7 @@ LambOptimizer .. autoclass:: paddle.fluid.optimizer.LambOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_LarsMomentum: @@ -138,6 +152,7 @@ LarsMomentum .. autoclass:: paddle.fluid.optimizer.LarsMomentum :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_LarsMomentumOptimizer: @@ -147,6 +162,7 @@ LarsMomentumOptimizer .. autoclass:: paddle.fluid.optimizer.LarsMomentumOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_ModelAverage: @@ -156,6 +172,7 @@ ModelAverage .. autoclass:: paddle.fluid.optimizer.ModelAverage :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_Momentum: @@ -165,6 +182,7 @@ Momentum .. autoclass:: paddle.fluid.optimizer.Momentum :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_MomentumOptimizer: @@ -174,6 +192,17 @@ MomentumOptimizer .. autoclass:: paddle.fluid.optimizer.MomentumOptimizer :members: + :inherited-members: + :noindex: + +.. _api_fluid_optimizer_PipelineOptimizer: + +PipelineOptimizer +----------------- + +.. autoclass:: paddle.fluid.optimizer.PipelineOptimizer + :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_RMSPropOptimizer: @@ -183,6 +212,7 @@ RMSPropOptimizer .. autoclass:: paddle.fluid.optimizer.RMSPropOptimizer :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_SGD: @@ -192,6 +222,7 @@ SGD .. autoclass:: paddle.fluid.optimizer.SGD :members: + :inherited-members: :noindex: .. _api_fluid_optimizer_SGDOptimizer: @@ -201,5 +232,6 @@ SGDOptimizer .. autoclass:: paddle.fluid.optimizer.SGDOptimizer :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/regularizer.rst b/doc/fluid/api/regularizer.rst index dcf69eba8..4366f5da2 100644 --- a/doc/fluid/api/regularizer.rst +++ b/doc/fluid/api/regularizer.rst @@ -12,6 +12,7 @@ L1Decay .. autoclass:: paddle.fluid.regularizer.L1Decay :members: + :inherited-members: :noindex: .. _api_fluid_regularizer_L1DecayRegularizer: @@ -21,6 +22,7 @@ L1DecayRegularizer .. autoclass:: paddle.fluid.regularizer.L1DecayRegularizer :members: + :inherited-members: :noindex: .. _api_fluid_regularizer_L2Decay: @@ -30,6 +32,7 @@ L2Decay .. autoclass:: paddle.fluid.regularizer.L2Decay :members: + :inherited-members: :noindex: .. _api_fluid_regularizer_L2DecayRegularizer: @@ -39,5 +42,6 @@ L2DecayRegularizer .. autoclass:: paddle.fluid.regularizer.L2DecayRegularizer :members: + :inherited-members: :noindex: diff --git a/doc/fluid/api/transpiler.rst b/doc/fluid/api/transpiler.rst index 7764f60de..3295cdc35 100644 --- a/doc/fluid/api/transpiler.rst +++ b/doc/fluid/api/transpiler.rst @@ -12,6 +12,7 @@ DistributeTranspiler .. autoclass:: paddle.fluid.transpiler.DistributeTranspiler :members: + :inherited-members: :noindex: .. _api_fluid_transpiler_DistributeTranspilerConfig: @@ -21,6 +22,7 @@ DistributeTranspilerConfig .. autoclass:: paddle.fluid.transpiler.DistributeTranspilerConfig :members: + :inherited-members: :noindex: .. _api_fluid_transpiler_HashName: @@ -30,6 +32,7 @@ HashName .. autoclass:: paddle.fluid.transpiler.HashName :members: + :inherited-members: :noindex: .. _api_fluid_transpiler_memory_optimize: @@ -55,5 +58,6 @@ RoundRobin .. autoclass:: paddle.fluid.transpiler.RoundRobin :members: + :inherited-members: :noindex: -- GitLab