aclnnFlashAttentionScore

产品支持情况

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

功能说明

• 算子功能：训练场景下，使用FlashAttention算法实现self-attention（自注意力）的计算。

• 计算公式：

  注意力的正向计算公式如下：

  $$attention\_out = Dropout(Softmax(Mask(scale*(pse+query*key^T), atten\_mask)), keep\_prob)*value$$

函数原型

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

• aclnnStatus aclnnFlashAttentionScoreGetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *realShiftOptional, const aclTensor *dropMaskOptional, const aclTensor *paddingMaskOptional, const aclTensor *attenMaskOptional, const aclIntArray *prefixOptional, double scaleValue, double keepProb, int64_t preTokens, int64_t nextTokens, int64_t headNum, char *inputLayout, int64_t innerPrecise, int64_t sparseMode, const aclTensor *softmaxMaxOut, const aclTensor *softmaxSumOut, const aclTensor *softmaxOutOut, const aclTensor *attentionOutOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnFlashAttentionScore(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

aclnnFlashAttentionScoreGetWorkspaceSize

• 参数说明：

  • query（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与key/value的数据类型一致，undefined支持ND；综合约束请见undefined。

  • key（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与query/value的数据类型一致，undefined支持ND；综合约束请见undefined。

  • value（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与query/key的数据类型一致，undefined支持ND；综合约束请见undefined。

  • realShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse。数据类型支持FLOAT16、BFLOAT16、FLOAT32。数据类型与query的数据类型一致。undefined支持ND，输入shape类型需为[B,N,S,S]、[B,N,1,Skv]、[1,N,S,S]。如果Sq大于1024的每个batch的Sq与Skv等长且是sparseMode为0、2、3的下三角掩码场景，可使能alibi位置编码压缩，此时只需要输入原始PSE最后1024行进行内存优化，即alibi_compress = ori_pse[:, :, -1024:, :]，参数每个batch不相同时，输入BNHSkv(H=1024)，每个batch相同时，输入1NHSkv(H=1024)。后续章节如无特殊说明，S表示query或key、value的sequence length，Sq表示query的sequence length，Skv表示key、value的sequence length，SS表示Sq*Skv。如不使用该参数可传入nullptr。

  • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的Dropout。数据类型支持UINT8（标识8个1bit BOOL），undefined支持ND，其shape和数据排布可表示为：

    $$(\sum_{b=0}^{B-1} (\sum_{n=0}^{N-1}(Sq*Skv)))/8$$

    如不使用该参数可传入nullptr。

  • paddingMaskOptional（aclTensor*，计算输入）：预留参数，暂未使用。

  • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的atten_mask，取值为1代表该位不参与计算（不生效），为0代表该位参与计算，数据类型支持BOOL、UINT8，undefined支持ND，输入shape类型需为[B,N,S,S]、[B,1,S,S]、[1,1,S,S]、[S,S]；综合约束请见undefined。如不使用该参数可传入nullptr。

  • prefixOptional（aclIntArray*，计算输入）：Host侧的aclIntArray，代表prefix稀疏计算场景每个Batch的N值，数据类型支持INT64，undefined支持ND；综合约束请见undefined。如不使用该参数可传入nullptr。

  • scaleValue（double，计算输入）：Host侧的double，公式中的scale，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE，一般设置为D^-0.5。

  • keepProb（double，计算输入）：Host侧的double，代表dropMaskOptional中1的比例，数据类型支持DOUBLE；综合约束请见undefined。用户不特意指定时建议传入1.0。

  • preTokens（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算 ，表示slides window的左边界，数据类型支持INT64；综合约束请见undefined。用户不特意指定时建议传入2147483647。

  • nextTokens（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算，表示slides window的右边界，数据类型支持INT64；综合约束请见undefined。用户不特意指定时建议传入2147483647。

  • headNum（int64_t，计算输入）：Host侧的int64_t，代表单卡的head个数，即输入query的N轴长度，数据类型支持INT64；综合约束请见undefined。

  • inputLayout（string*，计算输入）：Host侧的string，数据类型支持String，代表输入query、key、value的数据排布格式，支持BSH、SBH、BSND、BNSD。

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

  • innerPrecise（int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，用于提升精度，建议配置为0。

    说明： 当前0、1为保留配置值，2为使能无效行计算，其功能是避免在计算过程中存在整行mask进而导致精度有损失，但是该配置会导致性能下降。 如果算子可判断出存在无效行场景，会自动使能无效行计算，例如sparseMode为3，Sq > Skv场景。

  • sparseMode（int64_t，计算输入）：Host侧的int64_t，表示sparse的模式，数据类型支持INT64，默认配置为0即可，支持配置值为0、1、2、3、4、5、6。当整网的sparseMode都相同且shape小于2048*2048时，建议使用defaultMask模式，来减少内存使用量；sparse不同模式的详细说明请参见undefined。

  • softmaxMaxOut（aclTensor*，计算输出）：Device侧的aclTensor，Softmax计算的Max中间结果，用于反向计算。数据类型支持FLOAT，输出的shape类型为[B,N,Sq,8]，undefined支持ND。

  • softmaxSumOut（aclTensor*，计算输出）：Device侧的aclTensor，Softmax计算的Sum中间结果，用于反向计算。数据类型支持FLOAT，输出的shape类型为[B,N,Sq,8]，undefined支持ND。

  • softmaxOutOut（aclTensor*，计算输出）：预留参数，暂未使用。

  • attentionOutOut（aclTensor*，计算输出）：Device侧的aclTensor，计算公式的最终输出。数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型和shape类型与query保持一致，undefined支持ND。

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

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

• 返回值：

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

  [object Object]

aclnnFlashAttentionScore

• 参数说明：

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

• 返回值：

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

约束说明

• 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
• 输入query、key、value的B：batchsize必须相等。
• 输入query、key、value的D：Head-Dim必须满足(qD == kD && kD >= vD)。
• 输入query、key、value的input_layout必须一致。
• 输入query、key、value、realShiftOptional的数据类型必须一致。
• 输入key/value的shape除D外必须一致。
• 支持输入query的N和key/value的N不相等，但必须成比例关系，即Nq/Nkv必须是非0整数，Nq取值范围1~256。当Nq/Nkv > 1时，即为GQA(grouped-query attention)；当Nkv=1时，即为MQA(multi-query attention)。本文如无特殊说明，N表示的是Nq。
• 关于数据shape的约束，以inputLayout的BSND、BNSD为例（BSH、SBH下H=N*D），其中：
  • B：取值范围为1~2M。带prefixOptional的时候B最大支持2K。
  • N：取值范围为1~256。
  • S：取值范围为1~1M。
  • D：取值范围为1~768。
• 部分场景下，如果计算量过大可能会导致算子执行超时(aicore error类型报错，errorStr为：timeout or trap error)，此时建议做轴切分处理，注：这里的计算量会受B、S、N、D等参数的影响，值越大计算量越大。
• keepProb的取值范围为(0, 1]。
• prefixOptional稀疏计算场景即sparseMode=5或者sparseMode=6，当Sq > Skv时，prefix的N值取值范围[0, Skv]，当Sq <= Skv时，prefix的N值取值范围[Skv-Sq, Skv]。
• band场景，preTokens和nextTokens之间必须要有交集。
• sparseMode配置为1、2、3、5、6时，用户配置的preTokens、nextTokens不会生效；sparseMode配置为0、4时，须保证attenMaskOptional与preTokens、nextTokens的范围一致。
• sparseMode为1、2、3、4、5、6时，应传入对应正确的attenMaskOptional，否则将导致计算结果错误。当attenMaskOptional输入为None时，sparseMode、preTokens、nextTokens参数不生效，固定为全计算。
• realShiftOptional Sq大于1024时，如果配置BNHS、1NHS，需要Sq和Skv等长。

调用示例

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