| doc(kv_rms_norm_rope_cache): fix incorrect function signature in aclnnKvRmsNormRopeCache doc
Co-authored-by: zhangzijie<zhangzijie11@hisilicon.com>
# message auto-generated for no-merge-commit merge:
!3828 merge doc/fix-kvrms-doc into master
doc(kv_rms_norm_rope_cache): fix incorrect function signature in aclnnKvRmsNormRopeCache doc
Created-by: zhangzijie
Commit-by: zhangzijie
Merged-by: cann-robot
Description: ## 描述
修复 aclnnKvRmsNormRopeCache 文档中函数原型 aclnnKvRmsNormRopeCacheGetWorkspaceSize 的参数声明错误,具体包括:
1. 第9个参数命名错误:ckvScaleOptional → cKvScaleOptional(大小写与其他参数风格不一致)
2. kRopeOut 缺少 const 修饰符:aclTensor* → const aclTensor*
3. cKvOut 缺少 const 修饰符:aclTensor* → const aclTensor*
4. workspaceSize 应为输出参数,类型错误:uint64_t → uint64_t*
5. executor 应为输出参数,类型错误:aclOpExecutor* → aclOpExecutor**
其中第4、5条为关键错误:workspaceSize 和 executor 是两段式接口的输出参数,若声明为值类型,调用方将无法获取计算结果。
## 关联的Issue
https://gitcode.com/cann/ops-transformer/issues/1731
## 测试
文档修改,无需功能测试。已对照源码头文件及示例代码验证参数声明的正确性。
## 文档更新
更新了 posembedding/kv_rms_norm_rope_cache/docs/aclnnKvRmsNormRopeCache.md 中的函数原型声明。
## 类型标签
- [ ] 🐛 Bug 修复
- [ ] ✨ 新特性
- [ ] ⚡ 性能优化
- [ ] ♻️ 重构
- [ ] 🧪 测试
- [ ] 📦 构建/CI
- [ ] 🔧 配置变更
- [x] 📝 文档更新
- [ ] ⬆️ 依赖升级
- [ ] 🔒 安全修复
- [ ] 🧹 代码清理
- [ ] ❓ 其他,请描述:
See merge request: cann/ops-transformer!3828 | 1 个月前 |