---
title: aclnnPromptFlashAttention
description: "每个算子有两段接口，必须先调用“aclnnPromptFlashAttentionGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnPromptFlashAttention”接口执行计算。两段式接口如下："
url: https://www.hiascend.com/document/detail/zh/Atlas200IDKA2DeveloperKit/latest/Application%20Development%20Guide/aadgc/aclcppdevg_03_0610.html
sourcePath: /source/zh/Atlas200IDKA2DeveloperKit/23.0.RC2/Application Development Guide/aadgc/aclcppdevg_03_0610.html
indexId: 137792a34a224bb54016d0a1f4db8a9ebbf55b9d81c4feab05811d52264a91ea105
---
# aclnnPromptFlashAttention

#### 接口原型

每个算子有两段接口，必须先调用“aclnnPromptFlashAttentionGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnPromptFlashAttention”接口执行计算。两段式接口如下：

- 第一段接口：aclnnStatus aclnnPromptFlashAttentionGetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *paddingMask, 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)


#### 功能描述

- 算子功能：全量推理场景的FlashAttention算子。
- 计算公式：
  self-attention（自注意力）利用输入样本自身的关系构建了一种注意力模型。其原理是假设有一个长度为n的输入样本序列x，x的每个元素都是一个d维向量，可以将每个d维向量看作一个token embedding，将这样一条序列经过3个权重矩阵变换得到3个维度为n*d的矩阵。

  self-attention的计算公式一般定义如下，其中Q、K、V为输入样本的重要属性元素，是输入样本经过空间变换得到，且可以统一到一个特征空间中。

  本算子中Score函数采用Softmax函数，self-attention计算公式为

  其中Q和KT的乘积代表输入x的注意力，为避免该值变得过大，通常除以d的开根号进行缩放，并对每行进行softmax归一化，与V相乘后得到一个n*d的矩阵。


#### aclnnPromptFlashAttentionGetWorkspaceSize

- 接口定义：
  aclnnStatus aclnnPromptFlashAttentionGetWorkspaceSize(const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *paddingMask, 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)

- 参数说明：

  - query：Device侧的aclTensor，公式中的输入Q，数据类型支持FLOAT16，不支持非连续的Tensor，数据格式支持ND。
  - key：Device侧的aclTensor，公式中的输入K，数据类型支持FLOAT16，不支持非连续的Tensor，数据格式支持ND。
  - value：Device侧的aclTensor，公式中的输入V，数据类型支持FLOAT16，不支持非连续的Tensor，数据格式支持ND。
  - paddingMask：Device侧的aclTensor，可选参数，数据类型支持FLOAT16，不支持非连续的Tensor，数据格式支持ND。
  - attenMask：Device侧的aclTensor，可选参数，代表下三角全为0上三角全为负无穷的倒三角mask矩阵，不支持非连续的Tensor，数据类型支持BOOL、FLOAT16，数据格式支持ND。
  - actualSeqLengths：Host侧的aclIntArray，可选参数，代表不同Batch中query的Sequence Length，数据类型支持INT64。
  - numHeads：Host侧的int，代表head个数，数据类型支持INT64。
  - scaleValue：Host侧的double，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE。
  - preTokens：Host侧的int，可选属性，用于稀疏计算，数据类型支持INT64。
  - nextTokens：Host侧的int，可选属性，用于稀疏计算，数据类型支持INT64。
  - inputLayout：Host侧的字符指针，用于标识输入query、key、value的数据排布格式，当前支持BSH、BSND。
    query、key、value数据排布格式支持从多种维度解读，其中B（Batch）表示输入样本批量大小、S（Seq-Length）表示输入样本序列长度、H（Head-Size）表示隐藏层的大小、N（Head-Num）表示多头数、D（Head-Dim）表示隐藏层最小的单元尺寸，且满足D=H/N。

  - numKeyValueHeads：Host侧的int，可选属性，代表key、value中head个数，用于支持GQA（Grouped-Query Attention，分组查询注意力）场景，默认为0，表示和query的head个数相等，数据类型支持INT64。
  - attentionOut：Device侧的aclTensor，公式中的输出，数据类型支持FLOAT16，数据格式支持ND。
  - workspaceSize：返回用户需要在Device侧申请的workspace大小。
  - executor：返回op执行器，包含了算子计算流程。
- 返回值：
  返回aclnnStatus状态码，具体参见aclnn返回码。

  第一段接口完成入参校验，出现以下场景时报错： 返回161001（ACLNN_ERR_PARAM_NULLPTR）：传入的query、key、value、attentionOut是空指针。 返回161002（ACLNN_ERR_PARAM_INVALID）：query、key、value、paddingMask、attenMask、attentionOut的数据类型和数据格式不在支持的范围内。


#### aclnnPromptFlashAttention

- 接口定义：
  aclnnStatus aclnnPromptFlashAttention(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

- 参数说明：

  - workspace：在Device侧申请的workspace内存起址。
  - workspaceSize：在Device侧申请的workspace大小，由第一段接口aclnnPromptFlashAttentionGetWorkspaceSize获取。
  - executor：op执行器，包含了算子计算流程。
  - stream：指定执行任务的AscendCL stream流。
- 返回值：
  返回aclnnStatus状态码，具体参见aclnn返回码。


#### 约束与限制

无