Skip to content

Repository files navigation

cann-samples

🔥Latest News

  • [2026/03] ops-samples更名为cann-samples。
  • [2026/02] ops-samples项目上线,提供算子领域高性能实战演进样例与体系化调优知识库。

🚀概述

cann-samplesCANN(Compute Architecture for Neural Networks)算子领域的实战样例仓库,提供高性能实现示例与体系化调优知识库。

本仓已集成代码仓库智能体,点击 Zread 徽章,进入其专属页面,开启在线智能代码学习与知识问答体验!

📝环境部署

当前仓库已验证通过的社区版 CANN Toolkit 如下:

CANN 版本 时间戳 验证结果 下载链接
9.0.0 20260422000325096 ✅ PASS aarch64 / x86_64
9.0.0 20260325000325538 ✅ PASS aarch64 / x86_64

请根据实际 CPU 架构,从上述链接目录中自行选择对应的 .run 安装包。

toolkit 安装包文件名格式如下:

  • Ascend-cann-toolkit_${cann_version}_linux-aarch64.run
  • Ascend-cann-toolkit_${cann_version}_linux-x86_64.run
  1. 安装社区版 CANN Toolkit

    # 确保安装包具有可执行权限
    chmod +x Ascend-cann-toolkit_${cann_version}_linux-${arch}.run
    # 安装命令
    ./Ascend-cann-toolkit_${cann_version}_linux-${arch}.run --install --force --install-path=${install_path}
    • ${cann_version}:表示 toolkit 安装包版本号,需满足上文的最低版本要求。
    • ${arch}:表示 CPU 架构,如 aarch64x86_64
    • ${install_path}:表示指定安装路径,默认安装在 /usr/local/Ascend 目录。
  2. 配置环境变量

    安装完成后,请先执行:

    source ${install_path}/ascend-toolkit/set_env.sh

    请将 ${install_path} 替换为 toolkit 的实际安装目录,例如 /usr/local/Ascend${HOME}/Ascend

  3. 前置依赖

    编译用到的依赖如下,请确保已安装并且满足版本要求:

    • cmake >= 3.16.0
    • python >= 3.8.0
    • zip

⚡️快速入门

  1. 配置项目

    NPU_ARCH 为必填参数,用于指定目标 NPU 架构。当前支持的取值如下:

    NPU 平台 NPU_ARCH
    Ascend950 dav-3510
    Ascend910B/C dav-2201

    以 Ascend950 为例,使用以下命令初始化构建配置,CMake 会自动创建 build 目录:

    cmake -S . -B build -DNPU_ARCH=dav-3510

    在 Ascend910B/C 平台构建时,请使用 -DNPU_ARCH=dav-2201。不支持当前架构的样例会在配置阶段跳过,因此 target help 和后续构建只包含当前架构生效的样例。

  2. 查看可用 Target(可选)

    编译前可先查看当前项目中支持单独构建的目标列表:

    cmake --build build --target help
  3. 编译与安装

    • 选项 A:编译指定 Target(部分构建)

      <target_name> 替换为上一步查到的目标名称:

      cmake --build build --target <target_name>
    • 选项 B:编译所有 Target(推荐,全量构建)

      支持多线程加速构建:

      cmake --build build --parallel

      安装编译产物,将生成的二进制文件整理到 build_out 目录:

      cmake --install build --prefix ./build_out
  4. 运行验证

    • 选项A: 运行指定的Target(以vector_add为例)

      上一步将<target_name> 替换为vector_add编译成功后,编译输出二进制文件在./build/Samples/0_Introduction/vector_add/目录下,即编译产物在第一步构建的build文件夹下与样例目录对应的位置,执行如下命令运行:

      ./build/Samples/0_Introduction/vector_add/vector_add

      可以得到结果如下:

      Vector add completed successfully!
      
    • 选项B: 运行全量编译并安装后的matmul用例

      完成第三步的安装后,所有编译生成文件都在build_out文件夹下,matmul用例的可运行文件在./build_out/0_Introduction/matmul目录下,执行如下命令运行:

      ./build_out/0_Introduction/matmul/matmul 100 50 200
      

      可以得到结果如下:

      matmul run successfully!
      

      开发者可自行尝试运行build_out下的其它用例。

📂目录结构

├── Samples                                  # 样例目录
│   ├── 0_Introduction                       # 入门样例
│   ├── 1_Features                           # 功能特性样例
│   │   ├── memory_optimization              # 访存优化方法
│   │   ├── instruction_optimization         # 指令优化方法
│   │   ├── system_optimization              # 系统优化方法
│   │   └── hardware_features                # 芯片特性样例
│   ├── 2_Performance                        # 性能调优样例
│   └── CMakeLists.txt
├── cmake                                    # 工程编译配置
├── .clang-format                            # 代码格式配置
├── CMakeLists.txt                           # 根 CMake 配置
├── LICENSE                                  # 许可证
├── SECURITY.md                              # 安全声明
└── README.md                                # 项目说明文档

💬相关信息

🤝联系我们

本项目的功能与文档会持续更新。

  • 问题反馈:通过 GitCode Issues 提交问题
  • 社区互动:通过 GitCode Discussions 参与交流

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages