aclnnPromptFlashAttentionV3

产品支持情况

[object Object]undefined

功能说明

• 算子功能：全量推理场景的FlashAttention算子，支持sparse优化、actualSeqLengthsKv优化、int8量化功能、innerPrecise参数（用于支持高精度或者高性能模式选择）。

• 计算公式：

  self-attention（自注意力）利用输入样本自身的关系构建了一种注意力模型。其原理是假设有一个长度为$n$的输入样本序列$x$，$x$的每个元素都是一个$d$维向量，可以将每个$d$维向量看作一个token embedding，将这样一条序列经过3个权重矩阵变换得到3个维度为$n*d$的矩阵。

  self-attention的计算公式一般定义如下，其中$Q$、$K$、$V$为输入样本的重要属性元素，是输入样本经过空间变换得到，且可以统一到一个特征空间中。公式及算子名称中的"Attention"为"self-attention"的简写。

  $$Attention(Q,K,V)=Score(Q,K)V$$

  本算子中Score函数采用Softmax函数，self-attention计算公式为：

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

  其中：$Q$和$K^T$的乘积代表输入$x$的注意力，为避免该值变得过大，通常除以$d$的开根号进行缩放，并对每行进行softmax归一化，与$V$相乘后得到一个$n*d$的矩阵。

函数原型

算子执行接口为，必须先调用“aclnnPromptFlashAttentionV3GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnPromptFlashAttentionV3”接口执行计算。

aclnnPromptFlashAttentionV3GetWorkspaceSize

• 参数说明

  [object Object]

• 返回值

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

  第一段接口会完成入参校验，出现以下场景时报错：

  [object Object]

aclnnPromptFlashAttentionV3

• 参数说明

  [object Object]

• 返回值

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

约束说明

• 确定性计算：

  • aclnnPromptFlashAttentionV3默认确定性实现。

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

• 入参为空的处理：算子内部需要判断参数query是否为空，如果是空则直接返回。参数query不为空Tensor，参数key、value为空tensor（即S2为0），则attentionOut填充为全零。attentionOut为空Tensor时，框架会处理。其余在上述参数说明中标注了“可传入nullptr”的入参为空指针时，不进行处理。

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

• query，key，value输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：

    • 支持B轴小于等于65536（64k），输入类型包含INT8时D轴非32对齐或输入类型为FLOAT16或BFLOAT16时D轴非16对齐时，B轴仅支持到128。

    • 支持N轴小于等于256。

    • S支持小于等于20971520（20M）。部分长序列场景下，如果计算量过大可能会导致pfa算子执行超时（aicore error类型报错，errorStr为:timeout or trap error），此场景下建议做S切分处理，注：这里计算量会受B、S、N、D等的影响，值越大计算量越大。典型的会超时的长序列（即B、S、N、D的乘积较大）场景包括但不限于：

      [object Object]

    • 支持D轴小于等于512。inputLayout为BSH或者BSND时，要求N*D小于65535。

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]： TND场景下query，key，value输入的综合限制：

    • T小于等于65536。
    • N等于8/16/32/64/128，且Q_N、K_N、V_N相等。
    • Q_D、K_D等于192，V_D等于128/192。
    • 数据类型仅支持BFLOAT16。
    • sparse模式仅支持sparse=0且不传mask，或sparse=3且传入mask。
    • 当sparse=3时，要求每个batch单独的actualSeqLengths < actualSeqLengthsKv。

  • [object Object]Atlas 推理系列加速卡产品[object Object]：

    • 支持B轴小于等于128；支持N轴小于等于256；支持S轴小于等于65535（64k）, Q_S或KV_S非128对齐，Q_S和KV_S不等长的场景不支持配置atten_mask；支持D轴小于等于512。

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持FLOAT16、BFLOAT16、INT8。

  • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16。

