From e7b071f33a2af3168586ef2710835b694f61e958 Mon Sep 17 00:00:00 2001
From: Luo Tao <luotao02@baidu.com>
Date: Wed, 5 Jul 2017 15:55:26 +0800
Subject: [PATCH] update annotation with comments
---
paddle/gserver/layers/AverageLayer.h | 4 ++++
paddle/gserver/layers/MaxLayer.h | 7 +++----
paddle/gserver/layers/SequenceLastInstanceLayer.cpp | 7 +++----
paddle/gserver/layers/SequencePoolLayer.h | 5 +++--
python/paddle/trainer_config_helpers/layers.py | 11 +++++++----
5 files changed, 20 insertions(+), 14 deletions(-)
diff --git a/paddle/gserver/layers/AverageLayer.h b/paddle/gserver/layers/AverageLayer.h
index 332552a304..db4a17bfb0 100644
--- a/paddle/gserver/layers/AverageLayer.h
+++ b/paddle/gserver/layers/AverageLayer.h
@@ -25,6 +25,10 @@ namespace paddle {
* If SequenceLevel = kNonSeq:
* Output: output size is the number of input sequences (NOT input instances)
* output[i] = average_{for each instance in this sequence}{input[i]}
+ * If stride_ > 0:
+ * Output: a shorten sequence. Stride is the step size by which we slide a
+ * window upon the input sequence, and the average pooling
+ * operation is then applied to each interval independently.
* If SequenceLevel = kSeq:
* Check input sequence must has sub-sequence
* Output: output size is the number of input sub-sequences
diff --git a/paddle/gserver/layers/MaxLayer.h b/paddle/gserver/layers/MaxLayer.h
index adf7ab4ae4..fa536fce2b 100644
--- a/paddle/gserver/layers/MaxLayer.h
+++ b/paddle/gserver/layers/MaxLayer.h
@@ -27,10 +27,9 @@ namespace paddle {
* Output: output size is the number of input sequences (NOT input instances)
* output[i] = max_{for each instance in this sequence}{input[i]}
* If stride_ > 0:
- * Output: a shorten sequence. The operation of getting max instance of a
- * sequence is independently performed on every slice of the input
- * sequence, which is obtained by sliding a window with the window
- * size set to stride_.
+ * Output: a shorten sequence. Stride is the step size by which we slide a
+ * window upon the input sequence, and the max pooling operation is
+ * then applied to each interval independently.
* If SequenceLevel = kSeq:
* Check input sequence must has sub-sequence
* Output: output size is the number of input sub-sequences
diff --git a/paddle/gserver/layers/SequenceLastInstanceLayer.cpp b/paddle/gserver/layers/SequenceLastInstanceLayer.cpp
index 8127cbf09c..323cc47df1 100644
--- a/paddle/gserver/layers/SequenceLastInstanceLayer.cpp
+++ b/paddle/gserver/layers/SequenceLastInstanceLayer.cpp
@@ -26,10 +26,9 @@ namespace paddle {
* If SequenceLevel = kNonseq:
* Output: a sequence containing only the last instance of the input sequence
* If stride_ > 0:
- * Output: a shorten sequence. The operation of getting last instance of a
- * sequence is independently performed on every slice of the input
- * sequence, which is obtained by sliding a window with the window
- * size set to stride_.
+ * Output: a shorten sequence. Stride is the step size by which we slide a
+ * window upon the input sequence, and getting last instance
+ * operation is then applied to each interval independently.
* If SequenceLevel = kSeq:
* Check input sequence must has sub-sequence
* Output: a sequence containing only the last instance of each sub-sequence
diff --git a/paddle/gserver/layers/SequencePoolLayer.h b/paddle/gserver/layers/SequencePoolLayer.h
index 058627def8..e207afd1dc 100644
--- a/paddle/gserver/layers/SequencePoolLayer.h
+++ b/paddle/gserver/layers/SequencePoolLayer.h
@@ -28,8 +28,9 @@ namespace paddle {
* sequence}{input[i]}
* If stride_ > 0:
* Check input sequence must not have sub-sequence
- * Output: a shorten sequence, pooling is performed upon a small local
- * area
+ * Output: a shorten sequence. Stride is the step size by which we slide
+ * a window upon the input sequence, and the pooling operation
+ * is then applied to each interval independently.
* If SequenceLevel = kSeq:
* Check input sequence must has sub-sequence
* Output: output size is the number of input sub-sequences
diff --git a/python/paddle/trainer_config_helpers/layers.py b/python/paddle/trainer_config_helpers/layers.py
index 5e8bf4b203..2f52a27e60 100755
--- a/python/paddle/trainer_config_helpers/layers.py
+++ b/python/paddle/trainer_config_helpers/layers.py
@@ -1097,7 +1097,10 @@ def pooling_layer(input,
If stride > 0, this layer slides a window whose size is determined by stride,
and return the pooling value of the window as the output. Thus, a long sequence
- will be shorten. Note that for sequence with sub-sequence, the default value
+ will be shorten.
+
+ The parameter stride specifies the intervals at which to apply the pooling
+ operation. Note that for sequence with sub-sequence, the default value
of stride is -1.
The example usage is:
@@ -1118,7 +1121,7 @@ def pooling_layer(input,
:param pooling_type: Type of pooling, MaxPooling(default), AvgPooling,
SumPooling, SquareRootNPooling.
:type pooling_type: BasePoolingType|None
- :param stride: window size.
+ :param stride: The step size between successive pooling regions.
:type stride: Int
:param bias_attr: Bias parameter attribute. False if no bias.
:type bias_attr: ParameterAttribute|None|False
@@ -1408,7 +1411,7 @@ def last_seq(input,
:type name: basestring
:param input: Input layer name.
:type input: LayerOutput
- :param stride: window size.
+ :param stride: The step size between successive pooling regions.
:type stride: Int
:param layer_attr: extra layer attributes.
:type layer_attr: ExtraLayerAttribute.
@@ -1464,7 +1467,7 @@ def first_seq(input,
:type name: basestring
:param input: Input layer name.
:type input: LayerOutput
- :param stride: window size.
+ :param stride: The step size between successive pooling regions.
:type stride: Int
:param layer_attr: extra layer attributes.
:type layer_attr: ExtraLayerAttribute.