aclnnFusedInferAttentionScoreV3

产品支持情况

[object Object]undefined

功能说明

• 接口功能：适配增量&全量推理场景的FlashAttention算子，既可以支持全量计算场景（PromptFlashAttention），也可支持增量计算场景（IncreFlashAttention）。当Query矩阵的S为1，进入IncreFlashAttention分支，其余场景进入PromptFlashAttention分支。相比于FusedInferAttentionScoreV2，本接口新增queryRopeOptional、keyRopeOptional、keyRopeAntiquantScaleOptional参数。

• 计算公式：

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

函数原型

算子执行接口为，必须先调用“aclnnFusedInferAttentionScoreV3GetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnFusedInferAttentionScoreV3”接口执行计算。

aclnnFusedInferAttentionScoreV3GetWorkspaceSize

• 参数说明

  [object Object]

• 返回值

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

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

  [object Object]

aclnnFusedInferAttentionScoreV3

• 参数说明

  [object Object]

• 返回值

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

约束说明

• 确定性计算：

  • aclnnPromptFlashAttentionV3默认确定性实现。

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

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

• 参数key、value中对应tensor的shape需要完全一致；非连续场景下 key、value的tensorlist中的batch只能为1，个数等于query的B，N和D需要相等。由于tensorlist限制, 非连续场景下B不能大于256。

• 当attenMask数据类型取INT8、UINT8时，其tensor中的值需要为0或1。

• [object Object][object Object]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]）。

• [object Object][object Object]伪量化参数 antiquantScale和antiquantOffset约束：

  • 仅支持kv_dtype为int8的伪量化场景。
  • per-channel模式：两个参数的shape可支持(2, N, 1, D)，(2, N, D)，(2, H)，N为numKeyValueHeads。参数数据类型和query数据类型相同，antiquantMode置0。
  • per-tensor模式：两个参数的shape均为(2)，数据类型和query数据类型相同, antiquantMode置0。
  • per-token模式：两个参数的shape均为(2, B, S), 数据类型固定为FLOAT32, antiquantMode置1。
  • 非对称量化模式下， antiquantScale和antiquantOffset参数需同时存在。
  • 对称量化模式下，antiquantOffset可以为空（即nullptr）；当antiquantOffset参数为空时，执行对称量化，否则执行非对称量化。

• TND、TND_NTD、NTD_TND场景下query，key，value输入的综合限制：

  • actualSeqLengths和actualSeqLengthsKv必须传入，且以该入参元素的数量作为Batch值。该入参中每个元素的值表示当前Batch与之前所有Batch的Sequence Length和，因此后一个元素的值必须大于等于前一个元素的值；
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：
    • sparse模式仅支持sparse=0且不传mask，或sparse=3且传入mask，或sparse=4且传入mask；
    • 当query的d等于512时：
      • 支持TND、TND_NTD;
      • 必须开启page attention，此时actualSeqLengthsKv长度等于key/value的batch值，代表每个batch的实际长度，值不大于KV_S；
      • 支持query每个batch的s为1-16；
      • 要求query的n为32/64/128，key、value的n为1；
      • 要求queryRope和keyRope不等于空，queryRope和keyRope的d为64；
      • 不支持左padding、tensorlist、pse、prefix、伪量化、全量化、后量化；
      • NTD_TND场景，不支持开启SoftMaxLse。
    • 当query的d不等于512时：
      • 当queryRope和keyRope为空时：TND场景，要求Q_D、K_D、V_D相等且小于等于256，或者Q_D、K_D等于192，V_D等于128/192；NTD_TND场景，要求Q_D、K_D等于128/192，V_D等于128。当queryRope和keyRope不为空时，要求Q_D、K_D、V_D等于128；
      • 支持TND、NTD_TND；
      • TND场景，数据类型仅支持FLOAT16、BFLOAT16；NTD_TND场景，数据类型仅支持BFLOAT16；
      • TND场景，当head配比为GQA/MQA时（即必须完整传入numHeads和numKeyValueHeads参数，且numHeads是numKeyValueHeads的整数倍，且二者不相等），有如下约束：
        • 当数据类型为FLOAT16时，支持sparse=0且不传mask，或sparse=3且传入优化后的attentionMask；
        • 当数据类型为BFLOAT16时，支持sparse=0且不传mask，或sparse=3，4且传入优化后的attentionMask；
        • 仅支持innerPrecise=0，即不带行无效的高精度模式；
        • 支持page attention，kv cache排布格式支持BnBsH（blocknum, blocksize, H），H不大于65535，blockSize仅支持128；
      • TND场景，当head配比为MHA时，有如下约束：
        • 当数据类型为FLOAT16时，仅支持sparse=0且不传mask；
        • 当数据类型为FLOAT16时，仅支持innerPrecise=1；
        • 当数据类型为FLOAT16时，不支持page attention；
        • 当数据类型为BFLOAT16时，支持sparse=0且不传mask，或sparse=3，4且传入优化后的attentionMask；
      • NTD_TND场景，不支持page attention；
      • 当sparse=3时，要求每个batch单独的actualSeqLengths < actualSeqLengthsKv；
      • sparse模式支持sparse=4且传入mask；当sparse=4时，要求preTokens >= -actualSeqLengths、nextTokens >= -actualSeqLengthsKv、preTokens + nextTokens >= 0；
      • 不支持左padding、tensorlist、pse、page attention、prefix、伪量化、全量化、后量化；
      • actualSeqLengths和actualSeqLengthsKv的元素个数不大于4096。

