aclnnFlashAttentionVarLenScore

支持的产品型号

• Atlas A2训练系列产品。

接口原型

每个算子分为两段式接口，必须先调用“aclnnFlashAttentionVarLenScoreGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnFlashAttentionVarLenScore”接口执行计算。

• aclnnStatus aclnnFlashAttentionVarLenScoreGetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *realShiftOptional, const aclTensor *dropMaskOptional, const aclTensor *paddingMaskOptional,const aclTensor *attenMaskOptional, const aclIntArray *prefixOptional, const aclIntArray *actualSeqQLenOptional, const aclIntArray *actualSeqKvLenOptional, double scaleValueOptional, double keepProbOptional, int64_t preTockensOptional, int64_t nextTockensOptional, int64_t headNum, char *inputLayout, int64_t innerPreciseOptional, int64_t sparseModeOptional, const aclTensor *softmaxMaxOut, const aclTensor *softmaxSumOut, const aclTensor *softmaxOutOut, const aclTensor *attentionOutOut, uint64_t *workspaceSize, aclOpExecutor **executor);)
• aclnnStatus aclnnFlashAttentionVarLenScore(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

功能描述

• 算子功能：训练场景下，使用FlashAttention算法实现self-attention（自注意力）的计算。跟aclnnFlashAttentionScoreGetWorkspaceSize的区别是该接口支持可变长S的计算。

• 计算公式：

  注意力的正向计算公式如下：

  $$Attention(Q,K,V)=Dropout(Softmax(Mask(\frac{QK^T+pse}{\sqrt{d}})))V$$

aclnnFlashAttentionVarLenScoreGetWorkspaceSize

• 参数说明：

  • query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q。数据类型支持：FLOAT16、BFLOAT16。数据类型与key/value的数据类型一致。数据格式支持ND。综合约束请见约束与限制。

  • key（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入K。数据类型支持：FLOAT16、BFLOAT16。数据类型与query/value的数据类型一致。数据格式支持ND。综合约束请见约束与限制。

  • value（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入V。数据类型支持：FLOAT16、BFLOAT16。数据类型与query/key的数据类型一致。数据格式支持ND。综合约束请见约束与限制。

  • realShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse，可选参数。数据类型支持：FLOAT16、BFLOAT16。数据类型与query的数据类型一致。数据格式支持ND。varlen场景为多个batch的pse连续内存排布，其shape和数据排布可表示为，其中sq表示每个batch上query的sequence length，skv表示每个batch上key、value的sequence length。如果maxSq大于1024、每个batch的Sq与Skv等长且是sparseModeOptional为0、2、3的下三角掩码场景，可使能alibi位置编码压缩，此时只需要输入原始PSE最后1024行进行内存优化，即alibi_compress = ori_pse[:, :, -1024:, :]，参数每个batch不相同时，输入BNHSkv(H=1024)，每个batch相同时，输入1NHSkv(H=1024)。后续章节如无特殊说明，S表示query或key、value的sequence length，Sq表示query的sequence length，Skv表示key、value的sequence length，SS表示Sq*Skv。

  • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的dropout，可选参数。数据类型支持：UINT8（标识8个1bit BOOL）。数据格式支持ND。

  • paddingMaskOptional（aclTensor*，计算输入）：预留参数，暂未使用。

  • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的mask，可选参数。数据类型支持：BOOL、UINT8。数据格式支持ND，输入shape类型需为[maxSq,maxSkv]。

  • prefixOptional（aclIntArray*，计算输入）：Host侧的aclIntArray。可选参数。数据类型支持：INT64。代表prefix稀疏计算场景每个Batch的N值。数据格式支持ND。综合约束请见约束与限制。

  • actualSeqQLenOptional（aclIntArray*，计算输入）：Host侧的aclIntArray。数据类型支持：INT64。数据格式支持ND。描述了每个Batch对应的query S大小。

  • actualSeqKvLenOptional（aclIntArray*，计算输入）：Host侧的aclIntArray。数据类型支持：INT64。数据格式支持ND。描述了每个Batch对应的key/value S大小。

  • scaleValueOptional（double，计算输入）：Host侧的double，公式中d开根号的倒数。数据类型支持：DOUBLE，代表缩放系数，作为计算流中Muls的scalar值。

  • keepProbOptional（double，计算输入）：Host侧的double。数据类型支持：DOUBLE，代表dropMaskOptional中1的比例。

  • preTockensOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64，用于稀疏计算 ，表示slides window的左边界。综合约束请见约束与限制。

  • nextTockensOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64，用于稀疏计算，表示slides window的右边界。综合约束请见约束与限制。

  • headNum（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64，代表单卡的head个数。

  • inputLayout（string*，计算输入）：Host侧的string。数据类型支持：String，代表输入query、key、value的数据排布格式，支持TND。

    说明： query、key、value数据排布格式支持从多种维度解读，其中B（Batch）表示输入样本批量大小、S（Seq-Length）表示输入样本序列长度、H（Head-Size）表示隐藏层的大小、N（Head-Num）表示多头数、D（Head-Dim）表示隐藏层最小的单元尺寸，且满足D=H/N。

  • innerPreciseOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64，用于提升精度，默认配置为0即可。

    说明： 当前0、1为保留配置值，当计算过程中存在整行mask进而导致精度有损失时，可以尝试将该参数配置为2以提升精度，但是该配置会导致性能下降。

  • sparseModeOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64。用户不特意指定时可传入默认值：0，支持配置值为0、1、2、3、4、6、7、8。当整网的atten_mask都相同且shape小于2048*2048时，建议使用defaultMask模式，来减少内存使用量。综合约束请见约束与限制。

    sparse_mode	含义	备注
    0	defaultMask模式
    1	allMask模式
    2	leftUpCausal模式
    3	rightDownCausal模式
    4	band模式
    6	prefix压缩模式
    7	varlen外切场景，rightDownCausal模式
    8	varlen外切场景，leftUpCausal模式

    • sparseModeOptional为0时，代表defaultMask模式，如果attenMaskOptional未传入则不做mask操作，忽略preTockensOptional和nextTockensOptional；如果传入，则需要传入完整的attenMaskOptional矩阵（maxSq * maxSkv），表示preTockensOptional和nextTockensOptional之间的部分需要计算。
    • sparseModeOptional为1时，代表allMask，即传入完整的attenMaskOptional矩阵。
    • sparseModeOptional为2时，代表leftUpCausal模式的mask，对应以左上顶点为划分的下三角场景，需要传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseModeOptional为3时，代表rightDownCausal模式的mask，对应以右下顶点为划分的下三角场景，需要传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseModeOptional为4时，代表band场景，即计算preTockensOptional和nextTockensOptional之间的部分，需要传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseModeOptional为5时，不支持。
    • sparseModeOptional为6时，代表prefix压缩场景，需要传入shape为[3072, 2048]的attenMaskOptional矩阵；分为两部分：[2048, 2048]的下三角矩阵；[1024, 2048]的矩阵，左半部分全0，右半部分全1。
    • sparseModeOptional为7时，代表rightDownCausal_Band场景，该场景由长序列外切产生（即长序列在模型脚本中进行多卡切query的sequence length ），需要正确配置preTockensOptional和nextTockensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。综合约束请见约束与限制。
    • sparseModeOptional为8时，代表band_LeftUpCausal场景，该场景由长序列外切产生，需要正确配置preTockensOptional和nextTockensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。综合约束请见约束与限制。

    说明： sparse_mode配置为1、2、3、6时，用户配置的preTockensOptional和nextTockensOptional不会生效；sparse_mode配置为0、4时，须保证attenmask与preTockensOptional、nextTockensOptional的范围一致。 sparse_mode为7时，band表示的是最后一个Batch的sparse类型；如果只有一个Batch，既为最后一个Batch，需要配置band模式的参数。 sparse_mode为8时，band表示的是第一个Batch的sparse类型；如果只有一个Batch，既为第一个Batch，需要配置band模式的参数。

  • softmaxMaxOut（aclTensor*，计算输出）：Device侧的aclTensor。数据类型支持：FLOAT。数据格式支持ND。

  • softmaxSumOut（aclTensor*，计算输出）：Device侧的aclTensor。数据类型支持：FLOAT。数据格式支持ND。

  • softmaxOutOut（aclTensor*，计算输出）：预留参数，暂未使用。

  • attentionOutOut（aclTensor*，计算输出）：Device侧的aclTensor。数据类型支持：FLOAT16、BFLOAT16。数据类型query的数据类型一致。数据格式支持ND。

  • workspaceSize（uint64_t*，出参）：返回需要在npu device侧申请的workspace大小。

  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

  返回aclnnStatus状态码，具体参见。

  说明： 第一段接口完成入参校验，若出现以下错误码，则对应原因为：

  • 返回161001（ACLNN_ERR_PARAM_NULLPTR）：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。
  • 返回161002（ACLNN_ERR_PARAM_INVALID）：query、key、value、realShiftOptional、dropMaskOptional、paddingMaskOptional、attenMaskOptional、softmaxMaxOut、softmaxSumOut、softmaxOutOut、attentionOutOut的数据类型和数据格式不在支持的范围内。

aclnnFlashAttentionVarLenScore

• 参数说明：

  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnFlashAttentionVarLenScoreGetWorkspaceSize获取。
  • executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
  • stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。

• 返回值：

  返回aclnnStatus状态码，具体参见。

约束与限制

• 该接口与pytorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配

• 输入query、key、value的B：batchsize必须相等。

• 输入query、key、value的input_layout必须一致。

• 输入key/value的shape必须一致。

• 关于数据shape的约束，以inputLayout的TND为例，其中：

  • B：取值范围为1~2K。
  • N：取值范围为1~256。
  • S：取值范围为1~512K。
  • D：取值范围为1~512。

• prefix稀疏计算场景B不大于32。

• band场景，preTockensOptional和nextTockensOptional之间必须要有交集。

• sparse_mode=7或者8时，不支持可选输入realShiftOptional。

• actualSeqQLenOptional输入支持某个Batch上的S长度为0，此时不支持可选输入realShiftOptional。

• attenMaskOptional输入不支持补pad，即attenMaskOptional中不能存在某一行全1的场景。

• 支持actualSeqQLenOptional中某个Batch上的S长度为0；如果存在S为0的情况，不支持pse输入， 假设真实的S长度为[2,2,0,2,2]，则传入的actualSeqQLenOptional为[2,4,4,6,8]。不支持某个batch中Sq不为0，但是Skv为0的场景。

调用示例