aclnnPromptFlashAttentionV2

支持的产品型号

Atlas A2训练系列产品/Atlas 800I A2推理产品
Atlas 推理系列加速卡产品

功能描述

算子功能：全量推理场景的FlashAttention算子，相较于接口，此接口新增了支持sparse优化、支持actualSeqLengthsKv优化、支持int8量化功能。
计算公式：

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[object Object]T[object Object]的乘积代表输入x的注意力，为避免该值变得过大，通常除以d的开根号进行缩放，并对每行进行softmax归一化，与V相乘后得到一个n*d的矩阵。

算子执行接口

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

aclnnStatus aclnnPromptFlashAttentionV2GetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *pseShift, const aclTensor *attenMask, const aclIntArray *actualSeqLengths, const aclIntArray *actualSeqLengthsKv, const aclTensor *deqScale1, const aclTensor *quantScale1, const aclTensor *deqScale2, const aclTensor *quantScale2, const aclTensor *quantOffset2, int64_t numHeads, double scaleValue, int64_t preTokens, int64_t nextTokens, char *inputLayout, int64_t numKeyValueHeads, int64_t sparseMode, const aclTensor *attentionOut, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnPromptFlashAttentionV2(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

说明：

算子执行接口对外屏蔽了算子内部实现逻辑以及不同代际NPU的差异，且开发者无需编译算子，实现了算子的精简调用。
若开发者不使用算子执行接口的调用算子，也可以定义基于Ascend IR的算子描述文件，通过ATC工具编译获得算子om文件，然后加载模型文件执行算子，详细调用方法可参见《应用开发指南》的“单算子调用 > 单算子模型执行”章节。

aclnnPromptFlashAttentionV2GetWorkspaceSize

参数说明：
- query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q，数据类型支持FLOAT16、BFLOAT16、INT8，数据类型与key的数据类型需满足数据类型推导规则，即保持与key、value的数据类型一致。不支持非连续的Tensor，支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- key（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入K，数据类型支持FLOAT16、BFLOAT16、INT8，数据类型与query的数据类型需满足数据类型推导规则，即保持与query、value的数据类型一致。不支持非连续的Tensor，支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- value（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入V，数据类型支持FLOAT16、BFLOAT16、INT8，数据类型与query的数据类型需满足数据类型推导规则，即保持与query、key的数据类型一致。不支持非连续的Tensor，支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- pseShift（aclTensor*，计算输入）：预留参数，暂未使用。Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16，数据类型与query的数据类型需满足数据类型推导规则。不支持非连续的Tensor，支持ND。目前该参数会被强制设置为nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- attenMask（aclTensor*，计算输入）：Device侧的aclTensor，代表下三角全为0上三角全为负无穷的倒三角mask矩阵，不支持非连续的Tensor，数据类型支持BOOL、INT8和UINT8。支持ND。如果不使用该功能可传入nullptr。通常建议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，对于attenMask的KV_S为非32对齐的场景，建议padding到32对齐来提高性能，多余部分填充成1。综合约束请见约束与限制，Atlas 推理系列加速卡产品数据类型仅支持BOOL。
- actualSeqLengths（aclIntArray*，计算输入）：Host侧的aclIntArray，代表不同Batch中query的有效Sequence Length，数据类型支持INT64。如果不指定seqlen可以转入nullptr，表示和query的shape的s长度相同。限制：该入参中每个batch的有效Sequence Length应该不大于query中对应batch的Sequence Length，Atlas 推理系列加速卡产品仅支持nullptr。
- actualSeqLengthsKv（aclIntArray*，计算输入）：Host侧的aclIntArray，可传入nullptr，代表不同batch中key/value的有效Sequence Length，数据类型支持INT64。限制：该入参中每个batch的有效Sequence Length应该不大于key/value中对应batch的Sequence Length，Atlas 推理系列加速卡产品仅支持nullptr。
- deqScale1（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持UINT64、FLOAT32，支持ND（参考），表示BMM1后面反量化的量化因子，支持per-tensor。如不使用该功能时可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- quantScale1（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT32，支持ND（参考），表示BMM2前面量化的量化因子，支持per-tensor。如不使用该功能时可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- deqScale2（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持UINT64、FLOAT32，支持ND（参考），表示BMM2后面量化的量化因子，支持per-tensor。如不使用该功能时可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- quantScale2（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT32，支持ND（参考），表示输出量化的量化因子，支持per-tensor，per-channel。如不使用该功能时可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- quantOffset2（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT32，支持ND（参考），表示输出量化的量化偏移，支持per-tensor，per-channel。如不使用该功能时可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- numHeads（int64_t，计算输入）：Host侧的int，代表query的head个数，数据类型支持INT64。
- scaleValue（double，计算输入）：Host侧的double，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE。数据类型与query的数据类型需满足数据类型推导规则。用户不特意指定时可传入默认值1.0。
- preTokens（int64_t，计算输入）：Host侧的int，用于稀疏计算，表示attention需要和前几个Token计算关联，数据类型支持INT64。用户不特意指定时可传入默认值2147483647，sparseMode不为4且D不超过512时支持负数，Atlas 推理系列加速卡产品仅支持默认值2147483647。
- nextTokens（int64_t，计算输入）：Host侧的int，用于稀疏计算，表示attention需要和后几个Token计算关联。数据类型支持INT64。用户不特意指定时可传入默认值0，sparseMode不为4且D不超过512时支持负数，Atlas 推理系列加速卡产品仅支持默认值0和2147483647。
- inputLayout（char*，计算输入）：Host侧的字符指针CHAR*，用于标识输入query、key、value的数据排布格式，当前支持BSH、BSND、BNSD、BNSD_BSND(输入为BNSD时，输出格式为BSND)。用户不特意指定时可传入默认值:"BSH”。
  
  说明： query、key、value数据排布格式支持从多种维度解读，其中B（Batch）表示输入样本批量大小、S（Seq-Length）表示输入样本序列长度、H（Head-Size）表示隐藏层的大小、N（Head-Num）表示多头数、D（Head-Dim）表示隐藏层最小的单元尺寸，且满足D=H/N。
- numKeyValueHeads（int64_t，计算输入）：Host侧的int，代表key、value中head个数，用于支持GQA（Grouped-Query Attention，分组查询注意力）场景，数据类型支持INT64。用户不特意指定时可传入默认值0，表示和key/value的head个数相等。限制：在BNSD场景下，需要与shape中的key/value的N轴shape值相同，且需要满足numHeads整除numKeyValueHeads，numHeads与numKeyValueHeads的比值不能大于64，否则报错，Atlas 推理系列加速卡产品仅支持默认值0。
- sparseMode（int64_t，计算输入）：Host侧的int，表示sparse的模式。数据类型支持INT64，Atlas 推理系列加速卡产品仅支持默认值0。
  - 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。综合约束请见约束与限制章节。
- attentionOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出，数据类型支持FLOAT16、BFLOAT16、INT8，支持ND。限制：当inputLayout为BNSD_BSND时，输入query的shape是BNSD，输出shape为BSND；其余情况该入参的shape需要与入参query的shape保持一致，Atlas 推理系列加速卡产品仅支持FLOAT16。
- workspaceSize（uint64_t*，出参）：返回用户需要在Device侧申请的workspace大小。
- executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。
返回值：

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

[object Object]

aclnnPromptFlashAttentionV2

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

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

约束与限制

该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
入参为空的处理：算子内部需要判断参数query是否为空，如果是空则直接返回。参数query不为空Tensor，参数key、value为空tensor（即S2为0），则填充全零的对应shape的输出（填充attention_out）。attention_out为空Tensor时，AscendCLNN框架会处理。其余在上述参数说明中标注了"可传入nullptr"的入参为空指针时，不进行处理。
query，key，value输入，功能使用限制如下：
- Atlas A2训练系列产品/Atlas 800I A2推理产品：
  - 支持B轴小于等于65535(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的乘积较大)场景包括但不限于： (1)B=1,Q_N=20,Q_S=2097152,D = 256,KV_N=1,KV_S=2097152; (2)B=1,Q_N=2,Q_S=20971520,D = 256,KV_N=2,KV_S=20971520; (3)B=20,Q_N=1,Q_S=2097152,D = 256,KV_N=1,KV_S=2097152; (4)B=1,Q_N=10,Q_S=2097152,D = 512,KV_N=1,KV_S=2097152。
  - 支持D轴小于等于512。
- Atlas 推理系列加速卡产品：
  - 支持B轴小于等于128；
  - 支持N轴小于等于256；
  - 支持S轴小于等于65535(64k), Q_S或KV_S非128对齐，Q_S和KV_S不等长的场景不支持配置atten_mask；
  - 支持D轴小于等于512。
参数sparseMode当前仅支持值为0、1、2、3、4的场景，取其它值时会报错。
- sparseMode = 0时，attenMask如果为空指针，则忽略入参preTokens、nextTokens(内部赋值为INT_MAX)。
- sparseMode = 2、3、4时，attenMask的shape需要为S,S或1,S,S或1,1,S,S,其中S的值需要固定为2048，且需要用户保证传入的attenMask为下三角，不传入attenMask或者传入的shape不正确则报错。
- sparseMode = 1、2、3的场景忽略入参preTokens、nextTokens并按照相关规则赋值。
- sparseMode = 4时，preTokens、nextTokens必须为非负数。
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），则报错并返回。
- 入参 quantOffset2 和 quantScale2 支持 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接口内部使能):
- sparseMode = 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 时，满足拦截条件

算子原型

[object Object]

参数解释请参见算子执行接口。

调用示例

示例代码如下（以Atlas A2训练系列产品/Atlas 800I A2推理产品为例），仅供参考，具体编译和执行过程请参考。

[object Object]