已合并
优化example示例中 产品支持情况 描述 #1276
qiang_zq创建于 3月28日
优化example示例中 产品支持情况 描述 #1276
已合并
qiang_zq创建于 3月28日
qiang_zq
qiang_zq成员
3月28日

描述

1、补充部分新增example示例 readme 缺少的“产品支持情况”描述
2、历史example示例 readme 中“产品支持情况”与docs中API描述不一致
3、优化example样例执行步骤,run.sh中编译完成后自动执行,将原来编译+运行 2步操作 合为一步
4、目录 README 补全: 为 device、stream、event、memory、kernel、callback、model_ri、notify、tdt_buffer、tdt_channel、tdt_queue、built_in_task 等目录新增了 README.md,改善了导航体验
5、链接路径修正: 修正了嵌套目录的相对路径(从 ../../README.md 改为 ../../../README.md)

代码审查报告
https://gitcode.com/cann/runtime/pull/1276?ref=&did=65e24693459e9d96f1d4ad02bef022d0968fba55#tid-166839878

关联的Issue

https://gitcode.com/cann/runtime/issues/299

测试

/example/0_quickstart/0_hello_cann$ bash run.sh 
Configuring CMake...
-- The C compiler identification is GNU 13.3.0
-- The CXX compiler identification is GNU 13.3.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/workspace/gitCode/qiang_zq/runtime/example/0_quickstart/0_hello_cann/build
Building...
[ 50%] Building CXX object CMakeFiles/main.dir/main.cpp.o
[100%] Linking CXX executable main
[100%] Built target main
Build completed successfully!
Executable location: /mnt/workspace/gitCode/qiang_zq/runtime/example/0_quickstart/0_hello_cann/build/main
Run the sample: ./build/main
ACL init successfully
Set device 0 successfully
Create stream successfully
Input vectors:
  self:   [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0]
  other:  [0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0]
  alpha:  1.0
Create output aclDataBuffer successfully, buffer addr = 0x12c0c0016000
Get workspace size successfully, workspace size = 0
[Warning]: tiling struct [ReduceOpTilingDataV2] is conflict with one in file kl_div_v2.cc, line 41
[Warning]: tiling struct [RepeatInterleaveGradTilingData] is conflict with one in file repeat_interleave_grad_tiling.h, line 21
[Warning]: tiling struct [IndexFillTilingData] is conflict with one in file index_fill_tiling.h, line 21
[Warning]: tiling struct [MapIndexTilingData] is conflict with one in file map_index_tiling_arch35.h, line 23
[Warning]: tiling struct [MaskedSelectV3TilingData] is conflict with one in file masked_select_v3_tiling.h, line 27
[Warning]: tiling struct [MaskedSelectV3TilingData] is conflict with one in file masked_select_v3_tiling.h, line 27
[Warning]: tiling struct [ScatterPaKvCacheTilingData] is conflict with one in file scatter_pa_kv_cache_tiling.h, line 35
[Warning]: tiling struct [ScatterPaKvCacheTilingData] is conflict with one in file scatter_pa_kv_cache_tiling.h, line 35
[Warning]: tiling struct [TopKTopPSampleTilingData] is conflict with one in file top_k_top_p_sample_tiling.h, line 26
[Warning]: tiling struct [AvgPool3dGradTilingBlockParam] is conflict with one in file avg_pool_3d_grad_tiling.h, line 99
[Warning]: tiling struct [AvgPool3dGradTilingParam] is conflict with one in file avg_pool_3d_grad_tiling.h, line 125
[Warning]: tiling struct [FusedCrossEntropyLossWithMaxSumTilingData] is conflict with one in file fused_cross_entropy_loss_with_max_sum_tiling.h, line 27
[Warning]: tiling struct [TilingDataBackgroundReplace] is conflict with one in file background_replace_tiling.h, line 22
[Warning]: tiling struct [TilingDataBlendImages] is conflict with one in file blend_images_custom_tiling.h, line 24
Launch aclnnAdd successfully
Synchronize stream successfully

Vector addition result:
  result[0] = 1.5 (expected: 1.5)
  result[1] = 3.0 (expected: 3.0)
  result[2] = 4.5 (expected: 4.5)
  result[3] = 6.0 (expected: 6.0)
  result[4] = 7.5 (expected: 7.5)
  result[5] = 9.0 (expected: 9.0)
  result[6] = 10.5 (expected: 10.5)
  result[7] = 12.0 (expected: 12.0)
Free device memory successfully
Destroy stream successfully
Reset device successfully
ACL finalize successfully

Sample run successfully!

/example/0_quickstart/1_error_handling$ bash run.sh 
Configuring CMake...
-- The C compiler identification is GNU 13.3.0
-- The CXX compiler identification is GNU 13.3.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/workspace/gitCode/qiang_zq/runtime/example/0_quickstart/1_error_handling/build
Building...
[ 50%] Building CXX object CMakeFiles/main.dir/main.cpp.o
[100%] Linking CXX executable main
[100%] Built target main
Build completed successfully!
Executable location: /mnt/workspace/gitCode/qiang_zq/runtime/example/0_quickstart/1_error_handling/build/main
Run the sample: ./build/main
[INFO]  ACL init and set device successfully
[INFO]  Current run mode: ACL_HOST
[INFO]  Triggering an expected invalid-parameter error with aclrtGetRunMode(nullptr)
[ERROR]  Diagnostics: ret=100000, peekErr=0, lastErr=0, recentErrMsg=[PID: 2238268] 2026-03-30-14:54:54.405.703 Invalid_Argument_Null_Pointer(EH0002): Argument [runMode] must not be null.
        Solution: Try again with a correct pointer argument.

[WARN]  aclrtGetErrorVerbose(0) returned error code 207000
[INFO]  After diagnostics are consumed once: peekErr=207000, lastErr=207000, recentErrMsg=<null>
[INFO]  ACL finalize successfully

文档更新

example/0_quickstart/1_error_handling/README.md
example/1_basic_features/device/0_device_normal/README.md
....
example/*/README.md

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 qiang_zq 的贡献)
qiang_zqqiang_zq成员
3月28日 创建了 pull request,commit de2aff55
CANN-robotCANN-robot成员
3月28日 添加了label:stat/needs-squash
CANN-robot
CANN-robot成员
3月28日 评论:

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
example yanmingxiang, wangluyao17 (2/2) yanmingxiang (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
3月28日 添加了label:cann-cla/yes
CANN-robotCANN-robot成员
3月28日 将zhaozhixuan,wda1991,wangtao43,zhangpengpeng8,changhaixun,yanmingxiang,turing_yhy,Reyn52166,luoyuzhou2,Turing_JasonWen,Axiaolei,ykl999,sunnana_004434229,houyanbao,wangluyao17,qinchuanyu,zhou-wuxiao,derekxu,tingwood,chen_vvjob,lilianghua_2025设为评审人
此处折叠了72条消息 查看更多
CANN-robot
CANN-robot成员
3月30日 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
tingwood

likedislike
CANN-robotCANN-robot成员
3月30日 添加了label:approved
CANN-robot
CANN-robot成员
3月30日 评论:

Review Guide

This pull-request passes review.
Committers who wrote a comment of /approve are: yanmingxiang.
Reviewers who wrote a comment of /lgtm are: yanmingxiang, wangluyao17.

likedislike
CANN-robotCANN-robot成员
3月30日 关闭了关联的issue
CANN-robotCANN-robot成员
3月30日 合入了pull request