已合并
docs: 优化快速入门与算子调用文档 #6435
docs: 优化快速入门与算子调用文档 #6435
已合并
xtqh创建于 6月4日
xtqh成员
6月4日

描述

优化项目快速入门与算子调用相关文档,提升开发者体验和文档可读性。

改动

  • README: 源码下载示例改为具体9.0.0分支,调整说明位置
  • QUICKSTART: soc_version说明重构,图片提前,步骤拆分细化
  • quick_install: Docker/手动安装流程简化,镜像版本更新到9.1.0-beta.1,CANN版本检查增加CANNLab路径
  • quick_op_invocation: 示例代码改用智能指针释放资源、拆分自定义/标准算子CMakeLists、新增aclnn和GE IR编译运行步骤结构化
  • op_api_list: 头文件/库文件说明简化,新增libopapi.so废弃提示

关联的Issue

#2908
https://gitcode.com/cann/ops-transformer/issues/2421

测试

  • 文档变更,不影响原有编译与运行逻辑
  • 不传新参数时原有行为不受影响

类型标签

  • 🐛 Bug 修复
  • ✨ 新特性
  • ⚡ 性能优化
  • ♻️ 重构
  • 🧪 测试
  • 📦 构建/CI
  • 🔧 配置变更
  • 📝 文档更新
  • ⬆️ 依赖升级
  • 🔒 安全修复
  • 🧹 代码清理
  • ❓ 其他,请描述:
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 xtqh 的贡献)
Xxtqh成员
6月4日 创建了 pull request,commit 063d8c7c
CANN-robotCANN-robot成员
6月4日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
6月4日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
README.md wang-minbo, 黄俊健 (2/2) 黄俊健, wang-minbo (2/1)
docs 黄俊健, wang-minbo (2/2) 黄俊健, wang-minbo (2/1)
examples wang-minbo, 黄俊健 (2/2) wang-minbo, 黄俊健 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

xtqh, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
Xxtqh成员
6月4日 修改了pull request 的描述
xtqh成员
6月4日 评论:

compile

likedislike
Xxtqh成员
6月4日 update merge request[project id: 7673863, iid: 6435, commit_id: 17593ec14a1bbb4ffdec0dfcd61c46995146723a] virtual merging success
CANN-robotCANN-robot成员
6月4日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
6月4日 评论:

流水线任务触发成功
任务链接 [277582dc700f4008a3b4324755f3d305][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental ✅ SUCCESS >>>>> >>>>>
Compile_Pre ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_mobile_station_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910b ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_910c ✅ SUCCESS >>>>> >>>>>
Compile_X86_monitor_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_950 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_X86_experimental_950_ubuntu24 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM_experimental_950_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
PreSmoke_A900 ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>
PreSmoke_ATK_Test_A2 ✅ SUCCESS >>>>>

[2026-06-04 21:13:43]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
6月4日 评论:

流水线任务触发成功
任务链接 [29b311374b0b4797899eb4f94b9271a4][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_style ✅ SUCCESS >>>>>
StaticCheck_codespell_check ⚠️ WARNING >>>>>
StaticCheck_link_validity_check ✅ SUCCESS
StaticCheck_resource_existence_check ✅ SUCCESS
StaticCheck_tag_closed_check ✅ SUCCESS
StaticCheck_markdownlint ⚠️ WARNING >>>>>
codecheck_checkpr ✅ SUCCESS
codecheck_precommit ⚠️ WARNING >>>>> >>>>>

[2026-06-04 21:05:11]    CI执行结束

likedislike
CANN-robotCANN-robot成员
6月4日 添加了label:api-check-pass
CANN-robotCANN-robot成员
6月4日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
6月4日 添加了label:ci-pipeline-passed
wang-minbo成员
6月4日 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
6月4日 添加了label:approved
xtqh成员
6月5日 评论:

[SEC-5.1] 资源申请后判断是否成功
问题描述:GenOnesDataFloat32 和 GenOnesData 使用 new(std::nothrow) 分配内存后,均未对返回值做 nullptr 判断就直接解引用。若分配失败,pData 为 nullptr,后续 *(pData + i) = value 将触发空指针解引用(未定义行为)。
代码片段(行 140-145):
float *pData = new (std::nothrow) float[size]; // nothrow分配,失败返回nullptr

for (size_t i = 0; i < size; ++i) {
*(pData + i) = value; // 无nullptr判断,直接解引用
}
input_tensor = Tensor(input_tensor_desc, (uint8_t *)pData, data_len);
return SUCCESS;
代码片段(行 158-162):
int32_t *pData = new (std::nothrow) int32_t[data_len]; // nothrow分配,失败返回nullptr
for (uint32_t i = 0; i < size; ++i) {
*(pData + i) = value; // 无nullptr判断,直接解引用
}
修复建议:在 new(std::nothrow) 之后添加 nullptr 判断:if (pData == nullptr) { return FAILE

likedislike
张海杰
张海杰成员6月5日进行代码检视1
docs/zh/invocation/quick_op_invocation.md
@@ -323,3 +380,3 @@
323380 _ASCEND_INSTALL_PATH="/usr/local/Ascend/cann"
324381 fi
325- 
382+
张海杰
张海杰6月5日评论:

多余的空格

likedislike
monologue815成员
6月5日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
6月5日 添加了label:lgtm
CANN-robot
CANN-robot成员
6月5日 评论:

The MR can not be merged, because of CodeReview discussion not resolved

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike
张海杰
张海杰成员
6月5日 评论:

/approve

likedislike
xtqh成员
6月5日 评论:

/check-pr

likedislike
CANN-robot
CANN-robot成员
6月5日 评论:

The MR can not be merged, because of CodeReview discussion not resolved

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike
Xxtqh成员
6月5日 解决了最后一个问题
CANN-robotCANN-robot成员
6月5日 合入了pull request