aclnnPromptFlashAttention

产品支持情况

产品	是否支持
[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]	×

功能说明

• 算子功能：全量推理场景的FlashAttention算子。

• 计算公式：

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

函数原型

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

• aclnnStatus aclnnPromptFlashAttentionGetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *pseShift, const aclTensor *attenMask, const aclIntArray *actualSeqLengths, int64_t numHeads, double scaleValue, int64_t preTokens, int64_t nextTokens, char* inputLayout, int64_t numKeyValueHeads, const aclTensor *attentionOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnPromptFlashAttention(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnPromptFlashAttentionGetWorkspaceSize

• 参数说明：

  • query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q，数据类型与key的数据类型需满足数据类型推导规则，即保持与key、value的数据类型一致。不支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16
  • key（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入K，数据类型与query的数据类型需满足数据类型推导规则，即保持与query、value的数据类型一致。不支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16
  • value（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入V，数据类型与query的数据类型需满足数据类型推导规则，即保持与query、key的数据类型一致。不支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持FLOAT16
  • pseShift（aclTensor*，计算输入）：Device侧的aclTensor，数据类型与query的数据类型需满足数据类型推导规则。不支持undefined，undefined支持ND。预留参数，暂未使用，目前该参数会被强制设置为nullptr。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr
  • attenMask（aclTensor*，计算输入）：Device侧的aclTensor，代表下三角全为0上三角全为负无穷的倒三角mask矩阵，不支持undefined。undefined支持ND。如果不使用该功能可传入nullptr。通常建议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为query的shape中的S，KV_S为key和value的shape中的S，对于attenMask的KV_S为非32字节对齐的场景，建议padding到32字节对齐来提高性能，多余部分填充成1。综合约束请见undefined。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持BOOL、INT8、UINT8
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型仅支持BOOL
  • actualSeqLengths（aclIntArray*，计算输入）：Host侧的aclIntArray，代表不同Batch中query的有效Sequence Length。如果不指定seqlen可以传入nullptr，表示和query的shape的S长度相同。限制：该入参中每个batch中的有效Sequence Length应该不大于query中对应batch的Sequence Length。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT64
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持nullptr
  • numHeads（int64_t，计算输入）：Host侧的int，代表query的head个数，数据类型支持INT64。限制：在BNSD/NSD场景下，需要与shape中的query的N轴shape值相同。
  • scaleValue（double，计算输入）：Host侧的double，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE。数据类型与query的数据类型需满足数据类型推导规则。用户不特意指定时建议传入1.0。
  • preTokens（int64_t，计算输入）：Host侧的int，用于稀疏计算，表示attention需要和前几个Token计算关联。用户不特意指定时建议传入2147483647，支持负数。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT64
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值2147483647
  • nextTokens（int64_t，计算输入）：Host侧的int，用于稀疏计算，表示attention需要和后几个Token计算关联。数据类型支持INT64。用户不特意指定时建议传入0，支持负数。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT64
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0和2147483647
  • inputLayout（char*，计算输入）：Host侧的字符指针CHAR*，用于标识输入query、key、value的数据排布格式，当前支持BSH、BSND、BNSD、BNSD_BSND(输入为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侧的int，代表key、value中head个数，用于支持GQA（Grouped-Query Attention，分组查询注意力）场景。用户不特意指定时建议传入0，表示key/value和query的head个数相等。限制：需要满足numHeads整除numKeyValueHeads，numHeads与numKeyValueHeads的比值不能大于64，且在BSND、BNSD、BNSD_BSND场景下，需要与shape中的key/value的N轴shape值相同，否则报错。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持INT64
    • [object Object]Atlas 推理系列加速卡产品[object Object]：仅支持取值0
  • attentionOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出，undefined支持ND。限制：当inputLayout为BNSD_BSND时，输入query的shape是BNSD，输出shape为BSND；其余情况该入参的shape需要与入参query的shape保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：数据类型支持FLOAT16、BFLOAT16、INT8
    • [object Object]Atlas 推理系列加速卡产品[object Object]：数据类型支持FLOAT16
  • workspaceSize（uint64_t*，出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnPromptFlashAttention

• 参数说明：

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

• 返回值：

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

约束说明

• 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
• 入参为空的处理：算子内部需要判断参数query是否为空，如果是空则直接返回。参数query不为空Tensor，参数key、value为空tensor（即S2为0），则attentionOut填充为全零。attentionOut为空Tensor时，AscendCLNN框架会处理。其余在上述参数说明中标注了"可传入nullptr"的入参为空指针时，不进行处理。
• query，key，value输入，功能使用限制如下：
  • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]：
    • 支持B轴小于等于65536(64k)，输入类型包含INT8时D轴非32对齐或输入类型为FLOAT16或BFLOAT16时D轴非16对齐时，B轴仅支持到128；
    • 支持N轴小于等于256；
    • 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。
    • 支持D轴小于等于512。inputLayout为BSH或者BSND时，要求N*D小于65535。
  • [object Object]Atlas 推理系列加速卡产品[object Object]：
    • 支持B轴小于等于128；
    • 支持N轴小于等于256；
    • 支持S轴小于等于65535(64k), Q_S或KV_S非128对齐，Q_S和KV_S不等长的场景不支持配置atten_mask；
    • 支持D轴小于等于512。
• 当attenMask数据类型取INT8、UINT8时，其tensor中的值需要为0或1。

调用示例

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