o
    Qe|                     @   sX   d dl Z d dlZddlmZ d dlmZ d dlmZmZ d dlmZ 			d	ddZ	dS )
    N   )default_main_program)LayerHelper)_C_ops_legacy_C_ops)in_dynamic_modec              	   C   s   t  rt| ||||||\}}	}
|S tdi t }|jdd}||}||}	||}
| ||||||d}||	|
d}|jd||d |S )	a  
    This operator sparsify the Attention matrix in Transformer module
    to achieve the effect of reducing memory consumption and computation.
    The sparse layout is expressed in CSR format and contains two parameters,
    ``offset`` and ``columns``. The equation is:

    .. math::

        result=softmax(\frac{ Q * K^T }{\sqrt{d}}) * V

    where : ``Q``, ``K``, and ``V`` represent the three input parameters of the attention module.
    The dimensions of the three parameters are the same.
    ``d`` represents the size of the last dimension of the three parameters.

    Warning:
        This API is only used in ``CUDA 11.3`` and above versions.

    Args:
        query(Tensor): The query tensor in the Attention module.
                        4-D tensor with shape:
                        [batch_size, num_heads, seq_len, head_dim].
                        The dtype can be float32 and float64.
        key(Tensor): The key tensor in the Attention module.
                        4-D tensor with shape:
                        [batch_size, num_heads, seq_len, head_dim].
                        The dtype can be float32 and float64.
        value(Tensor): The value tensor in the Attention module.
                        4-D tensor with shape:
                        [batch_size, num_heads, seq_len, head_dim].
                        The dtype can be float32 and float64.
        sparse_csr_offset(Tensor): The sparsity feature in the Attention module
                        is expressed in the CSR format, and the offset represents
                        the number of non-zero elements in each row of the matrix.
                        3-D tensor with shape:
                        [batch_size, num_heads, seq_len + 1].
                        The dtype should be int32.
        sparse_csr_columns(Tensor): The sparsity feature in the Attention module
                        is expressed in the CSR format, and the columns represent
                        the column index values of non-zero elements in the matrix.
                        3-D tensor with shape:
                        [batch_size, num_heads, sparse_nnz].
                        The dtype should be int32.
        key_padding_mask(Tensor, optional):The key padding mask tensor in the Attention module.
                        2-D tensor with shape: [batch_size, seq_len].
                        The dtype can be float32 and float64.
                        A value of 0 means that the position is masked.
        attn_mask(Tensor, optional):The attention mask tensor in the Attention module.
                        2-D tensor with shape: [seq_len, seq_len].
                        The dtype can be float32 and float64.
                        A value of 0 means that the position is masked.
        name(str, optional): The default value is None. Normally there is no need for user
                        to set this property. For more information, please refer to
                        :ref:`api_guide_Name`.

    Returns:
        4-D tensor with shape:
        [batch_size, num_heads, seq_len, head_dim].
        The dtype can be float32 or float64.

    Examples:
        .. code-block:: python

            # required: skiptest
            import paddle

            paddle.disable_static()

            # `query`, `key` and `value` all have shape [1, 1, 4, 2]
            query = paddle.to_tensor([[[[0, 1, ], [2, 3],
                                        [0, 1], [2, 3]]]], dtype="float32")
            key = paddle.to_tensor([[[[0, 1], [2, 3],
                                    [0, 1], [2, 3]]]], dtype="float32")
            value = paddle.to_tensor([[[[0, 1], [2, 3],
                                        [0, 1], [2, 3]]]], dtype="float32")


            offset = paddle.to_tensor([[[0, 2, 4, 6, 8]]], dtype="int32")
            columns = paddle.to_tensor([[[0, 1, 0, 1, 2, 3, 2, 3]]], dtype="int32")

            print(offset.shape)  # (1, 1, 5)
            print(columns.shape)  # (1, 1, 8)

            key_padding_mask = paddle.to_tensor([[1, 1, 1, 0]], dtype="float32")
            attention_mask = paddle.to_tensor([[1, 0, 1, 1],
                                            [1, 1, 1, 1],
                                            [1, 1, 1, 1],
                                            [1, 1, 1, 1]], dtype="float32")
            output_mask = paddle.nn.functional.sparse_attention(query, key,
                                                                value, offset, columns,
                                                                key_padding_mask=key_padding_mask,
                                                                attn_mask=attention_mask)
            print(output_mask)
            # Tensor(shape=[1, 1, 4, 2], dtype=float32, place=Place(gpu:0), stop_gradient=False,
            #        [[[[0.        , 1.        ],
            #           [1.99830270, 2.99830270],
            #           [0.        , 1.        ],
            #           [0.        , 1.        ]]]])

            output = paddle.nn.functional.sparse_attention(query, key,
                                                        value, offset, columns)
            print(output)
            # Tensor(shape=[1, 1, 4, 2], dtype=float32, place=Place(gpu:0), stop_gradient=False,
            #        [[[[1.60885942, 2.60885954],
            #           [1.99830270, 2.99830270],
            #           [1.60885942, 2.60885954],
            #           [1.99830270, 2.99830270]]]])
    sparse_attentionQ)Zinput_param_name)r	   KVZOffsetColumnsZKeyPaddingMaskZAttnMask)ZOutZSparseDotSddZSoftmax)typeinputsoutputsN)r   )r   r   r   r   localsZinput_dtypeZ"create_variable_for_type_inferenceZ	append_op)querykeyvalueZsparse_csr_offsetZsparse_csr_columnsZkey_padding_maskZ	attn_masknameZresult_attentionZ
result_sddZresult_softmaxhelperZdtypeoutr   r    r   UD:\Projects\ConvertPro\env\Lib\site-packages\paddle/nn/functional/sparse_attention.pyr      sD   u




r   )NNN)
warningsZpaddleZfluid.frameworkr   Zpaddle.fluid.layer_helperr   r   r   r   r   r   r   r   r   <module>   s   	