torch_npu.npu_fused_infer_attention_score

功能描述

• 算子功能：适配增量&全量推理场景的FlashAttention算子，既可以支持全量计算场景（PromptFlashAttention），也可支持增量计算场景（IncreFlashAttention）。当Query矩阵的S为1，进入IncreFlashAttention分支，其余场景进入PromptFlashAttention分支。
• 计算公式：

  

接口原型

1

torch_npu.npu_fused_infer_attention_score(Tensor query, Tensor key, Tensor value, *, Tensor? pse_shift=None, Tensor? atten_mask=None, SymInt[]? actual_seq_lengths=None, SymInt[]? actual_seq_lengths_kv=None, Tensor? dequant_scale1=None, Tensor? quant_scale1=None, Tensor? dequant_scale2=None, Tensor? quant_scale2=None, Tensor? quant_offset2=None, Tensor? antiquant_scale=None, Tensor? antiquant_offset=None, Tensor? block_table=None, Tensor? query_padding_size=None, Tensor? kv_padding_size=None, Tensor? key_antiquant_scale=None, Tensor? key_antiquant_offset=None, Tensor? value_antiquant_scale=None, Tensor? value_antiquant_offset=None, Tensor? key_shared_prefix=None, Tensor? value_shared_prefix=None, Tensor? actual_shared_prefix_len=None,Tensor? query_rope=None, Tensor? key_rope=None, Tensor? key_rope_antiquant_scale=None, int num_heads=1, float scale=1.0, int pre_tokens=2147483647, int next_tokens=2147483647, str input_layout="BSH", int num_key_value_heads=0, int sparse_mode=0, int inner_precise=0, int block_size=0, int antiquant_mode=0, bool softmax_lse_flag=False, int key_antiquant_mode=0, int value_antiquant_mode=0) -> (Tensor, Tensor)

参数说明

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

• query：Tensor类型，attention结构的Query输入，数据类型支持float16、bfloat16、int8，不支持非连续的Tensor，数据格式支持ND。
• key：Tensor类型，attention结构的Key输入，不支持非连续的Tensor，数据格式支持ND。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：数据类型支持float16、bfloat16、int8、int4（int32）。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：数据类型支持float16、bfloat16、int8、int4（int32）。
• value：Tensor类型，attention结构的Value输入，不支持非连续的Tensor，数据格式支持ND。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：数据类型支持float16、bfloat16、int8、int4（int32）。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：数据类型支持float16、bfloat16、int8、int4（int32）。
• *：代表其之前的变量是位置相关，需要按照顺序输入，必选；之后的变量是键值对赋值的，位置无关，可选（不输入会使用默认值）。
• pse_shift：Tensor类型，在attention结构内部的位置编码参数，数据类型支持float16、bfloat16，数据类型与query的数据类型需满足数据类型推导规则。不支持非连续的Tensor，数据格式支持ND。如不使用该功能时可传入None。
  • Q_S不为1，要求在pse_shift为float16类型时，此时的query为float16或int8类型；而在pse_shift为bfloat16类型时，要求此时的query为bfloat16类型。输入shape类型需为(B, N, Q_S, KV_S)或(1, N, Q_S, KV_S)，其中Q_S为query的shape中的S，KV_S为key和value的shape中的S。对于pse_shift的KV_S为非32对齐的场景，建议padding到32字节来提高性能，多余部分的填充值不做要求。
  • Q_S为1，要求在pse_shift为float16类型时，此时的query为float16类型；而在pse_shift为bfloat16类型时，要求此时的query为bfloat16类型。输入shape类型需为(B, N, 1, KV_S)或(1, N, 1, KV_S)，其中N为num_heads，KV_S为key和value的shape中的S。对于pse_shift的KV_S为非32对齐的场景，建议padding到32字节来提高性能，多余部分的填充值不做要求。
• atten_mask：Tensor类型，对QK的结果进行mask，用于指示是否计算Token间的相关性，数据类型支持bool、int8和uint8。不支持非连续的Tensor，数据格式支持ND。如果不使用该功能可传入None。
  • Q_S不为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为1时建议shape输入(B, KV_S)、(B, 1, KV_S)、(B, 1, 1, KV_S)。

  其中Q_S为query的shape中的S，KV_S为key和value的shape中的S，但如果Q_S、KV_S非16或32对齐，可以向上取到对齐的S。综合约束请见约束说明。

