aclnnIncreFlashAttentionV3

支持的产品型号

Atlas A2训练系列产品。 Atlas 推理系列加速卡产品。

接口原型

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

aclnnStatus aclnnIncreFlashAttentionV3GetWorkspaceSize(const aclTensor *query, const aclTensorList *key, const aclTensorList *value, const aclTensor *pseShift, const aclTensor *attenMask, const aclIntArray *actualSeqLengths, const aclTensor *dequantScale1, const aclTensor *quantScale1, const aclTensor *dequantScale2, const aclTensor *quantScale2, const aclTensor *quantOffset2, const aclTensor *antiquantScale, const aclTensor *antiquantOffset, const aclTensor *blocktable, int64_t numHeads, double scaleValue, char *inputLayout, int64_t numKeyValueHeads, int64_t blockSize, int64_t innerPrecise, const aclTensor *attentionOut, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnstatus aclnnIncreFlashAttentionV3(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能：

兼容接口功能，在其基础上新增page attention和kv cache反量化特性。

对于自回归（Auto-regressive）的语言模型，随着新词的生成，推理输入长度不断增大。在原来全量推理的基础上实现增量推理，query的S轴固定为1，key和value是经过KV Cache后，将之前推理过的state信息，叠加在一起，每个Batch对应S轴的实际长度可能不一样，输入的数据是经过padding后的固定长度数据。

相比全量场景的FlashAttention算子（），增量推理的流程与正常全量推理并不完全等价，不过增量推理的精度并无明显劣化。

说明： KV Cache是大模型推理性能优化的一个常用技术。采样时，Transformer模型会以给定的prompt/context作为初始输入进行推理（可以并行处理），随后逐一生成额外的token来继续完善生成的序列（体现了模型的自回归性质）。在采样过程中，Transformer会执行自注意力操作，为此需要给当前序列中的每个项目（无论是prompt/context还是生成的token）提取键值（KV）向量。这些向量存储在一个矩阵中，通常被称为kv缓存（KV Cache）。
计算公式：

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

self-attention的计算公式一般定义如下，其中 $Q、K、V$ 为输入样本的重要属性元素，是输入样本经过空间变换得到，且可以统一到一个特征空间中。
$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$ 的矩阵。

aclnnIncreFlashAttentionV3GetWorkspaceSize

参数说明：
- query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q，数据类型支持FLOAT16、INT8、BFLOAT16，数据格式支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- key（aclTensorList*，计算输入）：Device侧的aclTensorList，公式中的输入K，数据类型支持FLOAT16、INT8、BFLOAT16，数据格式支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- value（aclTensorList*，计算输入）：Device侧的aclTensorList，公式中的输入V，数据类型支持FLOAT16、INT8、BFLOAT16 ，数据格式支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- pseShift（aclTensor*，计算输入）：Device侧的aclTensor，可选参数，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND，输入shape为(1,N,1,S)或(B,N,1,S)。如不使用该功能时可传入nullptr。
- attenMask（aclTensor*，计算输入）：Device侧的aclTensor，可选参数，数据类型支持BOOL、INT8、UINT8，数据格式支持ND。
- actualSeqLengths（aclIntArray*，计算输入）：Host侧的aclIntArray，可选参数，数据类型支持INT64。
- dequantScale1（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：UINT64、FLOAT32。数据格式支持ND，表示BMM1后面反量化的量化因子，支持per-tensor（scalar）。如不使用该参数可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- quantScale1（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：FLOAT32。数据格式支持ND，表示BMM2前面量化的量化因子，支持per-tensor（scalar）。如不使用该参数可传入nullptr，Atlas 推理系列加速卡产品仅支持nullptr。
- dequantScale2（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：UINT64、FLOAT32。数据格式支持ND，表示BMM2后面量化的量化因子，支持per-tensor（scalar）。如不使用该参数可传入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。
- antiquantScale（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：FLOAT16/BFLOAT16。数据格式支持ND，表示量化因子，支持per-channel（list），由shape决定，BNSD场景下shape为(2, N, 1, D)，BSH场景下shape为(2, H)，BSND场景下shape为(2, N, D)。如不使用该功能时可传入nullptr。
- antiquantOffset（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：FLOAT16/BFLOAT16 。数据格式支持ND，表示量化偏移，支持per-channel（list），由shape决定，BNSD场景下shape为(2, N, 1, D)，BSH场景下shape为(2, H)，BSND场景下shape为(2, N, D)。如不使用该功能时可传入nullptr。
- blocktable（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持：INT32。数据格式支持ND，表示page attention中KV存储使用的block映射表。如不使用该功能时可传入nullptr。
- numHeads（int64_t，计算输入）：Host侧的int64_t，代表head个数，数据类型支持INT64。
- scaleValue（double，计算输入）：Host侧的double，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE。
- inputLayout（char*，计算输入）：Host侧的字符指针，用于标识输入query、key、value的数据排布格式，当前支持BSH、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侧的int64_t，代表key、value中head个数，用于支持GQA（Grouped-Query Attention，分组查询注意力）场景，默认为0，表示和query的head个数相等。numHeads与numKeyValueHeads的比值不能大于64。数据类型支持INT64。
- blockSize （int64_t，计算输入）：Host侧的int64_t，page attention中KV存储每个block中最大的token个数，默认为0，数据类型支持INT64*。
- innerPrecise （int64_t，计算输入）：Host侧的int64_t, 代表高精度/高性能选择，0代表高精度，1代表高性能，默认值为1，数据类型支持INT64。当前仅支持高精度和高性能两种模式。
- attentionOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出，数据类型支持FLOAT16、INT8、BFLOAT16，数据格式支持ND，Atlas 推理系列加速卡产品仅支持FLOAT16。
- workspaceSize（uint64_t*，出参）：返回用户需要在Device侧申请的workspace大小。
- executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。
返回值：

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

说明： 第一段接口完成入参校验，出现以下场景时报错：
- 返回161001（ACLNN_ERR_PARAM_NULLPTR）：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。
- 返回161002（ACLNN_ERR_PARAM_INVALID）：query、key、value、pseShift、attenMask、attentionOut的数据类型和数据格式不在支持的范围内。

aclnnIncreFlashAttentionV3

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

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

约束与限制

参数key、value 中对应tensor的shape需要完全一致；非连续场景下 key、value 的tensorlist中的tensor的shape也需要完全一致，且batch只能为1。
参数query和attentionOut的shape需要完全一致。
参数query中的N和numHeads值相等，key、value的N和numKeyValueHeads值相等，并且numHeads是numKeyValueHeads的倍数关系。
非连续场景下，参数key、value的tensorlist中tensor的个数等于query的B，shape需要完全一致。
query，key，value输入，功能使用限制如下：
- Atlas A2训练系列产品支持B轴小于等于65535，支持N轴小于等于256，支持S轴小于等于262144，支持D轴小于等于512。
- Atlas 推理系列加速卡产品支持B轴小于等于256，支持N轴小于等于256，支持S轴小于等于65536，支持D轴小于等于512。paga attention使能的场景下，仅支持S轴小于等于8192。
- query、key、value输入均为INT8的场景暂不支持。
INT8量化相关入参数量与输入、输出数据格式的综合限制：
- query、key、value输入为FLOAT16，输出为INT8的场景：入参quantScale2必填，quantOffset2可选，不能传入dequantScale1、quantScale1、dequantScale2（即为nullptr）参数。
pseShift功能使用限制如下：
- pseShift数据类型需与query数据类型保持一致。
- 仅支持D轴对齐，即D轴可以被16整除。
page attention的使能必要条件是blocktable存在且有效，同时key、value是按照blocktable中的索引在一片连续内存中排布，支持key、value dtype为FLOAT16、BFLOAT16、INT8。
page attention的使能场景下，blockSize是用户自定义的参数，该参数的取值会影响page attention的性能。key、value输入类型为FLOAT16/BFLOAT16时需要16对齐，key、value 输入类型为INT8时需要32对齐，推荐使用128。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。
blocktable当前支持的maxBlockNumPerSeq最大为16k，超过16k会被拦截报错；如果遇到S超大导致maxBlockNumPerSeq超过16k，可以调大blockSize解决。
page attention场景的参数key、value各自对应tensor的shape所有维度相乘不能超过int32的表示范围。
进行per-channel后量化时，不能同时使能page attention。

调用示例（以Atlas A2训练系列产品为例）

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

[object Object]