acl

acl

acl

概述

ACL作为AI计算语言开发和运行平台，提供了Device管理、Context管理、Stream管理、内存管理、模型加载与执行、算子加载与执行、媒体数据处理等API，供用户开发AI应用，实现目标识别、图像分类、语言和文字处理等功能。

目录结构说明

本源码仓目录结构如下：

├── c                     # 轻量化图执行
├── common                # 基础接口
├── inc                   # 头文件
├── model                 # 模型推理
├── runtime               # 运行时接口
├── single_op             # 单算子模型
├── stub                  # 桩实现
├── tensor_data_transfer  # 用于Host与Device之间传递Tensor数据接口
├── tests                 # 开发者测试目录
├── third_party           # 依赖的三方库
├── toolchain             # profiling/dump工具
├── utils                 # 工具方法类

环境准备

ACL支持源码编译，在源码编译前，请确保环境满足如下要求：

已安装CANN开发套件包（Ascend-cann-toolkit_<cann_version>_linux_<arch>）。

CANN开发套件软件包请从Link获取，支持的安装方式及操作系统请参见配套版本的用户手册。

CANN开发套件包安装命令示例：
- 使用默认路径安装
```
./Ascend-cann-toolkit_<cann_version>_linux_<arch>.run --install
```
  - 若使用root用户安装，安装完成后相关软件存储在/usr/local/Ascend/ascend-toolkit/latest路径下。
  - 若使用非root用户安装，安装完成后相关软件存储在$HOME/Ascend/ascend-toolkit/latest路径下。
- 指定路径安装
```
# CANN开发套件包安装命令示例：
./Ascend-cann-toolkit_<cann_version>_linux-<arch>.run --install --install-path=${install_path}
```
安装完成后，相关软件存储在${install_path}指定路径下。
已安装以下依赖：
- GCC >= 7.3.0
- CMake >= 3.14.0 (建议使用3.20.0版本)
- ccache
  
  compile cache，编译器缓存优化工具，加快二次编译速度。
```
# 安装命令示例：
sudo apt-get install ccache
```
- bash >= 5.1.16
  
  由于测试用例开启了地址消毒，代码中执行system函数会触发低版本的bash被地址消毒检查出内存泄露。建议版本不低于5.1.16。

源码下载

ACL源码托管在码云平台，可以使用如下命令下载:

git clone https://gitee.com/cann/acl.git
cd acl
git submodule init && git submodule update --recursive

配置环境变量

配置ASCEND_INSTALL_PATH环境变量，指定Ascend-cann-toolkit安装后相关软件存储路径。

Ascend-cann-toolkit使用root用户、默认路径安装场景，配置示例：
```
export ASCEND_INSTALL_PATH=/usr/local/Ascend/ascend-toolkit/latest
```
Ascend-cann-toolkit使用非root用户、默认路径安装场景，配置示例：
```
export ASCEND_INSTALL_PATH=$HOME/Ascend/ascend-toolkit/latest
```
Ascend-cann-toolkit指定路径安装场景，若安装路径为${install_path}，配置示例：
```
export ASCEND_INSTALL_PATH=${install_path}/ascend-toolkit/latest
```

说明：

若开发者使用IDE CLion进行后续的源码编译与测试用例执行，编译执行前需要进行CLion的CMake配置，详细请参见CLion配置。

编译第三方库

ACL仓依赖一些第三方库, 在正式编译ACL之前，需要先完成三方库的编译操作，其命令为：

bash build_third_party.sh --output_path=${THIRD_LIB_PATH}

此命令下载所有依赖的第三方库源码包，然后执行编译操作，并将编译结果复制到输出目录。

third_party_pkg_path参数

如果指定了此参数，则脚本会从其指定的目录下取第三方库源码包，否则就会在线下载。
enable_github参数

在线下载的第三方库源码包有两个来源，分别是gitee和github。当没有指定third_party_pkg_path参数时，脚本就会在线下载第三方库源码包，此时如果指定了enable_github参数，就会从github下载，否则从gitee下载。
output_path参数

编译结果目录由此参数指定，其默认值为./output/third_party。编译第三方库的输出结果目录可以长期保存，不需要每次重新编译，除非所依赖的第三方库有变更。

您可以通过bash build_third_party.sh -h命令查看脚本选项的详细描述。

当指定的源码目录为本地目录时，要求其目录结构为：