• queryRope和keyRope输入时即为MLA场景，参数约束如下：

  • queryRope的数据类型、数据格式与query一致。
  • keyRope的数据类型、数据格式与key一致。
  • queryRope和keyRope要求同时配置或同时不配置，不支持只配置其中一个。
  • 输入queryRope和keyRope时，仅支持如下特性：
    • dtype：FP16、BF16；
    • query的d只支持512/128；
    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：
      • 当配置Q_S大于1（即MTP）时，仅inputLayout为TND时支持配置actualSeqLengths参数，其他layout不支持。
      • 当query的d等于512时：
        • queryRope配置时要求query的s为1-16、n为1、2、4、8、16、32、64、128，queryRope的shape中d为64，其余维度与query一致；
        • keyRope配置时要求key的n为1，d为512，keyRope的shape中d为64，其余维度与key一致；
        • sparse：Q_S等于1时只支持sparse=0且不传mask，Q_S大于1时只支持sparse=3且传入mask；
        • key&value&keyRope支持ND和NZ输入，当输入NZ时，输入格式为[blockNum, N, D/16, blockSize, 16]；
        • inputLayout：BSH、BSND、BNSD、BNSD_NBSD、BSND_NBSD、BSH_NBSD、TND、TND_NTD，其中NZ输入不支持BNSD、BNSD_NBSD；
        • 必须开启page attention：blockSize支持16、128，其中NZ输入不支持配置16；
        • 不支持左padding、tensorlist、pse、prefix、伪量化、全量化、后量化；
      • 当query的d等于128时：
        • inputLayout：TND、NTD_TND；
        • queryRope配置时要求queryRope的shape中d为64，其余维度与query一致；
        • keyRope配置时要求keyRope的shape中d为64，其余维度与key一致；
        • 其余约束同TND、NTD_TND场景下的综合限制保持一致；
        • 不支持左padding、tensorlist、pse、page attention、prefix、伪量化、全量化、后量化。

• numKeyValueHeads使用限制：需要满足numHeads整除numKeyValueHeads，numHeads与numKeyValueHeads的比值不能大于64。在BSND、BNSD、BNSD_BSND场景下，还需要与shape中的key/value的N轴shape值相同，否则执行异常。

• sparseMode使用限制如下：

  [object Object]

• innerPrecise使用限制如下：

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

    [object Object]

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

• keyAntiquantMode使用限制如下：

  [object Object]
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：Q_S等于1时传入0，1，2，3，4，5之外的其他值会执行异常。Q_S大于等于2时仅支持传入值为0、1，其他值会执行异常。

• valueAntiquantMode使用限制如下：

  • 除了keyAntiquantMode为0并且valueAntiquantMode为1的场景外，需要与 keyAntiquantMode 一致。
  • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：Q_S等于1时传入0，1，2，3，4，5之外的其他值会执行异常。Q_S大于等于2时仅支持传入值为0、1，其他值会执行异常。

• softmaxLse使用限制如下：

  • ring attention算法对query乘key的结果，先取max得到softmax_max。query乘key的结果减去softmax_max, 再取exp，接着求sum，得到softmax_sum。最后对softmax_sum取log，再加上softmax_max得到的结果。
  • softmaxLseFlag为True时，一般情况下,shape必须为[B,N,Q_S,1]，当inputLayout为TND/NTD_TND时，shape必须为[T,N,1]。
  • softmaxLseFlag为False时，如果softmaxLse传入的Tensor非空，则直接返回该Tensor数据，如果softmaxLse传入的是nullptr，则返回shape为{1}全0的Tensor。

