当前位置: 首页 > news >正文

CANN/ops-transformer FlashAttention可变长评分

aclnnFlashAttentionVarLenScore

【免费下载链接】ops-transformer本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-transformer

产品支持情况

产品是否支持
Ascend 950PR/Ascend 950DT
Atlas A3 训练系列产品/Atlas A3 推理系列产品
Atlas A2 训练系列产品/Atlas A2 推理系列产品
Atlas 200I/500 A2 推理产品×
Atlas 推理系列产品×
Atlas 训练系列产品×

功能说明

  • 接口功能:训练场景下,使用FlashAttention算法实现self-attention(自注意力)的计算。跟aclnnFlashAttentionScore接口的区别是该接口支持可变长S的计算,即可以一次传入多个长度不相等的sequence。使用此接口时,query,key和value使用TND的格式传入数据,其中T意为total number,表示其所有sequence的length总和,同时使用actualSeqQLenOptional与actualSeqKvLenOptional输入传入每个sequence依次的累积长度以区分不同sequence。每个sequence单独计算其注意力结果

  • 计算公式:

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

    $$ attention_out=Dropout(Softmax(Mask(scale*(pse+query*key^T),atten_mask)),keep_prob)*value $$

函数原型

每个算子分为两段式接口,必须先调用“aclnnFlashAttentionVarLenScoreGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnFlashAttentionVarLenScore”接口执行计算。