• actual_seq_lengths：int类型数组，代表不同Batch中query的有效seqlen，数据类型支持int64。如果不指定seqlen可以传入None，表示和query的shape的s长度相同。限制：该入参中每个batch的有效seqlen应该不大于query中对应batch的seqlen，Q_S为1时该参数无效。seqlen的传入长度为1时，每个Batch使用相同seqlen；传入长度大于等于Batch时取seqlen的前Batch个数。其他长度不支持。当query的input_layout为TND时，该入参必须传入，且以该入参元素的数量作为Batch值。该入参中每个元素的值表示当前Batch与之前所有Batch的seqlen和，因此后一个元素的值必须大于等于前一个元素的值，且不能出现负值。
• actual_seq_lengths_kv：int类型数组，代表不同Batch中key/value的有效seqlenKv，数据类型支持int64。如果不指定None，表示和key/value的shape的S长度相同。不同O_S值有不同的约束，具体参见约束说明。
• dequant_scale1：Tensor类型，数据类型支持uint64、float32。数据格式支持ND，表示BMM1后面的反量化因子，支持per-tensor。如不使用该功能时传入None。
• quant_scale1：Tensor类型，数据类型支持float32。数据格式支持ND，表示BMM2前面的量化因子，支持per-tensor。如不使用该功能时传入None，综合约束请见约束说明。
• dequant_scale2：Tensor类型，数据类型支持uint64、float32。数据格式支持ND，表示BMM2后面的反量化因子，支持per-tensor。如不使用该功能时传入None。
• quant_scale2：Tensor类型，数据类型支持float32、bfloat16。数据格式支持ND，表示输出的量化因子，支持per-tensor、per-channel。当输入为bfloat16时，同时支持float32和bfloat16 ，否则仅支持float32 。per-channel格式，当输出layout为BSH时，要求quant_scale2所有维度的乘积等于H；其他layout要求乘积等于N*D（建议输出layout为BSH时，quant_scale2shape传入(1, 1, H)或(H,)；输出为BNSD时，建议传入(1, N, 1, D)或(N, D)；输出为BSND时，建议传入(1, 1, N, D)或(N, D)）。如不使用该功能时可传入None，综合约束请见约束说明。
• quant_offset2：Tensor类型，数据类型支持float32、bfloat16。数据格式支持ND，表示输出的量化偏移，支持per-tensor、per-channel。若传入quant_offset2，需保证其类型和shape信息与quantScale2 一致。如不使用该功能时可传入None，综合约束请见约束说明。
• antiquant_scale：Tensor类型，数据类型支持float16、bfloat16。数据格式支持ND，表示伪量化因子，支持per-tensor、per-channel，Q_S为1时只支持per-channel，Q_S大于等于2时只支持float16，如不使用该功能时可传入None，综合约束请见约束说明。
• antiquant_offset：Tensor类型，数据类型支持float16、bfloat16。数据格式支持ND，表示伪量化偏移，支持per-tensor、per-channel，Q_S为1时只支持per-channel，Q_S大于等于2时只支持float16，如不使用该功能时可传入None，综合约束请见约束说明。
• block_table：Tensor类型，数据类型支持int32。数据格式支持ND。表示PageAttention中KV存储使用的block映射表，如不使用该功能可传入None。
• query_padding_size：Tensor类型，数据类型支持int64。数据格式支持ND。表示Query中每个batch的数据是否右对齐，且右对齐的个数是多少。仅支持Q_S大于1，其余场景该参数无效。用户不特意指定时可传入默认值None。
• kv_padding_size：Tensor类型，数据类型支持int64。数据格式支持ND。表示key、value中每个batch的数据是否右对齐，且右对齐的个数是多少。表示key、value中每个batch的数据是否右对齐，且右对齐的个数是多少。用户不特意指定时可传入默认值None。
• key_antiquant_scale：Tensor类型。数据格式支持ND，kv伪量化参数分离时表示key的反量化因子。如不使用该功能时可传入None，综合约束请见约束说明。通常支持per-channel、per-tensor、per-token、per-tensor叠加per-head、per-token叠加per-head、per-token叠加使用page attention模式管理scale、per-token叠加per head并使用page attention模式管理scale。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：数据类型支持float16、bfloat16、float32。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：数据类型支持float16、bfloat16、float32。
• key_antiquant_offset：Tensor类型，数据类型支持float16、bfloat16、float32。数据格式支持ND，kv伪量化参数分离时表示key的反量化偏移。支持per-channel、per-tensor、per-token、per-tensor叠加per-head、per-token叠加per-head、per-token叠加使用page attention模式管理offset、per-token叠加per head并使用page attention模式管理offset。Q_S大于等于2时仅支持per-token模式，如不使用该功能时可传入None，综合约束请见约束说明。
• value_antiquant_scale：Tensor类型，数据类型支持float16、bfloat16、float32。数据格式支持ND，kv伪量化参数分离时表示value的反量化因子。Q_S大于等于2时仅支持per-token模式，如不使用该功能时可传入None，综合约束请见约束说明。通常支持per-channel、per-tensor、per-token、per-tensor叠加per-head、per-token叠加per-head、per-token叠加使用page attention模式管理scale、per-token叠加per head并使用page attention模式管理scale。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：数据类型支持float16、bfloat16、float32。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：数据类型支持float16、bfloat16、float32。
• value_antiquant_offset：Tensor类型，数据类型支持float16、bfloat16、float32。数据格式支持ND，kv伪量化参数分离时表示value的反量化偏移，支持per-channel、per-tensor、per-token、per-tensor叠加per-head、per-token叠加per-head、per-token叠加使用page attention模式管理offset、per-token叠加per head并使用page attention模式管理offset。Q_S大于等于2时仅支持per-token模式，如不使用该功能时传入None，综合约束请见约束说明。
• key_shared_prefix：Tensor类型，attention结构中Key的系统前缀部分的参数，数据类型支持float16、bfloat16、int8，不支持非连续的Tensor，数据格式支持ND。如不使用该功能时传入None，综合约束请见约束说明。
• value_shared_prefix：Tensor类型，attention结构中Value的系统前缀部分的输入，数据类型支持float16、bfloat16、int8，不支持非连续的Tensor，数据格式支持ND。如不使用该功能时传入None，综合约束请见约束说明。
• actual_shared_prefix_len：Tensor类型，代表key_shared_prefix/value_shared_prefix的有效Sequence Length。数据类型支持int64。如果不指定seqlen可以传入None，表示和key_shared_prefix/value_shared_prefix的s长度相同。限制：该入参中的有效Sequence Length应该不大于key_shared_prefix/value_shared_prefix中的Sequence Length。
• query_rope：Tensor类型，表示MLA（Multi-head Latent Attention）结构中的query的rope信息，数据类型支持float16、bfloat16、int8，不支持非连续的Tensor，数据格式支持ND。仅支持Q_S等于1，其余场景该参数无效。如不使用该功能时传入None。
• key_rope：Tensor类型，表示MLA（Multi-head Latent Attention）结构中的key的rope信息，数据类型支持float16、bfloat16、int8，不支持非连续的Tensor，数据格式支持ND。仅支持Q_S等于1，其余场景该参数无效。如不使用该功能时传入None。
• key_rope_antiquant_scale：Tensor类型，预留参数，暂未使用，使用默认值即可。
• num_heads：整型，代表query的head个数，数据类型支持int64，在BNSD场景下，需要与shape中的query的N轴shape值相同，否则执行异常。
• scale：浮点型，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持float。数据类型与query的数据类型需满足数据类型推导规则。用户不特意指定时可传入默认值1.0。
• pre_tokens：整型，用于稀疏计算，表示attention需要和前几个Token计算关联，数据类型支持int64。用户不特意指定时可传入默认值2147483647，Q_S为1时该参数无效。
• next_tokens：整型，用于稀疏计算，表示attention需要和后几个Token计算关联。数据类型支持int64。用户不特意指定时可传入默认值2147483647，Q_S为1时该参数无效。
• input_layout：字符串类型，用于标识输入query、key、value的数据排布格式，当前支持BSH、BSND、BNSD、BNSD_BSND（输入为BNSD时，输出格式为BSND，仅支持Q_S大于1）。用户不特意指定时可传入默认值"BSH"。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：支持BSH、BSND、BNSD、BNSD_BSND、TND(不支持左padding、tensorlist、pse、page attention、prefix、伪量化、全量化、后量化，综合约束请见约束说明)。当input_layout为TND时，不支持图模式配置Tiling调度优化(tiling_schedule_optimize=True)、reduce-overhead执行模式(config.mode="reduce-overhead")功能。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持BSH、BSND、BNSD、BNSD_BSND、TND(不支持左padding、tensorlist、pse、page attention、prefix、伪量化、全量化、后量化，综合约束请见约束说明)。当input_layout为TND时，不支持图模式配置Tiling调度优化(tiling_schedule_optimize=True)、reduce-overhead执行模式(config.mode="reduce-overhead")功能。