• pseShift功能使用限制如下：

  • 输入shape类型需为（B, N, Q_S, KV_S）或（1, N, Q_S, KV_S），其中Q_S为query的shape中的S，KV_S为key和value的shape中的S。

  • Q_S需大于等于query的S长度，KV_S需大于等于key的S长度。

  • 对于pseShift的KV_S为非32对齐的场景，建议padding到32字节来提高性能，多余部分的填充值不做要求。如不使用该功能时可传入nullptr。

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持FLOAT16、BFLOAT16，且在pseShift为FLOAT16类型时，要求此时的query为FLOAT16或INT8类型，而在pseShift为BFLOAT16类型时，要求此时的query为BFLOAT16类型。在query、key、value为FLOAT16且pseShift存在的情况下，默认走高精度模式，对应的限制继承自高精度模式的限制。

  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr。

• attenMask功能使用限制如下：

  • 对于attenMask的KV_S为非32对齐的场景，建议padding到32对齐来提高性能，多余部分填充成1。
  • 通常建议shape输入Q_S, KV_S; B, Q_S, KV_S; 1, Q_S, KV_S; B, 1, Q_S, KV_S; 1, 1, Q_S, KV_S，其中Q_S为query的shape中的S，KV_S为key和value的shape中的S。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持BOOL、INT8和UINT8。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持BOOL。

• actualSeqLengths，actualSeqLengthsKv输入，功能使用限制如下：

  • 对于actualSeqLengths，如果不指定序列长度，可以传入nullptr，这表示有效序列长度与query的shape中的S长度相同。需要注意的是，该参数中每个batch的有效序列长度不应超过query中对应batch的序列长度。
  • 对于actualSeqLengthsKv，如果不指定序列长度，可以传入nullptr，这表示有效序列长度与key/value的shape中的S长度相同。需要注意的是，该参数中每个batch的有效序列长度不应超过key/value中对应batch的序列长度。
  • 关于seqlen的传入长度有以下规则：当传入长度为1时，所有Batch将使用相同的seqlen；当传入长度大于或等于Batch数量时，将取seqlen的前Batch个数值；其他长度的传入将不被支持。
  • 当query的inputLayout为TND时，该入参必须传入，且以该入参元素的数量作为Batch值。该入参中每个元素的值表示当前Batch与之前所有Batch的Sequence Length和，因此后一个元素的值必须大于等于前一个元素的值，且不能出现负值。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持INT64，支持TND格式。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型支持INT64。

• deqScale1，deqScale2输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持UINT64、FLOAT32。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr。

• quantScale1输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持FLOAT32。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr。

• quantScale2，quantOffset2输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持FLOAT32和BFLOAT16。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr。

• preTokens输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持INT64。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值2147483647。

• nextTokens输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持INT64。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0和2147483647。

• inputLayout输入，功能使用限制如下：

  • 当前支持BSH、BSND、BNSD、BNSD_BSND（输入为BNSD时，输出格式为BSND）。用户不特意指定时建议传入"BSH"。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：除了上述格式，还支持TND（不支持pse、全量化、后量化）。

• numKeyValueHeads输入，功能使用限制如下：

  • 需要满足numHeads整除numKeyValueHeads，numHeads与numKeyValueHeads的比值不能大于64，且在BSND、BNSD、BNSD_BSND场景下，需要与shape中的key/value的N轴shape值相同，否则报错。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持INT64。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0。

• sparseMode输入，功能使用限制如下：

  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：
    • sparseMode为0时，代表defaultMask模式，如果attenmask未传入则不做mask操作，忽略preTokens和nextTokens（内部赋值为INT_MAX）；如果传入，则需要传入完整的attenmask矩阵（S1 * S2），表示preTokens和nextTokens之间的部分需要计算。
    • sparseMode为1时，代表allMask，必须传入完整的attenmask矩阵（S1 * S2）。
    • sparseMode为2时，代表leftUpCausal模式的mask，需要传入优化后的attenmask矩阵（2048*2048）。
    • sparseMode为3时，代表rightDownCausal模式的mask，对应以右顶点为划分的下三角场景，需要传入优化后的attenmask矩阵（2048*2048）。
    • sparseMode为4时，代表band模式的mask，需要传入优化后的attenmask矩阵（2048*2048）。
    • sparseMode为5、6、7、8时，分别代表prefix、global、dilated、block_local，均暂不支持。用户不特意指定时建议传入0。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：当inputLayout为TND时，sparseMode仅支持取值0、3。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0。