• 当Q_S大于1时：

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

    • 支持B轴小于等于65536。

    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：如果输入类型为INT8且D轴不是32字节对齐，则B轴的最大支持值为128。若输入类型为FLOAT16或BFLOAT16且D轴不是16字节对齐，B轴同样仅支持到128。

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

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

      [object Object]

    • D轴限制：[object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：query、key、value或attentionOut类型包含INT8时，D轴需要32对齐；query、key、value或attentionOut类型包含INT4时，D轴需要64对齐；类型全为FLOAT16、BFLOAT16时，D轴需16对齐。

  • actualSeqLengths入参，传入时应为非负数。

    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：该入参中每个batch的有效Sequence Length应该不大于query中对应batch的Sequence Length。seqlen的传入长度为1时，每个Batch使用相同seqlen；传入长度大于等于Batch时取seqlen的前Batch个数。其他长度不支持。当query的inputLayout为TND/NTD_TND时。

  • actualSeqLengthsKv入参，传入时应为非负数。

    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：该入参中每个batch的有效Sequence Length应该不大于key/value中对应batch的Sequence Length。seqlenKv的传入长度为1时，每个Batch使用相同seqlenKv；传入长度大于等于Batch时取seqlenKv的前Batch个数。其他长度不支持。当key/value的inputLayout为TND/NTD_TND时。

  • 参数sparseMode当前仅支持值为0、1、2、3、4的场景，取其它值时会报错。

    • sparseMode = 0时，attenMask如果为空指针，或者在左padding场景传入attenMask，则忽略入参preTokens、nextTokens。
    • 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并按照相关规则赋值。

  • kvCache反量化的合成参数场景仅支持query为FLOAT16时，将INT8类型的key和value反量化到FLOAT16。入参key/value的datarange与入参antiquantScale的datarange乘积范围在（-1，1）范围内，高性能模式可以保证精度，否则需要开启高精度模式来保证精度。

  • page attention场景：

    • page attention的使能必要条件是blockTable存在且有效，同时key、value是按照blockTable中的索引在一片连续内存中排布，在该场景下key、value的inputLayout参数无效。blockTable中填充的是blockid，当前不会对blockid的合法性进行校验，需用户自行保证。
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：支持key、value dtype为FLOAT16/BFLOAT16/INT8。
    • blockSize是用户自定义的参数，该参数的取值会影响page attention的性能，在使能page attention场景下，blockSize最小为128, 最大为512，且要求是128的倍数。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。
    • page attention场景下，当输入kv cache排布格式为BnBsH（blocknum, blocksize, H），且 KV_N * D 超过65535时，受硬件指令约束，会被拦截报错。可通过使能GQA（减小 KV_N）或调整kv cache排布格式为BnNBsD（blocknum, KV_N, blocksize, D）解决。当query的inputLayout为BNSD、TND时，kv cache排布支持BnBsH和BnNBsD两种格式，当query的inputLayout为BSH、BSND时，kv cache排布只支持BnBsH一种格式。blocknum不能小于根据actualSeqLengthsKv和blockSize计算的每个batch的block数量之和。且key和value的shape需保证一致。
    • page attention 伪量化场景
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：支持query为FLOAT16/BFLOAT16，支持key、value为INT8。
    • page attention 全量化场景
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：不支持query dtype为INT8。
    • page attention 不支持tensorlist场景，不支持左padding场景。
    • page attention场景下，必须传入actualSeqLengthsKv。
    • page attention场景下，blockTable必须为二维，第一维长度需等于B，第二维长度不能小于maxBlockNumPerSeq（maxBlockNumPerSeq为不同batch中最大actualSeqLengthsKv对应的block数量）。
    • page attention的使能场景下，以下场景输入KV_S需要大于等于maxBlockNumPerSeq * blockSize
      • 传入attenMask时，例如 mask shape为(B, 1, Q_S, KV_S)
      • 传入pseShift时，例如 pseShift shape为(B, N, Q_S, KV_S)

  • query左padding场景：

    • query的搬运起点计算公式为：Q_S - queryPaddingSize - actualSeqLengths。query的搬运终点计算公式为：Q_S - queryPaddingSize。其中query的搬运起点不能小于0，终点不能大于Q_S，否则结果将不符合预期。
    • kvPaddingSize小于0时将被置为0。
    • 需要与actualSeqLengths参数一起使能，否则默认为query右padding场景。
    • 不支持PageAttention，不能与blocktable参数一起使能。
    • 不支持Q为BF16/FP16、KV为INT4的场景。

  • kv左padding场景：

    • key和value的搬运起点计算公式为：KV_S - kvPaddingSize - actualSeqLengthsKv。key和value的搬运终点计算公式为：KV_S - kvPaddingSize。其中key和value的搬运起点不能小于0，终点不能大于KV_S，否则结果将不符合预期。
    • kvPaddingSize小于0时将被置为0。
    • 需要与actualSeqLengthsKv参数一起使能，否则默认为kv右padding场景。
    • 不支持PageAttention，不能与blocktable参数一起使能。
    • 不支持Q为BF16/FP16、KV为INT4的场景。

  • 输出为int8时，quantScale2 和 quantOffset2 为 per-channel 时，暂不支持左padding、Ring Attention或者D非32Byte对齐的场景。

  • 输出为int8时，暂不支持sparse为band且preTokens/nextTokens为负数。

  • pseShift功能使用限制如下：

    • 支持query数据类型为FLOAT16或BFLOAT16或INT8场景下使用该功能。
    • query数据类型为FLOAT16且pseShift存在时，强制走高精度模式，对应的限制继承自高精度模式的限制。
    • Q_S需大于等于query的S长度，KV_S需大于等于key的S长度。prefix场景KV_S需大于等于actualSharedPrefixLen与key的S长度之和。

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

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

  • prefix相关参数约束：

    • keySharedPrefix和valueSharedPrefix要么都为空，要么都不为空
    • keySharedPrefix和valueSharedPrefix都不为空时，keySharedPrefix、valueSharedPrefix、key、value的维度相同、dtype保持一致。
    • keySharedPrefix和valueSharedPrefix都不为空时，keySharedPrefix的shape第一维batch必须为1，layout为BNSD和BSND情况下N、D轴要与key一致、BSH情况下H要与key一致，valueSharedPrefix同理。keySharedPrefix和valueSharedPrefix的S应相等
    • 当actualSharedPrefixLen存在时，actualSharedPrefixLen的shape需要为[1]，值不能大于keySharedPrefix和valueSharedPrefix的S
    • 公共前缀的S加上key或value的S的结果，要满足原先key或value的S的限制
    • prefix不支持PageAttention场景、不支持左padding场景、不支持tensorlist场景
    • prefix场景，sparse为0或1时，如果传入attenmask，则S2需大于等于actualSharedPrefixLen与key的S长度之和
    • prefix场景，不支持输入qkv全部为int8的情况

  • kv伪量化参数分离：

    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：
      • keyAntiquantMode 和 valueAntiquantMode需要保持一致
      • keyAntiquantScale 和 valueAntiquantScale要么都为空，要么都不为空；keyAntiquantOffset 和 valueAntiquantOffset要么都为空，要么都不为空
      • KeyAntiquantScale 和valueAntiquantScale都不为空时，其shape需要保持一致；keyAntiquantOffset 和 valueAntiquantOffset都不为空时，其shape需要保持一致
      • 仅支持per-token和per-channel模式，per-token模式下要求两个参数的shape均为(B, S)，数据类型固定为FLOAT32；per-channel模式下要求两个参数的shape为(N, D)，(N, 1, D)或(H)，数据类型固定为BF16。
      • 当伪量化参数 和 KV分离量化参数同时传入时，以KV分离量化参数为准。
      • keyAntiquantScale与valueAntiquantScale非空场景，要求query的s小于等于16。
      • keyAntiquantScale与valueAntiquantScale非空场景，要求query的dtype为BFLOAT16,key、value的dtype为INT8，输出的dtype为BFLOAT16。
      • keyAntiquantScale与valueAntiquantScale非空场景，不支持tensorlist、左padding、page attention特性。

• 当Q_S等于1时：

  • query，key，value输入，功能使用限制如下：
    • 支持B轴小于等于65536，支持N轴小于等于256，支持D轴小于等于512。
    • query、key、value输入类型均为INT8的场景暂不支持。
    • 在INT4（INT32）伪量化场景下，aclnn单算子调用支持KV INT4输入或者INT4拼接成INT32输入（建议通过dynamicQuant生成INT4格式的数据，因为dynamicQuant就是一个INT32包括8个INT4）。
    • 在INT4（INT32）伪量化场景下，若KV INT4拼接成INT32输入，那么KV的N、D或者H是实际值的八分之一（prefix同理）。
    • key、value在特定数据数据类型下存在对于D轴的限制
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：key、value输入类型为INT4（INT32）时，D轴需要64对齐（INT32仅支持D 8对齐）。
  • actualSeqLengths入参，传入时应为非负数。
    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：当query的inputLayout不为TND时，Q_S为1时该参数无效。当query的inputLayout为TND/TND_NTD时。
  • actualSeqLengthsKv入参，传入时应为非负数。
    • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：该入参中每个batch的有效Sequence Length应该不大于key/value中对应batch的Sequence Length。seqlenKv的传入长度为1时，每个Batch使用相同seqlenKv；传入长度大于等于Batch时取seqlenKv的前Batch个数。其他长度不支持。当key/value的inputLayout为TND/TND_NTD时。
  • page attention场景：
    • page attention的使能必要条件是blocktable存在且有效，同时key、value是按照blocktable中的索引在一片连续内存中排布，在该场景下key、value的inputLayout参数无效。
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：支持key、value dtype为FLOAT16/BFLOAT16/INT8。
    • blockSize是用户自定义的参数，该参数的取值会影响page attention的性能，在使能page attention场景下，blockSize需要传入非0值, 且blocksize最大不超过512。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：key、value输入类型为FLOAT16/BFLOAT16时需要16对齐；key、value 输入类型为INT8时需要32对齐，推荐使用128。
    • page attention场景下，当query的inputLayout为BNSD、TND时，kv cache排布支持BnBsH（blocknum, blocksize, H）和BnNBsD（blocknum, KV_N, blocksize, D）两种格式，当query的inputLayout为BSH、BSND时，kv cache排布只支持BnBsH一种格式。blocknum不能小于根据actualSeqLengthsKv和blockSize计算的每个batch的block数量之和。且key和value的shape需保证一致。
    • page attention场景下，kv cache排布为BnNBsD时性能通常优于kv cache排布为BnBsH时的性能，建议优先选择BnNBsD格式。
    • page attention使能场景下，当输入kv cache排布格式为BnBsH，且 numKvHeads * headDim 超过64k时，受硬件指令约束，会被拦截报错。可通过使能GQA（减小 numKvHeads）或调整kv cache排布格式为BnNBsD解决。
    • page attention不支持tensorlist场景，不支持左padding场景。
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：不支持Q为BF16/FP16、KV为INT4（INT32）的场景。
    • page attention场景下，必须传入actualSeqLengthsKv。
    • page attention场景下，blockTable必须为二维，第一维长度需等于B，第二维长度不能小于maxBlockNumPerSeq（maxBlockNumPerSeq为每个batch中最大actualSeqLengthsKv对应的block数量）。
    • page attention的使能场景下，以下场景输入S需要大于等于blockTable的第二维 * blockSize。
      • 使能Attention mask，如mask shape为 (B, 1, 1, S)。
      • 使能pseShift，如pseShift shape为(B, N, 1, S)。
      • 使能伪量化per-token模式：输入参数antiquantScale和antiquantOffset的shape均为(2, B, S)。
      • 使能per-token叠加per-head模式：两个参数的shape均为(B, N, S)，数据类型固定为FLOAT32，当key、value数据类型为INT8、INT4(INT32)时支持。
      • 使能per-token-group模式：antiquantScale的shape为(1, B, N, S, D/32), 数据类型固定为FLOAT8_E8M0，不支持带antiquantOffset。当key、value数据类型为FLOAT4_E1M2、FLOAT4_E2M1时支持。
    • kv左padding场景：
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：不支持Q为BF16/FP16、KV为INT4（INT32）的场景。
      • kvCache的搬运起点计算公式为：KV_S - kvPaddingSize - actualSeqLengths。kvCache的搬运终点计算公式为：KV_S - kvPaddingSize。其中kvCache的搬运起点或终点小于0时，返回数据结果为全0。
      • kvPaddingSize小于0时将被置为0。
      • 需要与actualSeqLengths参数一起使能，否则默认为kv右padding场景。
      • 不支持PageAttention、tensorlist，否则默认为kv右padding场景。
      • 与attenMask参数一起使能时，需要保证attenMask含义正确，即能够正确的对无效数据进行隐藏。否则将引入精度问题。
    • pseShift功能使用限制如下：
      • pseShift数据类型需与query数据类型保持一致。
    • kv伪量化参数分离：
      • 除了keyAntiquantMode为0并且valueAntiquantMode为1的场景外，keyAntiquantMode 和 valueAntiquantMode需要保持一致
      • keyAntiquantScale 和 valueAntiquantScale要么都为空，要么都不为空；keyAntiquantOffset 和 valueAntiquantOffset要么都为空，要么都不为空
      • KeyAntiquantScale 和valueAntiquantScale都不为空时，除了keyAntiquantMode为0并且valueAntiquantMode为1的场景外，其shape需要保持一致；keyAntiquantOffset 和 valueAntiquantOffset都不为空时，除了keyAntiquantMode为0并且valueAntiquantMode为1的场景外，其shape需要保持一致
      • [object Object]Atlas A2 训练系列产品/Atlas A2 推理系列产品[object Object]：支持per-channel、per-tensor、per-token、per-tensor叠加per-head、per-token叠加per-head、per-token使用page attention模式管理scale/offset、per-token叠加per-head并使用page attention模式管理scale/offset、key支持per-channel叠加value支持per-token八种模式，以下N均为numKeyValueHeads。
        • per-channel模式：两个参数的shape可支持(1, N, 1, D)，(1, N, D)，(1, H)。参数数据类型和query数据类型相同，当key、value数据类型为INT8、INT4(INT32)时支持。
        • per-tensor模式：两个参数的shape均为(1)，数据类型和query数据类型相同，当key、value数据类型为INT8时支持。
        • per-token模式：两个参数的shape均为(1, B, S)，数据类型固定为FLOAT32，当key、value数据类型为INT8、INT4(INT32)时支持。
        • per-tensor叠加per-head模式：两个参数的shape均为(N)，数据类型和query数据类型相同，当key、value数据类型为INT8时支持。
        • key支持per-channel叠加value支持per-token模式：对于key支持per-channel，两个参数的shape可支持(1, N, 1, D)，(1, N, D)，(1, H)且参数数据类型和query数据类型相同；对于value支持per-token，两个参数的shape均为(1, B, S)且数据类型固定为FLOAT32，当key、value数据类型为INT8、INT4(INT32)时支持。当key、value数据类型为INT8时，仅支持query和attentionOut的数据类型为FLOAT16。
      • per-token叠加per-head模式：两个参数的shape均为(B, N, S)，数据类型固定为FLOAT32，当key、value数据类型为INT8、INT4(INT32)时支持。
      • per-token模式使用page attention管理scale/offset模式：两个参数的shape均为(blocknum, blocksize)，数据类型固定为FLOAT32，当key、value数据类型为INT8时支持。
      • per-token叠加per-head模式并使用page attention管理scale/offset模式：两个参数的shape均为(blocknum, N, blocksize)，数据类型固定为FLOAT32，当key、value数据类型为INT8时支持。
      • 当伪量化参数 和 KV分离量化参数同时传入时，以KV分离量化参数为准。
      • INT4（INT32）伪量化场景仅支持KV伪量化参数分离，具体包括：
        • per-channel模式；
        • per-token模式；
        • per-token叠加per-head模式；
        • key支持per-channel叠加value支持per-token模式。
      • INT4（INT32）伪量化场景不支持后量化。
    • prefix相关参数约束：
      • keySharedPrefix和valueSharedPrefix要么都为空，要么都不为空。
      • keySharedPrefix和valueSharedPrefix都不为空时，keySharedPrefix、valueSharedPrefix、key、value的维度相同、dtype保持一致。
      • keySharedPrefix和valueSharedPrefix都不为空时，keySharedPrefix的shape第一维batch必须为1，layout为BNSD和BSND情况下N、D轴要与key一致、BSH情况下H要与key一致，valueSharedPrefix同理。keySharedPrefix和valueSharedPrefix的S应相等。
      • 当actualSharedPrefixLen存在时，actualSharedPrefixLen的shape需要为[1]，值不能大于keySharedPrefix和valueSharedPrefix的S。
      • 公共前缀的S加上key或value的S的结果，要满足原先key或value的S的限制。

调用示例

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