some-path-name
└── libs
    ├── abseil-cpp
    │   └── abseil-cpp-20220623.1.tar.gz
    ├── benchmark
    │   └── v1.5.5.tar.gz
    ├── boost
    │   └── boost_1_82_0.tar.gz
    ├── cares
    │   └── c-ares-cares-1_18_1.tar.gz
    ├── ge_gtest
    │   └── release-1.11.0.tar.gz
    ├── ge_nlohmann_json
    │   └── v3.11.2
    │       └── include.zip
    ├── grpc
    │   └── grpc-v1.41.1.tar.gz
    ├── libjpeg-turbo
    │   └── 2.1.1.tar.gz
    ├── openssl
    │   └── openssl-3.0.9.tar.gz
    ├── protobuf
    │   └── v3.13.0.tar.gz
    ├── pybind11
    │   └── v2.10.3.tar.gz
    ├── re2
    │   └── re2-2021-11-01.tar.gz
    ├── symengine
    │   └── v0.10.1.zip
    └── zlib
        └── zlib-v1.2.13.tar.gz

编译

ACL提供一键式编译能力，可通过如下命令进行编译：

  bash build.sh --ascend_install_path=${ASCEND_INSTALL_PATH} --ascend_3rd_lib_path=${THIRD_LIB_PATH}

--ascend_install_path选项的默认值为/usr/local/Ascend/ascend-toolkit/latest，编译完成后会在output/package目录下生成CANN-acl-linux.{x86_64/aarch64}.run软件包。

build.sh脚本默认从./output/third_party下查找三方库，若在执行build_third_party.sh时，指定了其他生成三方库的目录，可以通过build.sh --ascend_3rd_lib_path=<指定的三方库路径>选项做配置。

更多编译参数可以通过bash build.sh -h查看。

本地验证

说明：UT测试用例不支持使用root用户执行，请使用非root用户执行以下命令。

编译完成后，用户可进行开发测试（DT：Development Testing ）。

编译执行所有的UT测试用例：

bash tests/run_test.sh --ut --ascend_install_path=${ASCEND_INSTALL_PATH} --ascend_3rd_lib_path=${THIRD_LIB_PATH}

UT测试用例编译输出目录为build_ut，如果想清除历史编译记录，可以如下操作：

rm -rf build_ut/ output/ build/

注：tests/run_test.sh脚本支持的详细命令参数可以执行bash tests/run_test.sh -h查看。

安装

本地验证完成后，可执行如下命令安装编译生成的ACL软件包。

./CANN-acl-linux.{x86_64/aarch64}.run --full --install-path=${install_path}/ascend-toolkit

回滚

若您想回退安装的自定义ACL软件包，恢复到安装Ascend-cann-toolkit后的状态，可执行如下命令。

./CANN-acl-linux.{x86_64/aarch64}.run --rollback --install-path=${install_path}/ascend-toolkit

贡献指南

ACL仓欢迎广大开发者体验并参与贡献，在参与社区贡献前，请参见cann-community了解行为准则，进行CLA协议签署，了解参与贡献的详细流程。

针对ACL仓，开发者准备本地代码与提交PR时需要重点关注如下几点：

请输出满足Google编程规范的代码，详细可参见Google 开源项目风格指南。
提交PR时，请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。
若您的修改不是简单的bug修复，而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等，请务必先通过Issue进行方案讨论，以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”，亦可通过提交Issue进行方案讨论。

附录

CLion配置

若开发者使用IDE CLion编译源码并执行测试用例，编译执行前需要进行如配置：

在菜单栏选择“File -> Settings”，进入“Settings”配置页面。
在“Settings”窗口左侧选择“Build,Execution,Deployment -> CMake”，进入“CMake”配置界面。
在“CMake”配置界面进行如下配置。
- Build type，设置为“GCOV”。
- CMake options，设置为如下值：
```
-DENABLE_OPEN_SRC=True
-DENABLE_ACL_UT=ON
-DASCEND_INSTALL_PATH=${ASCEND_INSTALL_PATH}
-DASCEND_3RD_LIB_PATH=${THIRD_LIB_PATH}
```
  关于ASCEND_INSTALL_PATH的取值说明请参见配置环境变量。

CANN/acl

acl

概述

目录结构说明

环境准备

源码下载

配置环境变量

编译第三方库

编译

本地验证

安装

回滚

贡献指南

附录

CLion配置

简介

发行版

贡献者

近期动态

CANN/acl .gitee-modal { width: 500px !important; }

acl

概述

目录结构说明

环境准备

源码下载

配置环境变量

编译第三方库

编译

本地验证

安装

回滚

贡献指南

附录

CLion配置

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

CANN/acl