From f8a42d5de98f83bc9703c31dc47ca05c6590341e Mon Sep 17 00:00:00 2001
From: Luo Tao <luotao02@baidu.com>
Date: Thu, 18 May 2017 16:54:32 +0800
Subject: [PATCH] add doc for AggregateLevel and ExpandLevel

---
 doc/api/v2/config/layer.rst                   | 10 ++++++
 .../paddle/trainer_config_helpers/layers.py   | 31 +++++++++++++++++++
 python/paddle/v2/layer.py                     |  4 +--
 3 files changed, 43 insertions(+), 2 deletions(-)

diff --git a/doc/api/v2/config/layer.rst b/doc/api/v2/config/layer.rst
index 154cfe24432..1efa74ecda4 100644
--- a/doc/api/v2/config/layer.rst
+++ b/doc/api/v2/config/layer.rst
@@ -207,6 +207,11 @@ trans_full_matrix_projection
 Aggregate Layers
 ================
 
+AggregateLevel
+--------------
+..  autoclass:: paddle.v2.layer.AggregateLevel
+    :noindex:
+
 ..  _api_v2.layer_pooling:
 
 pooling
@@ -248,6 +253,11 @@ block_expand
 
 ..  _api_v2.layer_expand:
 
+ExpandLevel
+-----------
+..  autoclass:: paddle.v2.layer.ExpandLevel
+    :noindex:
+
 expand
 ------
 ..  autoclass:: paddle.v2.layer.expand
diff --git a/python/paddle/trainer_config_helpers/layers.py b/python/paddle/trainer_config_helpers/layers.py
index 3b6f0270de1..cf7e54ef507 100755
--- a/python/paddle/trainer_config_helpers/layers.py
+++ b/python/paddle/trainer_config_helpers/layers.py
@@ -225,6 +225,24 @@ class LayerType(object):
 
 
 class AggregateLevel(object):
+    """
+    As PaddlePaddle supports three sequence types:
+
+    - :code:`SequenceType.NO_SEQUENCE` means the sample is not a sequence.
+    - :code:`SequenceType.SEQUENCE` means the sample is a sequence.
+    - :code:`SequenceType.SUB_SEQUENCE` means it is a nested sequence, that 
+      each timestep of the input sequence is also a sequence.
+
+    Thus, AggregateLevel supports two modes:
+
+    - :code:`AggregateLevel.EACH_TIMESTEP` means the aggregation acts on each
+      timestep of sequence, both :code:`SUB_SEQUENCE` and :code:`SEQUENCE` will
+      be aggregated to :code:`NO_SEQUENCE`.
+
+    - :code:`AggregateLevel.EACH_SEQUENCE` means the aggregation acts on each
+      sequence of a nested sequence, :code:`SUB_SEQUENCE` will be aggregated to
+      :code:`SEQUENCE`.
+    """
     EACH_TIMESTEP = 'non-seq'
     EACH_SEQUENCE = 'seq'
 
@@ -1454,6 +1472,19 @@ def first_seq(input,
 
 
 class ExpandLevel(object):
+    """
+    Please refer to AggregateLevel first.
+
+    ExpandLevel supports two modes:
+
+    - :code:`ExpandLevel.FROM_TIMESTEP` means the expandation acts on each
+      timestep of a sequence, :code:`NO_SEQUENCE` will be expanded to
+      :code:`SEQUENCE` or :code:`SUB_SEQUENCE`.
+
+    - :code:`ExpandLevel.FROM_SEQUENCE` means the expandation acts on each
+      sequence of a nested sequence, :code:`SEQUENCE` will be expanded to
+      :code:`SUB_SEQUENCE`.
+    """
     FROM_TIMESTEP = AggregateLevel.EACH_TIMESTEP
     FROM_SEQUENCE = AggregateLevel.EACH_SEQUENCE
 
diff --git a/python/paddle/v2/layer.py b/python/paddle/v2/layer.py
index 89cca7acd34..3d9caeec589 100644
--- a/python/paddle/v2/layer.py
+++ b/python/paddle/v2/layer.py
@@ -404,8 +404,8 @@ class RecurrentLayerOutput(Layer):
 LayerV2 = Layer
 data = DataLayerV2
 data.__name__ = 'data'
-AggregateLevel = conf_helps.layers.AggregateLevel
-ExpandLevel = conf_helps.layers.ExpandLevel
+AggregateLevel = conf_helps.AggregateLevel
+ExpandLevel = conf_helps.ExpandLevel
 memory = MemoryV2
 memory.__name__ = 'memory'
 memory.__doc__ = conf_helps.memory.__doc__
-- 
GitLab