aclnnStatus aclnnFlashAttentionVarLenScoreGetWorkspaceSize( const aclTensor *query, const aclTensor *key, const aclTensor *value, const aclTensor *realShiftOptional, const aclTensor *dropMaskOptional, const aclTensor *paddingMaskOptional, const aclTensor *attenMaskOptional, const aclIntArray *prefixOptional, const aclIntArray *actualSeqQLenOptional, const aclIntArray *actualSeqKvLenOptional, 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 aclnnFlashAttentionVarLenScore( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

aclnnFlashAttentionVarLenScoreGetWorkspaceSize

  • 参数说明

    参数名输入/输出描述使用说明数据类型数据格式维度(shape)非连续Tensor
    query输入公式中的query。数据类型与key/value的数据类型一致。FLOAT16、BFLOAT16、FLOAT32ND[TND]
    key输入公式中的key。数据类型与query/value的数据类型一致。FLOAT16、BFLOAT16、FLOAT32ND[TND]
    value输入公式中的value。数据类型与query/key的数据类型一致。FLOAT16、BFLOAT16、FLOAT32ND[TND]
    realShiftOptional可选输入公式中的pse。数据类型与query的数据类型一致。FLOAT16、BFLOAT16、FLOAT32ND[B,N,1024,Skv]、[1,N,1024,Skv]、[pseTotalLen]
    dropMaskOptional可选输入公式中的Dropout。-UINT8ND0、1
    paddingMaskOptional可选输入预留参数,暂未使用。-----
    attenMaskOptional可选输入公式中的atten_mask。取值为1代表该位不参与计算,为0代表该位参与计算。BOOL、UINT8ND[B,N,Sq,Skv]、[B,1,Sq,Skv]、[1,1,Sq,Skv]、[Sq,Skv]
    prefixOptional可选输入代表prefix稀疏计算场景每个Batch的N值。-INT64ND0、1-
    actualSeqQLenOptional可选输入描述了每个Batch对应的query的sequence length。-INT64ND0、1-
    actualSeqKvLenOptional可选输入描述了每个Batch对应的key/value的sequence length。-INT64ND0、1-
    scaleValue可选输入公式中的scale,代表缩放系数。-DOUBLE---
    keepProb可选输入代表dropMaskOptional中1的比例。取值范围为(0, 1]。DOUBLE---
    preTokens可选输入用于稀疏计算 ,表示sliding window的左边界。-INT64---
    nextTokens可选输入用于稀疏计算,表示sliding window的右边界。-INT64---
    headNum输入代表单卡的head个数,即输入query的N轴长度。-INT64---
    inputLayout输入代表输入query、key、value的数据排布格式。支持TND。String---
    innerPrecise可选输入用于提升精度。默认配置为0即可。INT64---
    sparseMode可选输入表示sparse的模式。支持配置值为0、1、2、3、4、6、7、8。INT64---
    softmaxMaxOut输出Softmax计算的Max中间结果,用于反向计算。-FLOATND[N,T,8]
    softmaxSumOut输出Softmax计算的Sum中间结果,用于反向计算。-FLOATND[N,T,8]
    softmaxOutOut输出预留参数,暂未使用。-----
    attentionOutOut输出计算公式的最终输出。数据类型和shape类型与query保持一致。FLOAT16、BFLOAT16、FLOAT32ND[TND]
    workspaceSize输出返回需要在Device侧申请的workspace大小。-----
    executor输出返回op执行器,包含了算子计算流程。-----
  • 返回值

    aclnnStatus:返回状态码,具体参见aclnn返回码。

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

    返回值错误码描述
    ACLNN_ERR_PARAM_NULLPTR161001传入参数是必选输入,输出或者必选属性,且是空指针。
    ACLNN_ERR_PARAM_INVALID161002query、key、value、realShiftOptional、dropMaskOptional、paddingMaskOptional、attenMaskOptional、softmaxMaxOut、softmaxSumOut、softmaxOutOut、attentionOutOut的数据类型不在支持的范围内。
    query、key、value、realShiftOptional、dropMaskOptional、paddingMaskOptional、attenMaskOptional、softmaxMaxOut、softmaxSumOut、softmaxOutOut、attentionOutOut的数据格式不在支持的范围内。

aclnnFlashAttentionVarLenScore

  • 参数说明

    参数名输入/输出描述
    workspace输入在Device侧申请的workspace内存地址。
    workspaceSize输入在Device侧申请的workspace大小,由第一段接口aclnnFlashAttentionVarLenScoreGetWorkspaceSize获取。
    executor输入op执行器,包含了算子计算流程。
    stream输入指定执行任务的Stream。
  • 返回值

    返回aclnnStatus状态码,具体参见aclnn返回码。

约束说明

  • 确定性计算:
    • aclnnFlashAttentionVarLenScore默认确定性实现。
  • 该接口与PyTorch配合使用时,需要保证CANN相关包与PyTorch相关包的版本匹配
  • 输入query、key、value的约束如下:
    • B:batchsize必须相等。
    • D:Head-Dim必须满足(qD == kD && kD >= vD)。
    • inputLayout必须一致。
  • 输入query、key、value、realShiftOptional的数据类型必须一致。
  • query、key、value数据排布格式仅支持TND,T是B和S合轴紧密排列的数据(每个batch的SeqLenQ和SeqLenKV),其中B(Batch)表示输入样本批量大小、S(Seq-Length)表示输入样本序列长度、H(Head-Size)表示隐藏层的大小、N(Head-Num)表示多头数、D(Head-Dim)表示隐藏层最小的单元尺寸,且满足D=H/N。
  • 支持输入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的约束,其中:
    • T:取值范围为1~1M。
    • N:取值范围为1~256。
    • D:取值范围为1~768。
  • realShiftOptional:如果Sq大于1024且每个batch的Sq与Skv等长且是sparseMode为0、2、3的下三角掩码场景,可使能alibi位置编码压缩,此时只需要输入原始pse最后1024行进行内存优化,即alibi_compress = ori_pse[:, :, -1024:, :],具体如下:
    • 参数每个batch不相同时,shape为BNHSkv(H=1024)。
    • 每个batch相同时,shape为1NHSkv(H=1024)。
    • TND场景下,每个batch段内部仍按[N, Sq_i, Skv_i]生成,但存储与传参时统一flatten。若第i个batch段的真实query长度为Sq_i、真实key/value长度为Skv_i,则该段PSE元素个数为N * Sq_i * Skv_i,整段PSE总长度pseTotalLen为sum_i(N * Sq_i * Skv_i)。
    • 如不使用该参数可传入nullptr。
  • innerPrecise:当前0、1为保留配置值,2为使能无效行计算,其功能是避免在计算过程中存在整行mask进而导致精度有损失,但是该配置会导致性能下降。 如果算子可判断出存在无效行场景,会自动使能无效行计算,例如sparseMode为3,Sq > Skv场景。
  • sparseMode的约束如下:
    • 当所有的attenMaskOptional的shape小于2048且相同的时候,建议使用default模式,来减少内存使用量;
    • 配置为1、2、3、6时,用户配置的preTokens、nextTokens不会生效;
    • 配置为0、4、7、8时,须保证attenMaskOptional与preTokens、nextTokens的范围一致。
    • 用户不特意指定时建议传入0。
    • sparse不同模式的详细说明请参见sparse模式说明。
    • sparseMode为1、2、3、4、6、7、8时,应传入对应正确的attenMaskOptional,否则将导致计算结果错误。当attenMaskOptional输入为None时,sparseMode、preTokens、nextTokens参数不生效,固定为全计算。
    • 配置为3时,不支持无效行计算,需要满足每个batch的Sq<=Skv。
    • 配置为7时,不支持可选输入realShiftOptional。
    • 配置为8时,当每个sequence的q、kv等长时支持可选输入realShiftOptional,针对全局做pse生成。支持q方向进行外切,需要外切前每个sequence的q、kv等长。
  • 部分场景下,如果计算量过大可能会导致算子执行超时(aicore error类型报错,errorStr为:timeout or trap error),此时建议做轴切分处理,注:这里的计算量会受B、S、N、D等参数的影响,值越大计算量越大。
  • prefixOptional稀疏计算场景即sparseMode=6,当Sq > Skv时,prefix的N值取值范围[0, Skv],当Sq <= Skv时,prefix的N值取值范围[Skv-Sq, Skv]。
  • band场景,preTokens和nextTokens之间必须要有交集。
  • attenMaskOptional输入不支持补pad,即attenMaskOptional中不能存在某一行全1的场景。
  • actualSeqQLenOptional输入支持某个Batch上的S长度为0,此时不支持可选输入realShiftOptional,假设真实的S长度为[2,2,0,2,2],则传入的actualSeqQLenOptional为[2,4,4,6,8]。actualSeqQLenOptional的长度取值范围为1~2K。当存在prefixOptional输入的时候,其长度最大支持1K。

调用示例

调用示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。

#include <iostream> #include <vector> #include "acl/acl.h" #include "aclnnop/aclnn_flash_attention_score.h" #define CHECK_RET(cond, return_expr) \ do { \ if (!(cond)) { \ return_expr; \ } \ } while (0) #define LOG_PRINT(message, ...) \ do { \ printf(message, ##__VA_ARGS__); \ } while (0) int64_t GetShapeSize(const std::vector<int64_t>& shape) { int64_t shapeSize = 1; for (auto i : shape) { shapeSize *= i; } return shapeSize; } void PrintOutResult(std::vector<int64_t> &shape, void** deviceAddr) { auto size = GetShapeSize(shape); std::vector<float> resultData(size, 0); auto ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), *deviceAddr, size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return); for (int64_t i = 0; i < size; i++) { LOG_PRINT("mean result[%ld] is: %f\n", i, resultData[i]); } } int Init(int32_t deviceId, aclrtContext* context, aclrtStream* stream) { // 固定写法,资源初始化 auto ret = aclInit(nullptr); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret); ret = aclrtSetDevice(deviceId); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret); ret = aclrtCreateContext(context, deviceId); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateContext failed. ERROR: %d\n", ret); return ret); ret = aclrtSetCurrentContext(*context); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetCurrentContext failed. ERROR: %d\n", ret); return ret); ret = aclrtCreateStream(stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret); return 0; } template <typename T> int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr, aclDataType dataType, aclTensor** tensor) { auto size = GetShapeSize(shape) * sizeof(T); // 调用aclrtMalloc申请device侧内存 auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret); // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上 ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret); // 计算连续tensor的strides std::vector<int64_t> strides(shape.size(), 1); for (int64_t i = shape.size() - 2; i >= 0; i--) { strides[i] = shape[i + 1] * strides[i + 1]; } // 调用aclCreateTensor接口创建aclTensor *tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND, shape.data(), shape.size(), *deviceAddr); return 0; } int main() { // 1. (固定写法)device/stream初始化,参考acl API手册 // 根据自己的实际device填写deviceId int32_t deviceId = 0; aclrtContext context; aclrtStream stream; auto ret = Init(deviceId, &context, &stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret); // 2. 构造输入与输出,需要根据API的接口自定义构造 std::vector<int64_t> qShape = {256, 1, 128}; std::vector<int64_t> kShape = {256, 1, 128}; std::vector<int64_t> vShape = {256, 1, 128}; std::vector<int64_t> attenmaskShape = {256, 256}; std::vector<int64_t> attentionOutShape = {256, 1, 128}; std::vector<int64_t> softmaxMaxShape = {256, 1, 8}; std::vector<int64_t> softmaxSumShape = {256, 1, 8}; void* qDeviceAddr = nullptr; void* kDeviceAddr = nullptr; void* vDeviceAddr = nullptr; void* attenmaskDeviceAddr = nullptr; void* attentionOutDeviceAddr = nullptr; void* softmaxMaxDeviceAddr = nullptr; void* softmaxSumDeviceAddr = nullptr; aclTensor* q = nullptr; aclTensor* k = nullptr; aclTensor* v = nullptr; aclTensor* pse = nullptr; aclTensor* dropMask = nullptr; aclTensor* padding = nullptr; aclTensor* attenmask = nullptr; aclTensor* attentionOut = nullptr; aclTensor* softmaxMax = nullptr; aclTensor* softmaxSum = nullptr; aclTensor* softmaxOut = nullptr; std::vector<float> qHostData(32768, 1); std::vector<float> kHostData(32768, 1); std::vector<float> vHostData(32768, 1); std::vector<uint8_t> attenmaskHostData(65536, 0); std::vector<float> attentionOutHostData(32768, 0); std::vector<float> softmaxMaxHostData(2048, 3.0); std::vector<float> softmaxSumHostData(2048, 3.0); ret = CreateAclTensor(qHostData, qShape, &qDeviceAddr, aclDataType::ACL_FLOAT, &q); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(kHostData, kShape, &kDeviceAddr, aclDataType::ACL_FLOAT, &k); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(vHostData, vShape, &vDeviceAddr, aclDataType::ACL_FLOAT, &v); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(attenmaskHostData, attenmaskShape, &attenmaskDeviceAddr, aclDataType::ACL_UINT8, &attenmask); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(attentionOutHostData, attentionOutShape, &attentionOutDeviceAddr, aclDataType::ACL_FLOAT, &attentionOut); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(softmaxMaxHostData, softmaxMaxShape, &softmaxMaxDeviceAddr, aclDataType::ACL_FLOAT, &softmaxMax); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(softmaxSumHostData, softmaxSumShape, &softmaxSumDeviceAddr, aclDataType::ACL_FLOAT, &softmaxSum); CHECK_RET(ret == ACL_SUCCESS, return ret); std::vector<int64_t> prefixOp = {0}; aclIntArray *prefix = aclCreateIntArray(prefixOp.data(), 1); std::vector<int64_t> acSeqQLenOp = {256}; std::vector<int64_t> acSeqKvLenOp = {256}; aclIntArray* acSeqQLen = aclCreateIntArray(acSeqQLenOp.data(), acSeqQLenOp.size()); aclIntArray* acSeqKvLen = aclCreateIntArray(acSeqKvLenOp.data(), acSeqKvLenOp.size()); double scaleValue = 0.088388; double keepProb = 1; int64_t preTokens = 65536; int64_t nextTokens = 65536; int64_t headNum = 1; int64_t innerPrecise = 0; int64_t sparseMode = 0; char layOut[5] = {'T', 'N', 'D', 0}; // 3. 调用CANN算子库API,需要修改为具体的Api名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnFlashAttentionVarLenScore第一段接口 ret = aclnnFlashAttentionVarLenScoreGetWorkspaceSize( q, k, v, pse, dropMask, padding, attenmask, prefix, acSeqQLen, acSeqKvLen, scaleValue, keepProb, preTokens, nextTokens, headNum, layOut, innerPrecise, sparseMode, softmaxMax, softmaxSum, softmaxOut, attentionOut, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnFlashAttentionVarLenScoreGetWorkspaceSize failed. ERROR: %d\n", ret); return ret); // 根据第一段接口计算出的workspaceSize申请device内存 void* workspaceAddr = nullptr; if (workspaceSize > 0) { ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret); } // 调用aclnnFlashAttentionVarLenScore第二段接口 ret = aclnnFlashAttentionVarLenScore(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnFlashAttentionVarLenScore failed. ERROR: %d\n", ret); return ret); // 4. (固定写法)同步等待任务执行结束 ret = aclrtSynchronizeStream(stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret); // 5. 获取输出的值,将device侧内存上的结果拷贝至host侧,需要根据具体API的接口定义修改 PrintOutResult(attentionOutShape, &attentionOutDeviceAddr); PrintOutResult(softmaxMaxShape, &softmaxMaxDeviceAddr); PrintOutResult(softmaxSumShape, &softmaxSumDeviceAddr); // 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改 aclDestroyTensor(q); aclDestroyTensor(k); aclDestroyTensor(v); aclDestroyTensor(attenmask); aclDestroyTensor(attentionOut); aclDestroyTensor(softmaxMax); aclDestroyTensor(softmaxSum); // 7. 释放device资源 aclrtFree(qDeviceAddr); aclrtFree(kDeviceAddr); aclrtFree(vDeviceAddr); aclrtFree(attenmaskDeviceAddr); aclrtFree(attentionOutDeviceAddr); aclrtFree(softmaxMaxDeviceAddr); aclrtFree(softmaxSumDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtDestroyContext(context); aclrtResetDevice(deviceId); aclFinalize(); return 0; }

【免费下载链接】ops-transformer本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-transformer

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

http://www.jsqmd.com/news/786799/

相关文章:

  • MCP 技术深度解析及其在 AI Agent 中的应用
  • 利用Taotoken模型广场为不同应用场景快速筛选合适的大模型
  • ARM CoreSight拓扑检测技术原理与应用详解
  • 收藏!AI时代小白程序员必看:10个方向、3条路径、1个被搞反的公式助你职业起飞!
  • ARM7TDMI-S内存接口与调试技术详解
  • x402协议:AI智能体机器经济基础设施与微支付实践
  • 数字示波器频率响应与上升时间测量技术解析
  • 2026年AI调用量千倍增长、价格跌超80%,算力为何反而稀缺且更贵?
  • Cursor规则文件转智能体配置:自动化同步项目规范与AI助手
  • AI赋能量子化学:从密度泛函理论到机器学习加速与泛函设计
  • 如何高效去除图片水印:基于深度图像先验的完整指南
  • 基于Next.js 14与Vercel AI SDK构建企业级全栈AI聊天应用
  • 收藏!小白程序员必看:如何利用AI三层架构实现大模型落地价值?
  • 【OpenClaw从入门到精通】第75篇:大厂龙虾三巨头——腾讯WorkBuddy、华为小艺Claw、小米miclaw对比选型(2026横评版)
  • CANN权重量化分组矩阵乘
  • 深入理解 MCP (Model Context Protocol):大模型时代的标准化接口协议
  • 还在为加密视频无法下载而烦恼?试试这款跨平台流媒体下载神器!
  • 星识科技获数千万元融资,Vizta智能望远镜破局长焦观测赛道!
  • [RPA实战教程] 拼多多/TEMU店群自动化 (运维篇):构建RPA集群控制塔与OTA热更新架构
  • 基于微信iPad协议实现自动化机器人:openclaw-wechat部署与开发实战
  • Deep Agent全解析:为什么普通Agent只能“浅尝辄止”,而Deep Agent能真正干复杂活?
  • OpenFang开源AI智能体框架:从核心原理到实战部署全解析
  • Cortex-M0微控制器架构解析与低功耗设计实践
  • Flutter与Firebase构建钓鱼智能日志应用:从数据采集到分析
  • ContentPipe:构建可控AI图文生产流水线,实现人机协同内容创作
  • 工业神经系统:10 网络安全+未来TSN+6G:工厂的“数据护城河
  • ARMv8/9 AArch64系统指令:缓存与地址转换详解
  • 年轻人用 AI 实现情绪自救:从发疯吐槽到平行宇宙重养自己
  • 开源AI智能体项目评估与实战指南:从OpenClaw理念到工程实践
  • 串口通信三大错误处理方案