• num_key_value_heads：整型，代表key、value中head个数，用于支持GQA（Grouped-Query Attention，分组查询注意力）场景，数据类型支持int64。用户不特意指定时可传入默认值0，表示key/value和query的head个数相等，需要满足num_heads整除num_key_value_heads，num_heads与num_key_value_heads的比值不能大于64。在BSND、BNSD、BNSD_BSND（仅支持Q_S大于1）场景下，还需要与shape中的key/value的N轴shape值相同，否则执行异常。
• sparse_mode：整型，表示sparse的模式。数据类型支持int64。Q_S为1时该参数无效。
  • sparse_mode为0时，代表defaultMask模式，如果atten_mask未传入则不做mask操作，忽略pre_tokens和next_tokens（内部赋值为INT_MAX）；如果传入，则需要传入完整的atten_mask矩阵（S1*S2），表示pre_tokens和next_tokens之间的部分需要计算。
  • sparse_mode为1时，代表allMask，必须传入完整的attenmask矩阵（S1*S2）。
  • sparse_mode为2时，代表leftUpCausal模式的mask，需要传入优化后的atten_mask矩阵（2048*2048）。
  • sparse_mode为3时，代表rightDownCausal模式的mask，对应以右顶点为划分的下三角场景，需要传入优化后的atten_mask矩阵（2048*2048）。
  • sparse_mode为4时，代表band模式的mask，需要传入优化后的atten_mask矩阵（2048*2048）。
  • sparse_mode为5、6、7、8时，分别代表prefix、global、dilated、block_local，均暂不支持。用户不特意指定时可传入默认值0。综合约束请见约束说明。
• inner_precise：整型，一共4种模式：0、1、2、3。一共两位bit位，第0位（bit0）表示高精度或者高性能选择，第1位（bit1）表示是否做行无效修正。数据类型支持int64。Q_S>1时，sparse_mode为0或1，并传入用户自定义mask的情况下，建议开启行无效；Q_S为1时该参数仅支持innerPrecise为0和1。综合约束请见约束说明。
  • inner_precise为0时，代表开启高精度模式，且不做行无效修正。
  • inner_precise为1时，代表高性能模式，且不做行无效修正。
  • inner_precise为2时，代表开启高精度模式，且做行无效修正。
  • inner_precise为3时，代表高性能模式，且做行无效修正。
  

  bfloat16和int8不区分高精度和高性能，行无效修正对float16、bfloat16和int8均生效。当前0、1为保留配置值，当计算过程中“参与计算的mask部分”存在某整行全为1的情况时，精度可能会有损失。此时可以尝试将该参数配置为2或3来使能行无效功能以提升精度，但是该配置会导致性能下降。

