Merge pull request #1590 from luotao1/doc

modify api doc catalog

Merge pull request #1590 from luotao1/doc
modify api doc catalog
362a14d7 · Tao Luo · GitHub · 8ba3df67 · 70f38075 · 362a14d7
11 changed file
--- a/doc/api/index_cn.rst
+++ b/doc/api/index_cn.rst
 API
 ===
-模型配置 API
------------
-..  toctree::
-    :maxdepth: 1
-    v2/model_configs.rst
-数据 API
--------
-..  toctree::
-    :maxdepth: 1
-    v2/data.rst
-训练 API
--------
 ..  toctree::
    :maxdepth: 1
-	v2/run_logic.rst
+    模型配置 <v2/model_configs.rst>
\ No newline at end of file
+    数据访问 <v2/data.rst>
+    训练与应用 <v2/run_logic.rst>
--- a/doc/api/index_en.rst
+++ b/doc/api/index_en.rst
 API
 ===
-Model Config API
----------------
 ..  toctree::
    :maxdepth: 1
    v2/model_configs.rst
-Data API
--------
-..  toctree::
-    :maxdepth: 1
    v2/data.rst
-Train API
---------
-..	toctree::
-	:maxdepth: 1
    v2/run_logic.rst
--- a/doc/api/v2/config/activation.rst
+++ b/doc/api/v2/config/activation.rst
+===========
+Activation
+===========
+Abs
+===
+..  automodule:: paddle.v2.activation
+    :members: Abs
+    :noindex:
+Exp
+===
+..  automodule:: paddle.v2.activation
+    :members: Exp
+    :noindex:
+Identity
+========
+..  automodule:: paddle.v2.activation
+    :members: Identity
+    :noindex:
+Linear
+======
+..  automodule:: paddle.v2.activation
+    :members: Linear
+    :noindex:
+Log
+===
+..  automodule:: paddle.v2.activation
+    :members: Log
+    :noindex:
+Square
+======
+..  automodule:: paddle.v2.activation
+    :members: Square
+    :noindex:
+Sigmoid
+=======
+..  automodule:: paddle.v2.activation
+    :members: Sigmoid
+    :noindex:
+Softmax
+=======
+..  automodule:: paddle.v2.activation
+    :members: Softmax
+    :noindex:
+SequenceSoftmax
+===============
+..  automodule:: paddle.v2.activation
+    :members: SequenceSoftmax
+    :noindex:
+Relu
+====
+..  automodule:: paddle.v2.activation
+    :members: Relu
+    :noindex:
+BRelu
+=====
+..  automodule:: paddle.v2.activation
+    :members: BRelu
+    :noindex:
+SoftRelu
+========
+..  automodule:: paddle.v2.activation
+    :members: SoftRelu
+    :noindex:
+Tanh
+====
+..  automodule:: paddle.v2.activation
+    :members: Tanh
+    :noindex:
+STanh
+=====
+..  automodule:: paddle.v2.activation
+    :members: STanh
+    :noindex:
--- a/doc/api/v2/config/attr.rst
+++ b/doc/api/v2/config/attr.rst
+Parameter Attribute
+===================
+..  automodule:: paddle.v2.attr
+    :members:
+    :noindex:
--- a/doc/api/v2/config/layer.rst
+++ b/doc/api/v2/config/layer.rst
+..  _api_v2.layer:
+======
+Layers
+======
+Data layer
+===========
+..  _api_v2.layer_data:
+data
+----
+..  automodule:: paddle.v2.layer
+    :members: data
+    :noindex:
+Fully Connected Layers
+======================
+..  _api_v2.layer_fc:
+fc
+--
+..  automodule:: paddle.v2.layer
+    :members: fc
+    :noindex:
+selective_fc
+------------
+..  automodule:: paddle.v2.layer
+    :members: selective_fc
+    :noindex:
+Conv Layers
+===========
+conv_operator
+-------------
+..  automodule:: paddle.v2.layer
+    :members: conv_operator
+    :noindex:
+conv_projection
+---------------
+..  automodule:: paddle.v2.layer
+    :members: conv_projection
+    :noindex:
+conv_shift
+----------
+..  automodule:: paddle.v2.layer
+    :members: conv_shift
+    :noindex:
+img_conv
+--------
+..  automodule:: paddle.v2.layer
+    :members: img_conv
+    :noindex:
+..  _api_v2.layer_context_projection:
+context_projection 
+------------------
+..  automodule:: paddle.v2.layer
+    :members: context_projection
+    :noindex:
+Image Pooling Layer
+===================
+img_pool
+--------
+..  automodule:: paddle.v2.layer
+    :members: img_pool
+    :noindex:   
+spp
+---
+..  automodule:: paddle.v2.layer
+    :members: spp
+    :noindex:
+maxout
+------
+..  automodule:: paddle.v2.layer
+    :members: maxout
+    :noindex:
+Norm Layer
+==========
+img_cmrnorm
+-----------
+..  automodule:: paddle.v2.layer
+    :members: img_cmrnorm
+    :noindex:
+batch_norm
+----------
+..  automodule:: paddle.v2.layer
+    :members: batch_norm
+    :noindex:
+sum_to_one_norm
+---------------
+..  automodule:: paddle.v2.layer
+    :members: sum_to_one_norm
+    :noindex:
+Recurrent Layers
+================
+recurrent
+---------
+..  automodule:: paddle.v2.layer
+    :members: recurrent
+    :noindex:
+lstmemory
+---------
+..  automodule:: paddle.v2.layer
+    :members: lstmemory
+    :noindex:
+grumemory
+---------
+..  automodule:: paddle.v2.layer
+    :members: grumemory
+    :noindex:
+Recurrent Layer Group
+=====================
+memory
+------
+..  automodule:: paddle.v2.layer
+    :members: memory
+    :noindex:
+recurrent_group
+---------------
+..  automodule:: paddle.v2.layer
+    :members: recurrent_group
+    :noindex:
+lstm_step
+---------
+..  automodule:: paddle.v2.layer
+    :members: lstm_step
+    :noindex:
+gru_step
+--------
+..  automodule:: paddle.v2.layer
+    :members: gru_step
+    :noindex:
+beam_search
+------------
+..  automodule:: paddle.v2.layer
+    :members: beam_search
+    :noindex:
+get_output
+----------
+..  automodule:: paddle.v2.layer
+    :members: get_output
+    :noindex:
+Mixed Layer
+===========
+..  _api_v2.layer_mixed:
+mixed
+-----
+..  automodule:: paddle.v2.layer
+    :members: mixed
+    :noindex:
+..  _api_v2.layer_embedding:
+embedding
+---------
+..  automodule:: paddle.v2.layer
+    :members: embedding
+    :noindex:
+scaling_projection
+------------------
+..  automodule:: paddle.v2.layer
+    :members: scaling_projection
+    :noindex:
+dotmul_projection
+-----------------
+..  automodule:: paddle.v2.layer
+    :members: dotmul_projection
+    :noindex:
+dotmul_operator
+---------------
+..  automodule:: paddle.v2.layer
+    :members: dotmul_operator
+    :noindex:
+full_matrix_projection
+----------------------
+..  automodule:: paddle.v2.layer
+    :members: full_matrix_projection
+    :noindex:
+identity_projection
+-------------------
+..  automodule:: paddle.v2.layer
+    :members: identity_projection
+    :noindex:
+table_projection
+----------------
+..  automodule:: paddle.v2.layer
+    :members: table_projection
+    :noindex:
+trans_full_matrix_projection
+----------------------------
+..  automodule:: paddle.v2.layer
+    :members: trans_full_matrix_projection
+    :noindex:
+Aggregate Layers
+================
+..  _api_v2.layer_pooling:
+pooling
+-------
+..  automodule:: paddle.v2.layer
+    :members: pooling
+    :noindex:
+..  _api_v2.layer_last_seq:
+last_seq
+--------
+..  automodule:: paddle.v2.layer
+    :members: last_seq
+    :noindex:
+..  _api_v2.layer_first_seq:
+first_seq
+---------
+..  automodule:: paddle.v2.layer
+    :members: first_seq
+    :noindex:
+concat
+------
+..  automodule:: paddle.v2.layer
+    :members: concat
+    :noindex:
+seq_concat
+----------
+..  automodule:: paddle.v2.layer
+    :members: seq_concat
+    :noindex:
+Reshaping Layers
+================
+block_expand
+------------
+..  automodule:: paddle.v2.layer
+    :members: block_expand
+    :noindex:
+..  _api_v2.layer_expand:
+expand
+------
+..  automodule:: paddle.v2.layer
+    :members: expand
+    :noindex:
+repeat
+------
+..  automodule:: paddle.v2.layer
+    :members: repeat
+    :noindex:
+rotate
+------
+..  automodule:: paddle.v2.layer
+    :members: rotate
+    :noindex:
+seq_reshape
+-----------
+..  automodule:: paddle.v2.layer
+    :members: seq_reshape
+    :noindex:
+Math Layers
+===========
+addto
+-----
+..  automodule:: paddle.v2.layer
+    :members: addto
+    :noindex:
+linear_comb
+-----------
+..  automodule:: paddle.v2.layer
+    :members: linear_comb
+    :noindex:
+interpolation
+-------------
+..  automodule:: paddle.v2.layer
+    :members: interpolation
+    :noindex:
+bilinear_interp
+---------------
+..  automodule:: paddle.v2.layer
+    :members: bilinear_interp
+    :noindex:
+power
+-----
+..  automodule:: paddle.v2.layer
+    :members: power
+    :noindex:
+scaling
+-------
+..  automodule:: paddle.v2.layer
+    :members: scaling
+    :noindex:
+slope_intercept
+---------------
+..  automodule:: paddle.v2.layer
+    :members: slope_intercept
+    :noindex:
+tensor
+------
+..  automodule:: paddle.v2.layer
+    :members: tensor
+    :noindex:
+..  _api_v2.layer_cos_sim:
+cos_sim
+-------
+..  automodule:: paddle.v2.layer
+    :members: cos_sim
+    :noindex:
+trans
+-----
+..  automodule:: paddle.v2.layer
+    :members: trans
+    :noindex:
+Sampling Layers
+===============
+maxid
+-----
+..  automodule:: paddle.v2.layer
+    :members: maxid
+    :noindex:
+sampling_id
+-----------
+..  automodule:: paddle.v2.layer
+    :members: sampling_id
+    :noindex:
+Slicing and Joining Layers
+==========================
+pad
+----
+..  automodule:: paddle.v2.layer
+    :members: pad
+    :noindex:
+..  _api_v2.layer_costs:
+Cost Layers
+===========
+cross_entropy_cost
+------------------
+..  automodule:: paddle.v2.layer
+    :members: cross_entropy_cost
+    :noindex:
+cross_entropy_with_selfnorm_cost
+--------------------------------
+..  automodule:: paddle.v2.layer
+    :members: cross_entropy_with_selfnorm_cost
+    :noindex:
+multi_binary_label_cross_entropy_cost
+-------------------------------------
+..  automodule:: paddle.v2.layer
+    :members: multi_binary_label_cross_entropy_cost
+    :noindex:
+huber_cost
+----------
+..  automodule:: paddle.v2.layer
+    :members: huber_cost
+    :noindex:
+lambda_cost
+-----------
+..  automodule:: paddle.v2.layer
+    :members: lambda_cost
+    :noindex:
+rank_cost
+---------
+..  automodule:: paddle.v2.layer
+    :members: rank_cost
+    :noindex:
+sum_cost
+---------
+..  automodule:: paddle.v2.layer
+    :members: sum_cost
+    :noindex:
+crf
+---
+..  automodule:: paddle.v2.layer
+    :members: crf
+    :noindex:
+crf_decoding
+------------
+..  automodule:: paddle.v2.layer
+    :members: crf_decoding
+    :noindex:
+ctc
+---
+..  automodule:: paddle.v2.layer
+    :members: ctc
+    :noindex:
+warp_ctc
+--------
+..  automodule:: paddle.v2.layer
+    :members: warp_ctc
+    :noindex:
+nce
+---
+..  automodule:: paddle.v2.layer
+    :members: nce
+    :noindex:
+hsigmoid
+---------
+..  automodule:: paddle.v2.layer
+    :members: hsigmoid
+    :noindex:
+Check Layer 
+============
+eos
+---
+..  automodule:: paddle.v2.layer
+    :members: eos
+    :noindex:
--- a/doc/api/v2/config/networks.rst
+++ b/doc/api/v2/config/networks.rst
+========
+Networks
+========
+The v2.networks module contains pieces of neural network that combine multiple layers.
+NLP
+===
+sequence_conv_pool
+------------------
+..  automodule:: paddle.v2.networks
+    :members: sequence_conv_pool
+    :noindex:
+..  _api_trainer_config_helpers_network_text_conv_pool:
+text_conv_pool
+--------------
+..  automodule:: paddle.v2.networks
+    :members: text_conv_pool
+    :noindex:
+Images
+======
+img_conv_bn_pool
+----------------
+..  automodule:: paddle.v2.networks
+    :members: img_conv_bn_pool
+    :noindex:
+img_conv_group
+--------------
+..  automodule:: paddle.v2.networks
+    :members: img_conv_group
+    :noindex:
+..  _api_trainer_config_helpers_network_simple_img_conv_pool:
+simple_img_conv_pool
+--------------------
+..  automodule:: paddle.v2.networks
+    :members: simple_img_conv_pool
+    :noindex:
+vgg_16_network
+---------------
+..  automodule:: paddle.v2.networks
+    :members: vgg_16_network
+    :noindex:
+Recurrent
+=========
+LSTM
+----
+lstmemory_unit
+``````````````
+..  automodule:: paddle.v2.networks
+    :members: lstmemory_unit
+    :noindex:
+lstmemory_group
+```````````````
+..  automodule:: paddle.v2.networks
+    :members: lstmemory_group
+    :noindex:
+simple_lstm
+```````````
+..  automodule:: paddle.v2.networks
+    :members: simple_lstm
+    :noindex:
+bidirectional_lstm
+``````````````````
+..  automodule:: paddle.v2.networks
+    :members: bidirectional_lstm
+    :noindex:
+GRU
+---
+gru_unit
+````````
+..  automodule:: paddle.v2.networks
+    :members: gru_unit
+    :noindex:
+gru_group
+`````````
+..  automodule:: paddle.v2.networks
+    :members: gru_group
+    :noindex:
+simple_gru
+``````````
+..  automodule:: paddle.v2.networks
+    :members: simple_gru
+    :noindex:
+simple_attention
+----------------
+..  automodule:: paddle.v2.networks
+    :members: simple_attention
+    :noindex:
+Miscs
+=====
+dropout_layer
+--------------
+..  automodule:: paddle.v2.networks
+    :members: dropout_layer
+    :noindex:
--- a/doc/api/v2/config/optimizer.rst
+++ b/doc/api/v2/config/optimizer.rst
+..  _api_v2.optimizer:
+==========
+Optimizer
+==========
+Momentum
+========
+..  automodule:: paddle.v2.optimizer
+    :members: Momentum
+    :noindex:
+Adam
+====
+..  automodule:: paddle.v2.optimizer
+    :members: Adam
+    :noindex:
+Adamax
+======
+..  automodule:: paddle.v2.optimizer
+    :members: Adamax
+    :noindex:
+AdaGrad
+=======
+..  automodule:: paddle.v2.optimizer
+    :members: AdaGrad
+    :noindex:
+DecayedAdaGrad
+==============
+..  automodule:: paddle.v2.optimizer
+    :members: DecayedAdaGrad
+    :noindex:
+AdaDelta
+========
+..  automodule:: paddle.v2.optimizer
+    :members: AdaDelta
+    :noindex:
+RMSProp
+=======
+..  automodule:: paddle.v2.optimizer
+    :members: RMSProp
+    :noindex:
--- a/doc/api/v2/config/pooling.rst
+++ b/doc/api/v2/config/pooling.rst
+=======
+Pooling
+=======
+BasePool
+========
+..  automodule:: paddle.v2.pooling
+    :members: BasePool
+    :noindex:
+Avg
+===
+..  automodule:: paddle.v2.pooling
+    :members: Avg
+    :noindex:
+Max
+===
+..  automodule:: paddle.v2.pooling
+    :members: Max
+    :noindex:
+Sum
+===
+..  automodule:: paddle.v2.pooling
+    :members: Sum
+    :noindex:
+SquareRootN
+===========
+..  automodule:: paddle.v2.pooling
+    :members: SquareRootN
+    :noindex:
+CudnnAvg
+========
+..  automodule:: paddle.v2.pooling
+    :members: CudnnAvg
+    :noindex:
+CudnnMax
+========
+..  automodule:: paddle.v2.pooling
+    :members: CudnnMax
+    :noindex:
--- a/doc/api/v2/data.rst
+++ b/doc/api/v2/data.rst
-================
+========
-Data Related API
+Datasets
-================
+========
-#########
 DataTypes
-#########
+=========
 ..  automodule:: paddle.v2.data_type
    :members:
+    :noindex:
-##########
 DataFeeder
-##########
+==========
 ..  automodule:: paddle.v2.data_feeder
    :members:
+    :noindex:
-######
 Reader
-######
+======
 ..  automodule:: paddle.v2.reader
    :members:
+    :noindex:
 ..  automodule:: paddle.v2.reader.creator
    :members:
+    :noindex:
-#########
 minibatch
-#########
+=========
 ..  automodule:: paddle.v2.minibatch
    :members:
+    :noindex:
-#######
 Dataset
-#######
+=======
 ..  automodule:: paddle.v2.dataset
    :members:
+    :noindex:
 mnist
 +++++
 ..  automodule:: paddle.v2.dataset.mnist
    :members:
+    :noindex:
 cifar
@@ -54,40 +55,54 @@ cifar
 ..  automodule:: paddle.v2.dataset.cifar
    :members:
+    :noindex:
 conll05
 +++++++
 ..  automodule:: paddle.v2.dataset.conll05
    :members:
+    :noindex:
 imdb
 ++++
 ..  automodule:: paddle.v2.dataset.imdb
    :members:
+    :noindex:
 imikolov
 ++++++++
 ..  automodule:: paddle.v2.dataset.imikolov
    :members:
+    :noindex:
 movielens
 +++++++++
 ..  automodule:: paddle.v2.dataset.movielens
    :members:
+    :noindex:
 sentiment
 +++++++++
 ..  automodule:: paddle.v2.dataset.sentiment
    :members:
+    :noindex:
 uci_housing
 +++++++++++
 ..  automodule:: paddle.v2.dataset.uci_housing
    :members:
+    :noindex:
+wmt14
+++++
+..  automodule:: paddle.v2.dataset.uci_housing
+    :members:
+    :noindex:
--- a/doc/api/v2/model_configs.rst
+++ b/doc/api/v2/model_configs.rst
-#########################
+Model Configuration
-Configuration Related API
+===================
-#########################
+..  toctree::
-======
+    :maxdepth: 1
-Layers
-======
+    config/activation.rst
+    config/layer.rst
-..  automodule:: paddle.v2.layer
+    config/optimizer.rst
-    :members:
+    config/pooling.rst
+    config/networks.rst
+    config/attr.rst
-==========
-Attributes
-==========
-..	automodule:: paddle.v2.attr
-	:members:
-===========
-Activations
-===========
-..	automodule:: paddle.v2.activation
-	:members:
-========
-Poolings
-========
-..	automodule:: paddle.v2.pooling
-	:members:
-========
-Networks
-========
-..	automodule:: paddle.v2.networks
-	:members:
-==========
-Optimizers
-==========
-..	automodule:: paddle.v2.optimizer
-	:members:
--- a/doc/api/v2/run_logic.rst
+++ b/doc/api/v2/run_logic.rst
-###########
+======================
-Trainer API
+Training and Inference
-###########
+======================
-==========
 Parameters
 ==========
 ..  automodule:: paddle.v2.parameters
-    :members:
+    :noindex:
-=======
 Trainer
 =======
 ..  automodule:: paddle.v2.trainer
-	:members:
+    :noindex:
-=====
 Event
 =====
 ..  automodule:: paddle.v2.event
-	:members:
+    :noindex:
-=========
 Inference
 =========
 ..  autofunction:: paddle.v2.infer
+    :noindex: