From cf538c78284db8c6e9cb0fa84fd672c3a3243516 Mon Sep 17 00:00:00 2001 From: lujun Date: Fri, 28 Jun 2019 13:39:38 +0800 Subject: [PATCH] add dygraph doc 1.add dygraph api doc 2.add dygraph node --- doc/fluid/api/dygraph.rst | 347 +++++++++++++++++++++++++++++++++++++ doc/fluid/api/gen_doc.sh | 2 +- doc/fluid/api/index_en.rst | 1 + 3 files changed, 349 insertions(+), 1 deletion(-) create mode 100644 doc/fluid/api/dygraph.rst mode change 100755 => 100644 doc/fluid/api/gen_doc.sh diff --git a/doc/fluid/api/dygraph.rst b/doc/fluid/api/dygraph.rst new file mode 100644 index 000000000..d328b0582 --- /dev/null +++ b/doc/fluid/api/dygraph.rst @@ -0,0 +1,347 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +============= +fluid.dygraph +============= + +.. _api_fluid_dygraph_BackwardStrategy: + +BackwardStrategy +---------------- + +.. autoclass:: paddle.fluid.dygraph.BackwardStrategy + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_BatchNorm: + +BatchNorm +--------- + +.. autoclass:: paddle.fluid.dygraph.BatchNorm + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_BilinearTensorProduct: + +BilinearTensorProduct +--------------------- + +.. autoclass:: paddle.fluid.dygraph.BilinearTensorProduct + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Conv2D: + +Conv2D +------ + +.. autoclass:: paddle.fluid.dygraph.Conv2D + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Conv2DTranspose: + +Conv2DTranspose +--------------- + +.. autoclass:: paddle.fluid.dygraph.Conv2DTranspose + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Conv3D: + +Conv3D +------ + +.. autoclass:: paddle.fluid.dygraph.Conv3D + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Conv3DTranspose: + +Conv3DTranspose +--------------- + +.. autoclass:: paddle.fluid.dygraph.Conv3DTranspose + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_CosineDecay: + +CosineDecay +----------- + +.. autoclass:: paddle.fluid.dygraph.CosineDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Embedding: + +Embedding +--------- + +.. autoclass:: paddle.fluid.dygraph.Embedding + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_enabled: + +enabled +------- + +.. autofunction:: paddle.fluid.dygraph.enabled + :noindex: + +.. _api_fluid_dygraph_ExponentialDecay: + +ExponentialDecay +---------------- + +.. autoclass:: paddle.fluid.dygraph.ExponentialDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_FC: + +FC +-- + +.. autoclass:: paddle.fluid.dygraph.FC + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_GroupNorm: + +GroupNorm +--------- + +.. autoclass:: paddle.fluid.dygraph.GroupNorm + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_GRUUnit: + +GRUUnit +------- + +.. autoclass:: paddle.fluid.dygraph.GRUUnit + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_guard: + +guard +----- + +.. autofunction:: paddle.fluid.dygraph.guard + :noindex: + +.. _api_fluid_dygraph_InverseTimeDecay: + +InverseTimeDecay +---------------- + +.. autoclass:: paddle.fluid.dygraph.InverseTimeDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Layer: + +Layer +----- + +.. autoclass:: paddle.fluid.dygraph.Layer + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_LayerNorm: + +LayerNorm +--------- + +.. autoclass:: paddle.fluid.dygraph.LayerNorm + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_load_persistables: + +load_persistables +----------------- + +.. autofunction:: paddle.fluid.dygraph.load_persistables + :noindex: + +.. _api_fluid_dygraph_NaturalExpDecay: + +NaturalExpDecay +--------------- + +.. autoclass:: paddle.fluid.dygraph.NaturalExpDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_NCE: + +NCE +--- + +.. autoclass:: paddle.fluid.dygraph.NCE + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_no_grad: + +no_grad +------- + +.. autofunction:: paddle.fluid.dygraph.no_grad + :noindex: + +.. _api_fluid_dygraph_NoamDecay: + +NoamDecay +--------- + +.. autoclass:: paddle.fluid.dygraph.NoamDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_not_support: + +not_support +----------- + +.. autofunction:: paddle.fluid.dygraph.not_support + :noindex: + +.. _api_fluid_dygraph_PiecewiseDecay: + +PiecewiseDecay +-------------- + +.. autoclass:: paddle.fluid.dygraph.PiecewiseDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_PolynomialDecay: + +PolynomialDecay +--------------- + +.. autoclass:: paddle.fluid.dygraph.PolynomialDecay + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_Pool2D: + +Pool2D +------ + +.. autoclass:: paddle.fluid.dygraph.Pool2D + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_PRelu: + +PRelu +----- + +.. autoclass:: paddle.fluid.dygraph.PRelu + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_prepare_context: + +prepare_context +--------------- + +.. autofunction:: paddle.fluid.dygraph.prepare_context + :noindex: + +.. _api_fluid_dygraph_save_persistables: + +save_persistables +----------------- + +.. autofunction:: paddle.fluid.dygraph.save_persistables + :noindex: + +.. _api_fluid_dygraph_SpectralNorm: + +SpectralNorm +------------ + +.. autoclass:: paddle.fluid.dygraph.SpectralNorm + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_start_gperf_profiler: + +start_gperf_profiler +-------------------- + +.. autofunction:: paddle.fluid.dygraph.start_gperf_profiler + :noindex: + +.. _api_fluid_dygraph_stop_gperf_profiler: + +stop_gperf_profiler +------------------- + +.. autofunction:: paddle.fluid.dygraph.stop_gperf_profiler + :noindex: + +.. _api_fluid_dygraph_to_variable: + +to_variable +----------- + +.. autofunction:: paddle.fluid.dygraph.to_variable + :noindex: + +.. _api_fluid_dygraph_Tracer: + +Tracer +------ + +.. autoclass:: paddle.fluid.dygraph.Tracer + :members: + :inherited-members: + :noindex: + +.. _api_fluid_dygraph_TreeConv: + +TreeConv +-------- + +.. autoclass:: paddle.fluid.dygraph.TreeConv + :members: + :inherited-members: + :noindex: + diff --git a/doc/fluid/api/gen_doc.sh b/doc/fluid/api/gen_doc.sh old mode 100755 new mode 100644 index dc628236d..09926583c --- a/doc/fluid/api/gen_doc.sh +++ b/doc/fluid/api/gen_doc.sh @@ -10,7 +10,7 @@ do python gen_doc.py --module_name layers.${module} --module_prefix layers --output layers/${module}.rst done -for module in data_feeder dataset clip metrics executor initializer io nets optimizer profiler regularizer transpiler recordio_writer backward average profiler unique_name +for module in data_feeder dataset clip metrics executor initializer io nets optimizer profiler regularizer transpiler recordio_writer backward average profiler unique_name dygraph do python gen_doc.py --module_name ${module} --module_prefix ${module} --output ${module}.rst done diff --git a/doc/fluid/api/index_en.rst b/doc/fluid/api/index_en.rst index ff42a292f..1685cd0f4 100644 --- a/doc/fluid/api/index_en.rst +++ b/doc/fluid/api/index_en.rst @@ -15,6 +15,7 @@ API Reference data/dataset.rst data_feeder.rst dataset.rst + dygraph.rst executor.rst initializer.rst io.rst -- GitLab