• block_size：整型，PageAttention中KV存储每个block中最大的token个数，默认为0，数据类型支持int64。
• antiquant_mode：整型，表示伪量化方式，传入0时表示为per-channel（per-channel包含per-tensor），传入1时表示per-token。Q_S大于等于2时该参数无效，用户不特意指定时可传入默认值0，传入0和1之外的其他值会执行异常。
• softmax_lse_flag：布尔型，表示是否输出softmax_lse，支持S轴外切（增加输出）。true表示输出softmax_lse，false表示不输出；用户不特意指定时可传入默认值false。
• key_antiquant_mode：整型，表示key的伪量化方式。Q_S大于等于2时仅支持传入值为1，用户不特意指定时可传入默认值0，取值除了key_antiquant_mode为0并且value_antiquant_mode为1的场景外，需要与value_antiquant_mode一致。综合约束请见约束说明。

  Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：支持取值0、1、2、3、4、5。

  Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持取值0、1、2、3、4、5。

  • key_antiquant_mode为0时，代表per-channel模式（per-channel包含per-tensor）。
  • key_antiquant_mode为1时，代表per-token模式。
  • key_antiquant_mode为2时，代表per-tensor叠加per-head模式。
  • key_antiquant_mode为3时，代表per-token叠加per-head模式。
  • key_antiquant_mode为4时，代表per-token叠加使用page attention模式管理scale/offset模式。
  • key_antiquant_mode为5时，代表per-token叠加per head并使用page attention模式管理scale/offset模式。
• value_antiquant_mode：整型，表示value的伪量化方式，模式编号与key_antiquant_mode一致。Q_S大于等于2时仅支持传入值为1，用户不特意指定时可传入默认值0，取值除了key_antiquant_mode为0并且value_antiquant_mode为1的场景外，需要与key_antiquant_mode一致。综合约束请见约束说明。
  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：支持取值0、1、2、3、4、5。
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持取值0、1、2、3、4、5。

输出说明

• attention_out：Tensor类型，公式中的输出，数据类型支持float16、bfloat16、int8。数据格式支持ND。限制：当input_layout为BNSD_BSND时，输入query的shape是BNSD，输出shape为BSND；其余情况该参数的shape需要与入参query的shape保持一致。
• softmaxLse：Tensor类型，ring attention算法对query乘key的结果，先取max得到softmax_max。query乘key的结果减去softmax_max，再取exp，最后取sum，得到softmax_sum，最后对softmax_sum取log，再加上softmax_max得到的结果。数据类型支持float32，softmax_lse_flag为True时，输出shape为(B, N, Q_S, 1)的Tensor；softmax_lse_flag为False时，则输出shape为[1]的值为0的Tensor。

约束说明

• 该接口仅在推理场景下使用。
• 该接口支持图模式（目前仅支持PyTorch 2.1版本）。
• 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
• 入参为空的处理：算子内部需要判断参数query是否为空，如果是空则直接返回。参数query不为空Tensor，参数key、value为空tensor（即S2为0），则填充全零的对应shape的输出（填充attention_out）。attention_out为空Tensor时，框架会处理。
• 参数key、value中对应tensor的shape需要完全一致；非连续场景下key、value的tensorlist中的batch只能为1，个数等于query的B，N和D需要相等。
• int8量化相关入参数量与输入、输出数据格式的综合限制：
  • 输入为int8，输出为int8的场景：入参dequant_scale1、quant_scale1、dequant_scale2、quant_scale2需要同时存在，quant_offset2可选，不传时默认为0。
  • 输入为int8，输出为float16的场景：入参dequant_scale1、quant_scale1、dequant_scale2需要同时存在，若存在入参quant_offset2或quant_scale2（即不为None），则报错并返回。
  • 输入全为float16或bfloat16，输出为int8的场景：入参quant_scale2需存在，quant_offset2可选，不传时默认为0，若存在入参dequant_scale1或quant_scale1或dequant_scale2（即不为None），则报错并返回。
  • 入参quant_offset2和quant_scale2支持per-tensor或per-channel格式，数据类型支持float32、bfloat16。
• antiquant_scale和antiquant_offset参数约束：
  • 支持per-channel、per-tensor和per-token三种模式：
    • per-channel模式：两个参数BNSD场景下shape为(2, N, 1, D)，BSND场景下shape为(2, N, D)，BSH场景下shape为(2, H)，N为num_key_value_heads。参数数据类型和query数据类型相同，antiquant_mode置0，当key、value数据类型为int8时支持。
    • per-tensor模式：两个参数的shape均为(2,)，数据类型和query数据类型相同，antiquant_mode置0，当key、value数据类型为int8时支持。
    • per-token模式：两个参数的shape均为(2, B, S), 数据类型固定为float32，antiquant_mode置1，当key、value数据类型为int8时支持。

    算子运行在何种模式根据参数的shape进行判断，dim为1时运行per-tensor模式，否则运行per-channel模式。

  • 支持对称量化和非对称量化：
    • 非对称量化模式下，antiquant_scale和antiquant_offset参数需同时存在。
    • 对称量化模式下，antiquant_offset可以为空（即None）；当antiquant_offset参数为空时，执行对称量化，否则执行非对称量化。
• query_rope和key_rope参数约束：
  • query_rope的数据类型、数据格式与query一致，配置时要求query的S为1-16、N为32、64、128，D为512，shape中B、N、S与query一致，D为64。
  • key_rope的数据类型、数据格式与key一致，配置时要求key的N为1，D为512，key_rope的shape中B、N、S与key一致，D为64。
  • query_rope和key_rope要求同时配置或同时不配置，不支持只配置其中一个。
  • 当query_rope和key_rope非空时，支持如下特性：
    • sparse：Q_S等于1时只支持sparse=0且不传mask，Q_S大于1时只支持sparse=3且传入mask；
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：支持key、value的input_layout格式为ND或NZ。当input_layout为NZ时，输入参数key和value的格式为[blockNum, N, D/16, blockSize, 16]。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持key、value的input_layout格式为ND或NZ。当input_layout为NZ时，输入参数key和value的格式为[blockNum, N, D/16, blockSize, 16]。
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：input_layout形状支持BSH、BSND、BNSD，当数据格式为NZ时input_layout不支持BNSD。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：input_layout的形状支持BSH、BSND、BNSD，当数据格式为NZ时input_layout不支持BNSD。
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：该场景下，必须开启PageAttention，此时block_size支持16、128，其中数据格式为NZ时block_size不支持配置16。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：该场景下，必须开启PageAttention，此时block_size支持16、128，其中数据格式为NZ时block_size不支持配置16。
  • 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单独的actual_seq_lengths < actual_seq_lengths_kv。
