API guide to sequences

doc/fluid/api_guides/low_level/layers/sequence.rst

+..  _api_guide_sequence:
+
+########
+Sequence
+########
+
+在深度学习领域许多问题涉及到对`序列 <https://en.wikipedia.org/wiki/Sequence>`_ 的处理。
+从Wiki上的释义可知，序列可以表征多种物理意义，但在深度学习中，最常见的仍然是"时间序列"——一个序列包含多个时间步的信息。
+在Paddle Fluid中，我们将序列表示为`LoDTensor<http://www.paddlepaddle.org/documentation/api/zh/1.0/fluid.html#lodtensor>`_ ，
+对这类tensor第0维的操作不能简单地使用一般的layer来进行。因此为了实行各类针对序列的操作，我们设计了一系列序列相关的API，专门用于正确处理序列相关的操作。
+实践中，这些layer处理的通常不会是单个序列，而往往是一个mini batch的序列，因为一般进行神经网络计算时都是一个batch一个batch地计算。
+一个mini batch中不同的序列通常属于多个sample，它们彼此之间不会也不应该发生跨sample的计算。
+因此，若一个layer以两个（或多个）mini batch的序列为输入（或者以一个list的序列为输入），则第一个batch中的第一个序列只会和第二个batch中的第二个序列发生计算，
+第一个batch中的第二个序列只会和第二个batch中的第二个序列发生计算，依次类推。
+理解这一点对于理解接下来序列相关的操作会至关重要。
+
+1. sequence_softmax
+-------------------
+这个layer以一个mini batch的序列为输入，在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列，只不过在序列内是归一化过的。
+这个layer往往用于在一个sequence内做softmax归一化。
+
+API Reference 请参考 api_fluid_layers_sequence_softmax_
+
+.. _api_fluid_layers_sequence_softmax: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-softmax
+
+
+2. sequence_concat
+------------------
+这个layer以一个list为输入，该list中可以含有多个元素，每个元素为一个mini batch的序列。
+该layer会将每个batch中的第i个序列在时间步的那一维拼接成一个新的序列，作为返回的batch中的第i个序列。
+list中每个batch的序列必须有相同的batch size.
+
+API Reference 请参考 api_fluid_layers_sequence_concat_
+
+.. _api_fluid_layers_sequence_concat: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-concat
+
+
+3. sequence_first_step
+----------------------
+这个layer以一个mini batch的序列作为输入，会取出每个序列中的第一个元素（也就是时间步的第一步的元素），并作为返回值。
+
+API Reference 请参考 api_fluid_layers_sequence_first_step_
+
+.. _api_fluid_layers_sequence_first_step: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-first-step
+
+
+4. sequence_last_step
+---------------------
+同:code:`sequence_first_step`，不过是取每个序列中最后一个元素作为返回值。
+
+API Reference 请参考 api_fluid_layers_sequence_last_step_
+
+.. _api_fluid_layers_sequence_last_step: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-last-step
+
+
+5. sequence_expand
+------------------
+这个layer有两个mini batch的序列作为输入，并按照第二个batch中序列的LoD信息来扩展第一个batch中的序列。
+通常用来将只有一个时间步的序列（例如:code:`sequence_first_step`的返回结果）延展成有多个时间步的序列，以此方便进行对位运算。
+
+API Reference 请参考 api_fluid_layers_sequence_expand_
+
+.. _api_fluid_layers_sequence_expand: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-expand
+
+
+6. sequence_expand_as
+---------------------
+这个layer需要两个mini batch的序列作为输入，然后将第一个batch序列中的每一个序列延展成和第二个batch中对应序列等长的序列。
+如果无法延展成等长的（例如第二个batch中的序列长度不是第一个batch中序列长度的整数倍），则会报错。
+
+API Reference 请参考 api_fluid_layers_sequence_expand_as_
+
+.. _api_fluid_layers_sequence_expand_as: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-expand-as
+
+
+7. sequence_enumerate
+---------------------
+这个layer需要一个mini batch的序列作为输入，同时需要指定一个:code:`win_size`的长度。这个layer将依次取所有序列中长度为:code:`win_size`的子序列，并组合成新的序列。
+
+API Reference 请参考 api_fluid_layers_sequence_enumerate_
+
+.. _api_fluid_layers_sequence_enumerate: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-enumerate
+
+
+8. sequence_reshape
+-------------------
+这个layer需要一个mini batch的序列作为输入，同时需要指定一个:code:`new_dim`作为新的序列的维度。
+该layer会将mini batch内每个序列reshape为new_dim给定的维度。注意，每个序列的长度会改变，以适应新的形状。
+
+API Reference 请参考 api_fluid_layers_sequence_reshape_
+
+.. _api_fluid_layers_sequence_reshape: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-reshape
+
+
+9. sequence_scatter
+-------------------
+这个layer可以将一个序列的数据scatter到另一个tensor上。这个layer有三个input，一个要被scatter的目标tensor :code:`input`；
+一个是序列的数据:code:`update`，一个是目标tensor的上坐标:code:`index`. Output为scatter后的tensor，形状和:code:`input`相同。
+
+API Reference 请参考 api_fluid_layers_sequence_scatter_
+
+.. _api_fluid_layers_sequence_scatter: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-scatter
+
+
+10. sequence_pad
+----------------
+这个layer可以将不等长的序列补齐成等长序列。使用这个layer需要提供一个:code:`PadValue`和一个:code:`padded_length`.
+前者是用来补齐序列的元素，可以是一个数也可以是一个tensor；后者是序列补齐的目标长度。
+这个layer会返回补齐后的序列，以及一个记录补齐前各个序列长度的tensor :code:`Length`.
+
+API Reference 请参考 api_fluid_layers_sequence_pad_
+
+.. _api_fluid_layers_sequence_pad: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-pad
+
+
+11. sequence_mask
+-----------------
+这个layer会根据:code:`input`生成一个mask，:code:`input`是一个记录了每个序列长度的tensor.
+此外这个layer还需要一个参数:code:`maxlen`用于指定序列中最大的序列长度。
+通常这个layer用于生成一个mask，将被pad后的序列中pad的部分过滤掉。
+:code:`input`的长度tensor通常可以直接用:code:`sequence_pad`返回的:code:`Length`.
+
+API Reference 请参考 api_fluid_layers_sequence_mask_
+
+.. _api_fluid_layers_sequence_mask: http://www.paddlepaddle.org/documentation/api/zh/1.0/layers.html#sequence-mask
+