# kutacc

**Repository Path**: kunpeng-hpc/kutacc

## Basic Information

- **Project Name**: kutacc
- **Description**: No description available
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 6
- **Created**: 2025-07-30
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- # Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
 
 Licensed under a modified version of the MIT license. See LICENSE in the project root for license information.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE. -->
 
 # Kunpeng Unifined Transformer Accelerated Library

## 1.简介
鲲鹏芯片支持向量、矩阵计算，带来算力提升的同时，辅以高速RDMA网络，带来超大带宽、微秒级延迟的极致性能。该芯片强浮点算力和高速带宽天然亲和AI推理计算。基于此，我们提出一种鲲鹏平台上Transformer模型融合算子库（简称"KuTACC"），高效实现Transformer模型推理在鲲鹏处理器的执行。

## 2.本地运行

### 2.1 依赖软件安装

#### 2.1.1 HPCKit安装
该方案是用HPCKit组件中的毕昇编译器进行编译，HPCKit安装流程参考[官方指导文档](https://www.hikunpeng.com/developer/hpc/hpckit-download)。

KuTACC的安装需要使用HPCKit环境中的毕昇编译器、KUPL，配置流程参考[HPCKit介绍](https://www.hikunpeng.com/document/detail/zh/kunpenghpcs/hpckit/devg/KunpengHPCKit_developer_002.html)。

### 2.2 源码编译与安装
可以使用build.sh将KuTACC安装在任意指定的路径下，同时支持release/debug模式的库安装。
```shell
sh build.sh --install_path=/path/to/your/kutacc-path --build_type=Release/Debug
```

### 2.3 环境变量配置
将KuTACC的LIB和Include设置后即可调用kutacc中的相应接口。
```shell
export KUTACC_LIB=/path_to_kutacc/install/lib
export KUTACC_INCLUDE=/path_to_kutacc/install/include
```
要使用KuTACC提供的接口，需要在项目文件中增加对这两个参数的引用，即在CXX的编译参数上增加以下内容
```shell
export CXXFLAGS="-I${KUTACC_INCLUDE}"
export LDFLAGS="-L${KUTACC_LIB}"
export LDLIBS="-lkutacc"
```
设置环境变量后，编译某个程序的编译脚本为
```shell
g++/clang xxx.o $(LDFLAGS) $(LDLIBS) -o $@
g++/clang $(CXXFLAGS) -c xxx.cpp -o xxx.o
```

若项目使用CMAKE进行管理，推荐使用target接口进行链接
```shell
# include路径
target_include_directories(yourapp PRIVATE ${KUTACC_INCLUDE})

# lib路径
target_link_libraries(yourapp PRIVATE ${KUTACC_LIB})
```

## 3. 支持的应用

| 支持的应用    | 应用版本|
| :------------ | -----------: |
| Alphafold2    | v1.0    |

## License
此代码遵循[OpenSoftware License 1.0](LICENSE)，继承自MIT。

## 联系方式
如果您有任何疑问，请欢迎提issue共同讨论。