add missing api doc of network and evaluator

8 years ago · 6c2e45537e
parent 42d64085b0
commit 6c2e45537e
12 changed files with 123 additions and 961 deletions
--- a/doc/api/v1/trainer_config_helpers/activations.rst
+++ b/doc/api/v1/trainer_config_helpers/activations.rst
@ -1,108 +0,0 @@
-===========
-Activations
-===========
-
-BaseActivation
-==============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: BaseActivation
-    :noindex:
-    
-AbsActivation
-===============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: AbsActivation
-    :noindex:
-    
-ExpActivation
-===============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: ExpActivation
-    :noindex:
-    
-IdentityActivation
-==================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: IdentityActivation
-    :noindex:
-    
-LinearActivation
-==================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: LinearActivation
-    :noindex:
-
-LogActivation
-==================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: LogActivation
-    :noindex:
-    
-SquareActivation
-================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: SquareActivation
-    :noindex:
-    
-SigmoidActivation
-=================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: SigmoidActivation
-    :noindex:
-    
-SoftmaxActivation
-=================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: SoftmaxActivation
-    :noindex:
-    
-SequenceSoftmaxActivation
-=========================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: SequenceSoftmaxActivation
-    :noindex:
-    
-ReluActivation
-==============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: ReluActivation
-    :noindex:
-    
-BReluActivation
-===============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: BReluActivation
-    :noindex:
-    
-SoftReluActivation
-==================
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: SoftReluActivation
-    :noindex:
-    
-TanhActivation
-==============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: TanhActivation
-    :noindex:
-    
-STanhActivation
-===============
-
-..  automodule:: paddle.trainer_config_helpers.activations
-    :members: STanhActivation
-    :noindex:
--- a/doc/api/v1/trainer_config_helpers/attrs.rst
+++ b/doc/api/v1/trainer_config_helpers/attrs.rst
@ -1,5 +0,0 @@
-Parameter Attributes
-=======================
-
-..  automodule:: paddle.trainer_config_helpers.attrs
-    :members:
--- a/doc/api/v1/trainer_config_helpers/data_sources.rst
+++ b/doc/api/v1/trainer_config_helpers/data_sources.rst
@ -1,7 +0,0 @@
-..  _api_trainer_config_helpers_data_sources:
-
-DataSources
-===========
-
-..  automodule:: paddle.trainer_config_helpers.data_sources
-    :members:
--- a/doc/api/v1/trainer_config_helpers/evaluators.rst
+++ b/doc/api/v1/trainer_config_helpers/evaluators.rst
@ -1,108 +0,0 @@
-..  _api_trainer_config_helpers_evaluators:
-
-==========
-Evaluators
-==========
-
-Base
-====
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: evaluator_base
-    :noindex:
-
-Classification 
-==============
-
-classification_error_evaluator
------------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: classification_error_evaluator
-    :noindex:
-
-auc_evaluator
-------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: auc_evaluator
-    :noindex:
-
-ctc_error_evaluator
-------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: ctc_error_evaluator
-    :noindex:
-
-chunk_evaluator
---------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: chunk_evaluator
-    :noindex:
-
-precision_recall_evaluator
--------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  precision_recall_evaluator
-    :noindex:
-
-Rank
-====
-
-pnpair_evaluator
----------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  pnpair_evaluator
-    :noindex:
-
-Utils
-=====
-
-sum_evaluator
-------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: sum_evaluator
-    :noindex:
-
-column_sum_evaluator
--------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members: column_sum_evaluator
-    :noindex:
-
-Print
-=====
-
-classification_error_printer_evaluator
--------------------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  classification_error_printer_evaluator
-    :noindex:
-
-gradient_printer_evaluator
--------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  gradient_printer_evaluator
-    :noindex:
-
-maxid_printer_evaluator
-----------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  maxid_printer_evaluator
-    :noindex:
-
-maxframe_printer_evaluator
---------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  maxframe_printer_evaluator
-    :noindex:
-
-seqtext_printer_evaluator
-------------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  seqtext_printer_evaluator
-    :noindex:
-
-value_printer_evaluator
-----------------------
-..  automodule:: paddle.trainer_config_helpers.evaluators
-    :members:  value_printer_evaluator
-    :noindex:
-
--- a/doc/api/v1/trainer_config_helpers/layers.rst
+++ b/doc/api/v1/trainer_config_helpers/layers.rst
--- a/doc/api/v1/trainer_config_helpers/networks.rst
+++ b/doc/api/v1/trainer_config_helpers/networks.rst
@ -1,123 +0,0 @@
-========
-Networks
-========
-
-The networks module contains pieces of neural network that combine multiple layers.
-
-NLP
-===
-
-sequence_conv_pool
------------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: sequence_conv_pool
-    :noindex:
-
-..  _api_trainer_config_helpers_network_text_conv_pool:
-
-text_conv_pool
--------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: text_conv_pool
-    :noindex:
-
-Images
-======
-
-img_conv_bn_pool
----------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: img_conv_bn_pool
-    :noindex:
-
-img_conv_group
--------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: img_conv_group
-    :noindex:
-
-..  _api_trainer_config_helpers_network_simple_img_conv_pool:
-
-simple_img_conv_pool
--------------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: simple_img_conv_pool
-    :noindex:
-
-vgg_16_network
---------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: vgg_16_network
-    :noindex:
-
-Recurrent
-=========
-
-LSTM
----
-
-lstmemory_unit
-``````````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: lstmemory_unit
-    :noindex:
-
-lstmemory_group
-```````````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: lstmemory_group
-    :noindex:
-
-simple_lstm
-```````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: simple_lstm
-    :noindex:
-
-bidirectional_lstm
-``````````````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: bidirectional_lstm
-    :noindex:
-
-GRU
---
-
-gru_unit
-````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: gru_unit
-    :noindex:
-
-gru_group
-`````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: gru_group
-    :noindex:
-
-simple_gru
-``````````
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: simple_gru
-    :noindex:
-
-simple_attention
----------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: simple_attention
-    :noindex:
-
-Miscs
-=====
-
-dropout_layer
--------------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: dropout_layer
-    :noindex:
-
-outputs
-------
-..  automodule:: paddle.trainer_config_helpers.networks
-    :members: outputs
-    :noindex:
--- a/doc/api/v1/trainer_config_helpers/optimizers.rst
+++ b/doc/api/v1/trainer_config_helpers/optimizers.rst
@ -1,61 +0,0 @@
-..  _api_trainer_config_helpers_optimizers:
-
-==========
-Optimizers
-==========
-
-BaseSGDOptimizer
-================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: BaseSGDOptimizer
-    :noindex:
-
-MomentumOptimizer
-=================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: MomentumOptimizer
-    :noindex:
-
-AdamOptimizer
-=============
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: AdamOptimizer
-    :noindex:
-
-AdamaxOptimizer
-================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: AdamaxOptimizer
-    :noindex:
-
-AdaGradOptimizer
-================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: AdaGradOptimizer
-    :noindex:
-
-DecayedAdaGradOptimizer
-=======================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: DecayedAdaGradOptimizer
-    :noindex:
-
-AdaDeltaOptimizer
-=================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: AdaDeltaOptimizer
-    :noindex:
-
-RMSPropOptimizer
-================
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: RMSPropOptimizer
-    :noindex:
-
-..  _api_trainer_config_helpers_optimizers_settings:
-
-settings
-========
-..  automodule:: paddle.trainer_config_helpers.optimizers
-    :members: settings
-    :noindex:
--- a/doc/api/v1/trainer_config_helpers/poolings.rst
+++ b/doc/api/v1/trainer_config_helpers/poolings.rst
@ -1,33 +0,0 @@
-========
-Poolings
-========
-
-BasePoolingType
-===============
-..  automodule:: paddle.trainer_config_helpers.poolings
-    :members: BasePoolingType
-    :noindex:
-
-AvgPooling
-==========
-..  automodule:: paddle.trainer_config_helpers.poolings
-    :members: AvgPooling
-    :noindex:
-
-MaxPooling
-==========
-..  automodule:: paddle.trainer_config_helpers.poolings
-    :members: MaxPooling
-    :noindex:
-
-SumPooling
-==========
-..  automodule:: paddle.trainer_config_helpers.poolings
-    :members: SumPooling
-    :noindex:
-
-SquareRootNPooling
-==================
-..  automodule:: paddle.trainer_config_helpers.poolings
-    :members: SquareRootNPooling
-    :noindex:
--- a/doc/api/v2/config/evaluators.rst
+++ b/doc/api/v2/config/evaluators.rst
@ -0,0 +1,101 @@
+..  _api_v2:
+
+==========
+Evaluators
+==========
+
+Classification 
+==============
+
+classification_error
+--------------------
+..  automodule:: paddle.v2.evaluator
+    :members: classification_error
+    :noindex:
+
+auc
+---
+..  automodule:: paddle.v2.evaluator
+    :members: auc
+    :noindex:
+
+ctc_error
+---------
+..  automodule:: paddle.v2.evaluator
+    :members: ctc_error
+    :noindex:
+
+chunk
+-----
+..  automodule:: paddle.v2.evaluator
+    :members: chunk
+    :noindex:
+
+precision_recall
+----------------
+..  automodule:: paddle.v2.evaluator
+    :members:  precision_recall
+    :noindex:
+
+Rank
+====
+
+pnpair
+------
+..  automodule:: paddle.v2.evaluator
+    :members:  pnpair
+    :noindex:
+
+Utils
+=====
+
+sum
+---
+..  automodule:: paddle.v2.evaluator
+    :members: sum
+    :noindex:
+
+column_sum
+----------
+..  automodule:: paddle.v2.evaluator
+    :members: column_sum
+    :noindex:
+
+Print
+=====
+
+classification_error_printer
+----------------------------
+..  automodule:: paddle.v2.evaluator
+    :members:  classification_error_printer
+    :noindex:
+
+gradient_printer
+----------------
+..  automodule:: paddle.v2.evaluator
+    :members:  gradient_printer
+    :noindex:
+
+maxid_printer
+-------------
+..  automodule:: paddle.v2.evaluator
+    :members:  maxid_printer
+    :noindex:
+
+maxframe_printer
+----------------
+..  automodule:: paddle.v2.evaluator
+    :members:  maxframe_printer
+    :noindex:
+
+seqtext_printer
+---------------
+..  automodule:: paddle.v2.evaluator
+    :members:  seqtext_printer
+    :noindex:
+
+value_printer
+-------------
+..  automodule:: paddle.v2.evaluator
+    :members:  value_printer
+    :noindex:
--- a/doc/api/v2/config/networks.rst
+++ b/doc/api/v2/config/networks.rst
@ -44,6 +44,12 @@ simple_img_conv_pool
    :members: simple_img_conv_pool
    :noindex:

+small_vgg
+---------
+..  automodule:: paddle.v2.networks
+    :members: small_vgg
+    :noindex:
+
 vgg_16_network
 ---------------
 ..  automodule:: paddle.v2.networks
@ -101,6 +107,18 @@ simple_gru
    :members: simple_gru
    :noindex:

+simple_gru2
+```````````
+..  automodule:: paddle.v2.networks
+    :members: simple_gru2
+    :noindex:
+
+bidirectional_gru
+``````````````````
+..  automodule:: paddle.v2.networks
+    :members: bidirectional_gru
+    :noindex:
+
 simple_attention
 ----------------
 ..  automodule:: paddle.v2.networks
--- a/doc/api/v2/model_configs.rst
+++ b/doc/api/v2/model_configs.rst
@ -6,6 +6,7 @@ Model Configuration

    config/activation.rst
    config/layer.rst
+    config/evaluators.rst
    config/optimizer.rst
    config/pooling.rst
    config/networks.rst
--- a/python/paddle/v2/inference.py
+++ b/python/paddle/v2/inference.py
@ -79,8 +79,9 @@ def infer(output_layer, parameters, input, feeding=None, field='value'):

    ..  code-block:: python

-        result = paddle.infer(prediction, parameters, input=SomeData,
-                              batch_size=32)
+        result = paddle.infer(outptut_layer=prediction, 
+                              parameters=parameters, 
+                              input=SomeData)
        print result

    :param output_layer: output of the neural network that would be inferred