• 当Q_S大于1时：
  • query、key、value输入，功能使用限制如下：
    • 支持B轴小于等于65536，D轴32byte不对齐时仅支持到128。
    • 支持N轴小于等于256，支持D轴小于等于512；input_layout为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的乘积较大）场景包括但不限于：
      • B=1，Q_N=20，Q_S=2097152，D=256，KV_N=1，KV_S=2097152。
      • B=1，Q_N=2，Q_S=20971520，D=256，KV_N=2，KV_S=20971520。
      • B=20，Q_N=1，Q_S=2097152，D=256，KV_N=1，KV_S=2097152。
      • B=1，Q_N=10，Q_S=2097152，D=512，KV_N=1，KV_S=2097152。
    • query、key、value输入类型包含int8时，D轴需要32对齐；输入类型全为float16、bfloat16时，D轴需16对齐。
  • actual_seq_lengths_kv入参，传入时应为非负数，在input_layout不同时，其含义与拦截条件不同：一般情况下，该入参为可选入参，该入参中每个Batch的有效seqlenKv应该不大于key/value中对应Batch的seqlenKv。当本参数的传入长度为1时，每个Batch使用相同seqlenKv；传入长度大于等于Batch时取seqlenKv的前Batch个数。其他长度不支持。当key/value的input_layout为TND时，该入参必须传入，且该入参元素的数量等于Batch值。该入参中每个元素的值表示当前Batch与之前所有Batch的seqlenKv和，因此后一个元素的值必须大于等于前一个元素的值，且不能出现负值。
  • actual_seq_lengths_kv：传入该参数时应为非负数，在input_layout不同时，其含义与拦截条件不同：一般情况下，该入参为可选入参，该入参中每个Batch的有效seqlenKv应该不大于key/value中对应Batch的seqlenKv。当本参数的传入长度为1时，每个Batch使用相同seqlenKv；传入长度大于等于Batch时取seqlenKv的前Batch个数。其他长度不支持。当key/value的input_layout为TND时，该入参必须传入，且该入参元素的数量等于Batch值。该入参中每个元素的值表示当前Batch与之前所有Batch的seqlenKv和，因此后一个元素的值必须大于等于前一个元素的值，且不能出现负值。
  • 参数sparse_mode当前仅支持值为0、1、2、3、4的场景，取其它值时会报错。
    • sparse_mode=0时，atten_mask如果为None，或者在左padding场景传入atten_mask，则忽略入参pre_tokens、next_tokens（内部赋值为INT_MAX）。
    • sparse_mode=2、3、4时，atten_mask的shape需要为(S, S)或(1, S, S)或(1, 1, S, S)，其中S的值需要固定为2048，且需要用户保证传入的atten_mask为下三角，不传入atten_mask或者传入的shape不正确报错。
    • sparse_mode=1、2、3的场景忽略入参pre_tokens、next_tokens并按照相关规则赋值。
  • kvCache反量化的合成参数场景仅支持int8反量化到float16。入参key、value的data range与入参antiquant_scale的data range乘积范围在（-1, 1）内，高性能模式可以保证精度，否则需要开启高精度模式来保证精度。
  • page attention场景:
    • page attention的使能必要条件是block_table存在且有效，同时key、value是按照block_table中的索引在一片连续内存中排布，支持key、value数据类型为float16、bfloat16、int8。在该场景下key、value的input_layout参数无效。block_table中填充的是blockid，当前不会对blockid的合法性进行校验，需用户自行保证。

    • block_size是用户自定义的参数，该参数的取值会影响page attention的性能，在使能page attention场景下，block_size最小为128，最大为512，且要求是128的倍数。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。

    • page attention场景下，当输入kv cache排布格式为（blocknum, blocksize, H），且KV_N*D超过65535时，受硬件指令约束，会被拦截报错。可通过使能GQA（减小KV_N）或调整kv cache排布格式为（blocknum, KV_N, blocksize, D）解决。当query的input_layout为BNSD时，kv cache排布支持（blocknum, blocksize, H）和（blocknum, KV_N, blocksize, D）两种格式，当query的inputLayout为BSH、BSND时，kv cache排布只支持（blocknum, blocksize, H）一种格式。blocknum不能小于根据actual_seq_lengths_kv和blockSize计算的每个batch的block数量之和。且key和value的shape需保证一致。
    • page attention不支持伪量化场景，不支持tensorlist场景，不支持左padding场景。
    • page attention场景下，必须传入actual_seq_lengths_kv。
    • page attention场景下，block_table必须为二维，第一维长度需等于B，第二维长度不能小于maxBlockNumPerSeq（maxBlockNumPerSeq为不同batch中最大actual_seq_lengths_kv对应的block数量）。
    • page attention场景下，不支持输入query为int8的场景。
    • 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左padding场景query的搬运起点计算公式为：Q_S-query_padding_size-actual_seq_lengths。query的搬运终点计算公式为：Q_S-query_padding_size。其中query的搬运起点不能小于0，终点不能大于Q_S，否则结果将不符合预期。
    • query左padding场景kv_padding_size小于0时将被置为0。
    • query左padding场景需要与actual_seq_lengths参数一起使能，否则默认为query右padding场景。
    • query左padding场景不支持PageAttention，不能与block_table参数一起使能。
  • kv左padding场景：
    • kv左padding场景key和value的搬运起点计算公式为：KV_S-kv_padding_size-actual_seq_lengths_kv。key和value的搬运终点计算公式为：KV_S-kv_padding_size。其中key和value的搬运起点不能小于0，终点不能大于KV_S，否则结果将不符合预期。
    • kv左padding场景kv_padding_size小于0时将被置为0。
    • kv左padding场景需要与actual_seq_lengths_kv参数一起使能，否则默认为kv右padding场景。
    • kv左padding场景不支持PageAttention，不能与block_table参数一起使能。
  • 入参quant_scale2和quant_offset2支持per-tensor、per-channel量化，支持float32、bfloat16类型。若传入quant_offset2，需保证其类型和shape信息与quant_scale2一致。当输入为bfloat16时，同时支持float32和bfloat16 ，否则仅支持float32。per-channel场景下，当输出layout为BSH时，要求quant_scale2所有维度的乘积等于H；其他layout要求乘积等于N*D。当输出layout为BSH时，quant_scale2 shape建议传入(1, 1, H)或(H,)；当输出layout为BNSD时，建议传入(1, N, 1, D)或(N, D)；当输出为BSND时，建议传入(1, 1, N, D)或(N, D）。
  • 输出为int8，quant_scale2和quant_offset2为per-channel时，暂不支持左padding、Ring Attention或者D非32Byte对齐的场景。
  • 输出为int8时，暂不支持sparse为band且preTokens/nextTokens为负数。
  • pse_shift功能使用限制如下：
    • 支持query数据类型为float16或bfloat16或int8场景下使用该功能。
    • query、key、value数据类型为float16且pse_shift存在时，强制走高精度模式，对应的限制继承自高精度模式的限制。
    • Q_S需大于等于query的S长度，KV_S需大于等于key的S长度。prefix场景KV_S需大于等于actual_shared_prefix_len与key的S长度之和。
  • 输出为int8，入参quant_offset2传入非None和非空tensor值，并且sparse_mode、pre_tokens和next_tokens满足以下条件，矩阵会存在某几行不参与计算的情况，导致计算结果误差，该场景会拦截：
    • sparse_mode=0，atten_mask如果非None，每个batch actual_seq_lengths-actual_seq_lengths_kv-pre_tokens>0或next_tokens<0时，满足拦截条件。
    • sparse_mode=1或 2，不会出现满足拦截条件的情况。
    • sparse_mode=3，每个batch actual_seq_lengths_kv-actual_seq_lengths<0，满足拦截条件。
    • sparse_mode=4，pre_tokens<0或每个batch next_tokens+actual_seq_lengths_kv-actual_seq_lengths<0时，满足拦截条件。
  • prefix相关参数约束：
    • key_shared_prefix和value_shared_prefix要么都为空，要么都不为空。
    • key_shared_prefix和value_shared_prefix都不为空时，key_shared_prefix、value_shared_prefix、key、value的维度相同、dtype保持一致。
    • key_shared_prefix和value_shared_prefix都不为空时，key_shared_prefix的shape第一维batch必须为1，layout为BNSD和BSND情况下N、D轴要与key一致、BSH情况下H要与key一致，value_shared_prefix同理。key_shared_prefix和value_shared_prefix的S应相等。
    • 当actual_shared_prefix_len存在时，actual_shared_prefix_len的shape需要为[1]，值不能大于key_shared_prefix和value_shared_prefix的S。
    • 公共前缀的S加上key或value的S的结果，要满足原先key或value的S的限制。
    • prefix不支持PageAttention场景、不支持左padding场景、不支持tensorlist场景。
    • prefix场景不支持query、key、value数据类型同时为int8。
    • prefix场景，sparse为0或1时，如果传入attenmask，则S2需大于等于actual_shared_prefix_len与key的S长度之和。
    • prefix场景，不支持输入qkv全部为int8的场景。
  • kv伪量化参数分离：
    • key_antiquant_mode和value_antiquant_mode需要保持一致。
    • key_antiquant_scale和value_antiquant_scale要么都为空，要么都不为空；key_antiquant_offset和value_antiquant_offset要么都为空，要么都不为空。
    • key_antiquant_scale和value_antiquant_scale都不为空时，其shape需要保持一致；key_antiquant_offset和value_antiquant_offset都不为空时，其shape需要保持一致。
    • 仅支持per-token模式，且该模式下要求两个参数的shape均为(B, S)，数据类型固定为float32。
    • 当伪量化参数和KV分离量化参数同时传入时，以KV分离量化参数为准。
    • key_antiquant_scale与value_antiquant_scale非空场景，要求query的s小于等于16。
    • key_antiquant_scale与value_antiquant_scale非空场景，要求query的dtype为bfloat16，key、value的dtype为int8，输出的dtype为bfloat16。
    • key_antiquant_scale与value_antiquant_scale非空场景，不支持tensorlist、左padding、page attention、prefix特性。
• 当Q_S等于1时：
  • query、key、value输入，功能使用限制如下：
    • 支持B轴小于等于65536，支持N轴小于等于256，支持S轴小于等于262144，支持D轴小于等于512。
    • query、key、value输入类型均为int8的场景暂不支持。
    • 在int4（int32）伪量化场景下，PyTorch入图调用仅支持KV int4拼接成int32输入（建议通过dynamicQuant生成int4格式的数据，因为dynamicQuant就是一个int32包括8个int4）。
    • 在int4（int32）伪量化场景下，若KV int4拼接成int32输入，那么KV的N、D或者H是实际值的八分之一（prefix同理）。并且，int4伪量化仅支持D 64对齐（int32支持D 8对齐）。
  • actual_seq_lengths_kv入参，传入时应为非负数，在input_layout不同时，其含义与拦截条件不同：一般情况下，该入参为可选入参，该入参中每个Batch的有效Sequence Length应该不大于key/value中对应Batch的seqlenKv。当本参数的传入长度为1时，每个Batch使用相同seqlenKv；传入长度大于等于Batch时取seqlenKv的前Batch个数。其他长度不支持。当input_layout为TND时，该入参必须传入，在非PA场景下，第b个值表示前b个Batch的S轴累加长度，其值应递增（大于等于前一个值）排列，且该入参元素的数量代表总Batch数，在PA场景下，其长度等于key/value的Batch值，代表每个Batch的实际长度，值不大于KV_S。
  • page attention场景：
    • 使能必要条件是block_table存在且有效，同时key、value是按照block_table中的索引在一片连续内存中排布，在该场景下key、value的input_layout参数无效。
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：支持key、value数据类型为float16、bfloat16、int8。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持key、value数据类型为float16、bfloat16、int8。
    • 该场景下，block_size是用户自定义的参数，该参数的取值会影响page attention的性能。key、value输入类型为float16、bfloat16时需要16对齐，key、value输入类型为int8时需要32对齐，推荐使用128。通常情况下，page attention可以提高吞吐量，但会带来性能上的下降。
    • 参数key、value各自对应tensor的shape所有维度相乘不能超过int32的表示范围。
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：不支持Q为bfloat16、float16、key、value为int4（int32）的场景。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持Q为bfloat16、float16、key、value为int4（int32）的场景。
  • kv左padding场景：
    • kvCache的搬运起点计算公式为：Smax-kv_padding_size-actual_seq_lengths。kvCache的搬运终点计算公式为：Smax-kv_padding_size。其中kvCache的搬运起点或终点小于0时，返回数据结果为全0。
    • kv_padding_size小于0时将被置为0。
    • 使能需要同时存在actual_seq_lengths参数，否则默认为kv右padding场景。
    • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：kv左padding场景不支持Q为bfloat16/float16、KV为int4（int32）的场景。
    • Atlas A3 训练系列产品/Atlas A3 推理系列产品：kv左padding场景不支持Q为bfloat16/float16、KV为int4（int32）的场景。
  • kv伪量化参数分离：

    • 除了key_antiquant_mode为0并且value_antiquant_mode为1的场景外，key_antiquant_mode和value_antiquant_mode取值需要保持一致。

    • key_antiquant_scale和value_antiquant_scale要么都为空，要么都不为空；key_antiquant_offset和value_antiquant_offset要么都为空，要么都不为空。
    • key_antiquant_scale和value_antiquant_scale都不为空时，除了key_antiquant_mode为0并且value_antiquant_mode为1的场景外，其shape需要保持一致；key_antiquant_offset和value_antiquant_offset都不为空时，除了key_antiquant_mode为0并且value_antiquant_mode为1的场景外，其shape需要保持一致。
    • int4（int32）伪量化场景不支持后量化。
    • 管理scale/offset的量化模式如下：
      

      注意scale、offset两个参数指key_antiquant_scale、key_antiquant_scale、value_antiquant_offset、value_antiquant_offset。

      量化模式	该场景下scale和offset条件	该场景下key和value条件	支持的产品
      per-channel模式	两个参数shape支持(1, N, 1, D)，(1, N, D)，(1, H)，数据类型和query数据类型相同。	Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：当key、value数据类型为int4（int32）或int8时支持。 Atlas A3 训练系列产品/Atlas A3 推理系列产品：当key、value数据类型为int4（int32）或int8时支持。	Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件 Atlas A3 训练系列产品/Atlas A3 推理系列产品
      per-tensor模式	两个参数的shape均为(1,)，数据类型和query数据类型相同。	Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：当key、value数据类型为int8时支持。 Atlas A3 训练系列产品/Atlas A3 推理系列产品：当key、value数据类型为int8时支持。
      per-token模式	两个参数的shape均为(1, B, S)，数据类型固定为float32。	key、value数据类型为int4（int32）或int8时支持。
      per-tensor叠加per-head模式	两个参数的shape均为(N,)，数据类型和query数据类型相同。	Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：当key、value数据类型为int8时支持。 Atlas A3 训练系列产品/Atlas A3 推理系列产品：当key、value数据类型为int8时支持。
      per-token叠加per-head模式	两个参数的shape均为(B, N, S)，数据类型固定为float32。	key、value数据类型为int4（int32）或int8时支持。
      per-token叠加使用page attention模式	两个参数的shape均为(blocknum, blocksize)，数据类型固定为float32。	key、value数据类型为int8时支持。
      per-token叠加per head并使用page attention模式	两个参数的shape均为(blocknum, N, blocksize)，数据类型固定为float32。	key、value数据类型为int8时支持。
      key支持per-channel叠加value支持per-token模式	对于key支持per-channel，两个参数的shape可支持(1, N, 1, D)、(1, N, D)、(1, H)，且参数数据类型和query数据类型相同。	Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件：当key、value数据类型为int4（int32）或int8时支持；当key和value的数据类型为int8时，仅支持query和输出的dtype为float16。 Atlas A3 训练系列产品/Atlas A3 推理系列产品：当key、value数据类型为int4（int32）或int8时支持；当key和value的数据类型为int8时，仅支持query和输出的dtype为float16。
      	对于value支持per-token，两个参数的shape均为(1, B, S)并且数据类型固定为float32。

  • pse_shift功能使用限制如下：
    • pse_shift数据类型需与query数据类型保持一致。
    • 仅支持D轴对齐，即D轴可以被16整除。

支持的型号

Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件

Atlas A3 训练系列产品/Atlas A3 推理系列产品

调用示例

• 单算子模式调用

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

  import torch import torch_npu import math # 生成随机数据, 并发送到npu q = torch.randn(1, 8, 164, 128, dtype=torch.float16).npu() k = torch.randn(1, 8, 1024, 128, dtype=torch.float16).npu() v = torch.randn(1, 8, 1024, 128, dtype=torch.float16).npu() scale = 1/math.sqrt(128.0) actseqlen = [164] actseqlenkv = [1024] # 调用FIA算子 out, _ = torch_npu.npu_fused_infer_attention_score(q, k, v, actual_seq_lengths = actseqlen, actual_seq_lengths_kv = actseqlenkv, num_heads = 8, input_layout = "BNSD", scale = scale, pre_tokens=65535, next_tokens=65535) # 执行上述代码的输出out类似如下 tensor([[[[ 0.0219, 0.0201, 0.0049, ..., 0.0118, -0.0011, -0.0140], [ 0.0294, 0.0256, -0.0081, ..., 0.0267, 0.0067, -0.0117], [ 0.0285, 0.0296, 0.0011, ..., 0.0150, 0.0056, -0.0062], .. [ 0.0177, 0.0194, -0.0060, ..., 0.0226, 0.0029, -0.0039], [ 0.0180, 0.0186, -0.0067, ..., 0.0204, -0.0045, -0.0164], [ 0.0176, 0.0288, -0.0091, ..., 0.0304, 0.0033, -0.0173]]]], device='npu:0', dtype=torch.float16)

• 图模式调用

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

  # 入图方式 import torch import torch_npu import math import torchair as tng from torchair.configs.compiler_config import CompilerConfig import torch._dynamo TORCHDYNAMO_VERBOSE=1 TORCH_LOGS="+dynamo" # 支持入图的打印宏 import logging from torchair.core.utils import logger logger.setLevel(logging.DEBUG) config = CompilerConfig() config.debug.graph_dump.type = "pbtxt" npu_backend = tng.get_npu_backend(compiler_config=config) from torch.library import Library, impl # 数据生成 q = torch.randn(1, 8, 164, 128, dtype=torch.float16).npu() k = torch.randn(1, 8, 1024, 128, dtype=torch.float16).npu() v = torch.randn(1, 8, 1024, 128, dtype=torch.float16).npu() scale = 1/math.sqrt(128.0) class Model(torch.nn.Module): def __init__(self): super().__init__() def forward(self): return torch_npu.npu_fused_infer_attention_score(q, k, v, num_heads = 8, input_layout = "BNSD", scale=scale, pre_tokens=65535, next_tokens=65535) def MetaInfershape(): with torch.no_grad(): model = Model() model = torch.compile(model, backend=npu_backend, dynamic=False, fullgraph=True) graph_output = model() single_op = torch_npu.npu_fused_infer_attention_score(q, k, v, num_heads = 8, input_layout = "BNSD", scale=scale, pre_tokens=65535, next_tokens=65535) print("single op output with mask:", single_op[0], single_op[0].shape) print("graph output with mask:", graph_output[0], graph_output[0].shape) if __name__ == "__main__": MetaInfershape() # 执行上述代码的输出类似如下 single op output with mask: tensor([[[[ 0.0219, 0.0201, 0.0049, ..., 0.0118, -0.0011, -0.0140], [ 0.0294, 0.0256, -0.0081, ..., 0.0267, 0.0067, -0.0117], [ 0.0285, 0.0296, 0.0011, ..., 0.0150, 0.0056, -0.0062], ..., [ 0.0177, 0.0194, -0.0060, ..., 0.0226, 0.0029, -0.0039], [ 0.0180, 0.0186, -0.0067, ..., 0.0204, -0.0045, -0.0164], [ 0.0176, 0.0288, -0.0091, ..., 0.0304, 0.0033, -0.0173]]]], device='npu:0', dtype=torch.float16) torch.Size([1, 8, 164, 128]) graph output with mask: tensor([[[[ 0.0219, 0.0201, 0.0049, ..., 0.0118, -0.0011, -0.0140], [ 0.0294, 0.0256, -0.0081, ..., 0.0267, 0.0067, -0.0117], [ 0.0285, 0.0296, 0.0011, ..., 0.0150, 0.0056, -0.0062], ..., [ 0.0177, 0.0194, -0.0060, ..., 0.0226, 0.0029, -0.0039], [ 0.0180, 0.0186, -0.0067, ..., 0.0204, -0.0045, -0.0164], [ 0.0176, 0.0288, -0.0091, ..., 0.0304, 0.0033, -0.0173]]]], device='npu:0', dtype=torch.float16) torch.Size([1, 8, 164, 128])