aclnnIncreFlashAttentionV3

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	×
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列加速卡产品[object Object]	√
[object Object]Atlas 训练系列产品[object Object]	×

功能说明

• 算子功能：兼容undefined接口功能，在其基础上新增位置编码，page attention，kv cache反量化特性。

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

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

  说明：

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$的矩阵。

函数原型

每个算子分为undefined，必须先调用“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)

aclnnIncreFlashAttentionV3GetWorkspaceSize

• 参数说明：

  • query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q，undefined支持ND。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16

  • key（aclTensorList*，计算输入）：Device侧的aclTensorList，公式中的输入K，undefined支持ND。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、INT8、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16

  • value（aclTensorList*，计算输入）：Device侧的aclTensorList，公式中的输入V，undefined支持ND。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、INT8、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16

  • pseShift（aclTensor*，计算输入）：Device侧的aclTensor，可选参数，位置编码参数，数据类型支持FLOAT16、BFLOAT16，undefined支持ND，输入shape为(1,N,1,S)或(B,N,1,S)。如不使用该功能时可传入nullptr。

  • attenMask（aclTensor*，计算输入）：Device侧的aclTensor，可选参数，表示attention掩码矩阵，数据类型支持BOOL、INT8、UINT8，undefined支持ND。

  • actualSeqLengths（aclIntArray*，计算输入）：Host侧的aclIntArray，可选参数，表示key和value的S轴实际长度，数据类型支持INT64。

  • dequantScale1（aclTensor*，计算输入）：Device侧的aclTensor，undefined支持ND，表示BMM1后面反量化的量化因子，支持per-tensor（scalar）。 如不使用该参数可传入nullptr。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持UINT64、FLOAT32
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr

  • quantScale1（aclTensor*，计算输入）：Device侧的aclTensor，undefined支持ND，表示BMM2前面量化的量化因子，支持per-tensor（scalar）。 如不使用该参数可传入nullptr。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT32
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr

  • dequantScale2（aclTensor*，计算输入）：Device侧的aclTensor，undefined支持ND，表示BMM2后面量化的量化因子，支持per-tensor（scalar）。 如不使用该参数可传入nullptr。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持UINT64、FLOAT32
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr

  • quantScale2（aclTensor*，计算输入）：Device侧的aclTensor，undefined支持ND，表示输出量化的量化因子，支持per-tensor，per-channel。 如不使用该参数可传入nullptr。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT32
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr

  • quantOffset2（aclTensor*，计算输入）：Device侧的aclTensor，undefined支持ND，表示输出量化的量化偏移，支持per-tensor，per-channel。 如不使用该参数可传入nullptr。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT32
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr

  • antiquantScale（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16，undefined支持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 ，undefined支持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，undefined支持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。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT64
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0

  • 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，公式中的输出，undefined支持ND。

    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、INT8、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值FLOAT16

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

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

• 返回值：

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

  [object Object]

aclnnIncreFlashAttentionV3

• 参数说明：

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

• 返回值：

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

约束说明

• 参数key、value 中对应tensor的shape需要完全一致。
• 参数query和attentionOut的shape需要完全一致。
• 参数query中的N和numHeads值相等，key、value的N和numKeyValueHeads值相等，并且numHeads是numKeyValueHeads的倍数关系。
• 非连续场景下，参数key、value的tensorlist中tensor的个数等于query的B(由于tensorlist限制, 非连续场景下B需要小于等于256)。shape除S外需要完全一致，且batch只能为1。
• query，key，value输入，功能使用限制如下：
  • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：
    • 支持B轴小于等于65536；
    • 支持N轴小于等于256；
    • 支持D轴小于等于512；
  • [object Object]Atlas 推理系列加速卡产品[object Object]：
    • 支持B轴小于等于256；
    • 支持N轴小于等于256；
    • 支持D轴小于等于512；
    • 支持key、value的S轴小于等于65536；
  • 仅支持query的S轴等于1。
  • query、key、value输入均为INT8的场景暂不支持。
• 当attenMask数据类型取INT8、UINT8时，其tensor中的值需要为0或1。
• INT8量化相关入参数量与输入、输出数据格式的综合限制：
  • query、key、value输入为FLOAT16，输出为INT8的场景：入参quantScale2必填，quantOffset2可选，不能传入dequantScale1、quantScale1、dequantScale2（即为nullptr）参数。
• pseShift功能使用限制如下：
  • pseShift数据类型需与query数据类型保持一致。
• page attention场景:
  • page attention的使能必要条件是blockTable存在且有效，同时key、value是按照blockTable中的索引在一片连续内存中排布，支持key、value dtype为FLOAT16/BFLOAT16/INT8，在该场景下key、value的inputLayout参数无效。
  • blockSize是用户自定义的参数，该参数的取值会影响page attention的性能，在使能page attention场景下，blockSize需要传入非0值, 且blocksize最大不超过512。key、value输入类型为FLOAT16/BFLOAT16时需要16对齐，key、value 输入类型为INT8时需要32对齐，推荐使用128。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。
  • page attention场景下，当query的inputLayout为BNSD时，kv cache排布支持（blocknum, blocksize, H）和（blocknum, KV_N, blocksize, D）两种格式，当query的inputLayout为BSH、BSND时，kv cache排布只支持（blocknum, blocksize, H）一种格式。blocknum不能小于根据actualSeqLengthsKv和blockSize计算的每个batch的block数量之和。且key和value的shape需保证一致。
  • page attention场景下，kv cache排布为（blocknum, KV_N, blocksize, D）时性能通常优于kv cache排布为（blocknum, blocksize, H）时的性能，建议优先选择（blocknum, KV_N, blocksize, D）格式。
  • page attention使能场景下，当输入kv cache排布格式为（blocknum, blocksize, H），且 numKvHeads * headDim 超过64k时，受硬件指令约束，会被拦截报错。可通过使能GQA（减小 numKvHeads）或调整kv cache排布格式为（blocknum, numKvHeads, blocksize, D）解决。
  • page attention场景下，必须传入输入actualSeqLengths。
  • page attention场景下，blockTable必须为二维，第一维长度需等于B，第二维长度不能小于maxBlockNumPerSeq（maxBlockNumPerSeq为每个batch中最大actualSeqLengthsKv对应的block数量）。
  • page attention使能场景下，以下场景输入S需要大于等于maxBlockNumPerSeq * blockSize
  • 使能 Attention mask，如 mask shape为 (B, 1, 1, S)
  • 使能 pseShift，如 pseShift shape为(B, N, 1, S)
  • 使能伪量化 per-token模式：输入参数 antiquantScale和antiquantOffset 的shape均为(2, B, S)
• antiquantScale和antiquantOffset参数约束：
  • 支持per-channel、per-tensor两种模式：
    • per-channel模式：两个参数的shape可支持(2, N, 1, D)，(2, N, D)，(2, H)，N为numKeyValueHeads。参数数据类型和query数据类型相同。
    • per-tensor模式：两个参数的shape均为(2)，数据类型和query数据类型相同。

调用示例

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