.. raw:: html
   
    <style> .red {color:red; font-weight:bold} </style>

.. role:: red

.. _cn_api_fluid_layers_sequence_softmax:

sequence_softmax
-------------------------------

.. py:function:: paddle.fluid.layers.sequence_softmax(input, use_cudnn=False, name=None)

:red:`注意：该OP的输入只能是LoDTensor，如果要处理的输入是Tensor类型，请使用`  :ref:`cn_api_fluid_layers_softmax` 

该OP根据LoD信息将输入的第0维度进行划分，在划分的每一个区间内部进行运算。

对第i个区间内的元素的计算公式如下：

.. math::

    Out\left ( X[lod[i]:lod[i+1]],: \right ) = \frac{exp(X[lod[i]:lod[i+1],:])}{\sum (exp(X[lod[i]:lod[i+1],:]))}

输入Tensor的维度可为 :math:`[N，1]` 或者 :math:`[N]` ，推荐使用 :math:`[N]` 。

例如，对有6个样本的batch，每个样本的长度为3，2，4，1，2，3，其lod信息为[[0, 3, 5, 9, 10, 12, 15]]，根据lod信息将第0维度划分为6份，在 :math:`X[0:3,:],X[3:5,:],X[5:9,:],X[9:10,:],X[10:12,:],X[12:15,:]`  中进行softmax运算。

::

     示例：

             给定：
                   input.data = [0.7, 1, 0.6,
                                 1.5, 1.1,
                                 1.2, 0.2, 0.6, 1.9,
                                 3.1,
                                 2.5, 0.8,
                                 0.1, 2.4, 1.3]
                   input.lod = [[0, 3, 5, 9, 10, 12, 15]]
              则：
                   output.data = [0.30724832, 0.41474187, 0.2780098,
                                  0.59868765, 0.40131235,
                                  0.2544242, 0.09359743, 0.13963096, 0.5123474, 
                                  1.,
                                  0.84553474, 0.15446526,
                                  0.06995796, 0.69777346, 0.23226859]
                   output.lod = [[0, 3, 5, 9, 10, 12, 15]] 


参数：
    - **input** (Variable) - 维度为 :math:`[N, 1]` 或者 :math:`[N]` 的LoDTensor，推荐使用 :math:`[N]` 。支持的数据类型：float32，float64。
    - **use_cudnn** (bool，可选) - 是否用cudnn核，仅当安装cudnn版本的paddle库且使用gpu训练或推理的时候生效。支持的数据类型：bool型。默认值为False。
    - **name**  (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。

返回：根据区间计算softmax之后的LoDTensor，其维度与input的维度一致，数据类型与input的数据类型一致。

返回类型：Variable

**代码示例**：

.. code-block:: python

    import paddle.fluid as fluid
    x = fluid.data(name='x', shape=[7, 1],
                 dtype='float32', lod_level=1)
    x_sequence_softmax = fluid.layers.sequence_softmax(input=x)
    
    y = fluid.data(name='y', shape=[7],
                 dtype='float32', lod_level=1)
    y_sequence_softmax = fluid.layers.sequence_softmax(input=y)