• innerPrecise输入，功能使用限制如下：

  • 一共4种模式：0、1、2、3。一共两位bit位，第0位（bit0）表示高精度或者高性能选择，第1位（bit1）表示是否做行无效修正。

    [object Object]

  • Q_S>1时，sparse_mode为0或1，并传入用户自定义mask的情况下，建议开启行无效。

  • BFLOAT16和INT8不区分高精度和高性能，行无效修正对FLOAT16、BFLOAT16和INT8均生效。 当前0、1为保留配置值，当计算过程中“参与计算的mask部分”存在某整行全为1的情况时，精度可能会有损失。此时可以尝试将该参数配置为2或3来使能行无效功能以提升精度，但是该配置会导致性能下降。 如果算子可判断出存在无效行场景，会自动使能无效行计算，例如sparse_mode为3，Sq > Skv场景。

• attentionOut输出，功能使用限制如下：

  • 当inputLayout为BNSD_BSND时，输入query的shape是BNSD，输出shape为BSND；其余情况该入参的shape需要与入参query的shape保持一致。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：数据类型支持FLOAT16、BFLOAT16、INT8。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持FLOAT16。

• int8量化相关入参数量与输入、输出数据格式的综合限制：

  • 输入为INT8，输出为INT8的场景：入参deqScale1、quantScale1、deqScale2、quantScale2需要同时存在，quantOffset2可选，不传时默认为0。
  • 输入为INT8，输出为FLOAT16的场景：入参deqScale1、quantScale1、deqScale2需要同时存在，若存在入参quantOffset2 或 quantScale2（即不为nullptr），则报错并返回。
  • 输入为FLOAT16或BFLOAT16，输出为INT8的场景：入参quantScale2需存在，quantOffset2可选，不传时默认为0，若存在入参deqScale1 或 quantScale1 或 deqScale2（即不为nullptr），则报错并返回。
  • 入参 quantScale2 和 quantOffset2 支持 per-tensor/per-channel 两种格式和 FLOAT32/BFLOAT16 两种数据类型。若传入 quantOffset2 ，需保证其类型和shape信息与 quantScale2 一致。当输入为BFLOAT16时，同时支持 FLOAT32和BFLOAT16 ，否则仅支持 FLOAT32 。per-channel 格式，当输出layout为BSH时，要求 quantScale2 所有维度的乘积等于H；其他layout要求乘积等于N*D。（建议输出layout为BSH时，quantScale2 shape传入[1,1,H]或[H]；输出为BNSD时，建议传入[1,N,1,D]或[N,D]；输出为BSND时，建议传入[1,1,N,D]或[N,D]）
  • 输出为int8，quantScale2 和 quantOffset2 为 per-channel时，暂不支持左padding、Ring Attention或者D非32Byte对齐的场景。
  • 输出为int8时，暂不支持sparse为band且preTokens/nextTokens为负数。

• 当输出为INT8，入参quantOffset2传入非空指针和非空tensor值，并且sparseMode、preTokens和nextTokens满足以下条件，矩阵会存在某几行不参与计算的情况，导致计算结果误差，该场景会拦截（解决方案：如果希望该场景不被拦截，需要在PFA接口外部做后量化操作，不在PFA接口内部使能）:

  • parseMode = 0，attenMask如果非空指针，每个batch actualSeqLengths - actualSeqLengthsKV - preTokens > 0 或 nextTokens < 0 时，满足拦截条件。
  • sparseMode = 1 或 2，不会出现满足拦截条件的情况。
  • sparseMode = 3，每个batch actualSeqLengthsKV - actualSeqLengths < 0，满足拦截条件。
  • sparseMode = 4，preTokens < 0 或 每个batch nextTokens + actualSeqLengthsKV - actualSeqLengths < 0 时，满足拦截条件。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考。