"git@developer.sourcefind.cn:yangql/googletest.git" did not exist on "7e5f90d3780d553cb86771141fb81349f3a63508"
Commit 27ba98d1 authored by YdrMaster's avatar YdrMaster
Browse files

issue/52: 修改 README.md,添加格式化脚本使用说明


Signed-off-by: default avatarYdrMaster <ydrml@hotmail.com>
parent e9b6de3a
# InfiniCore
InfiniCore是一个跨平台统一编程工具集,为不同芯片平台的功能(包括计算、运行时、通信等)提供统一 C 语言接口。目前支持的芯片包括CPU、英伟达GPU、华为昇腾NPU、寒武纪MLU、摩尔线程GPU、天数智芯GPU、沐曦GPU、曙光DCU、昆仑芯。
InfiniCore 是一个跨平台统一编程工具集,为不同芯片平台的功能(包括计算、运行时、通信等)提供统一 C 语言接口。目前支持的硬件和后端包括:
## 一、使用说明
- CPU;
- CUDA
- 英伟达 GPU;
- 摩尔线程 GPU;
- 天数智芯 GPU;
- 沐曦 GPU;
- 曙光 DCU;
- 华为昇腾 NPU;
- 寒武纪 MLU;
- 昆仑芯 XPU;
### 1. 配置
## 配置和使用
#### 查看当前配置
1. 项目配置
```xmake
xmake f -v
```
- 查看当前配置
#### 配置 CPU (默认配置)
```shell
xmake f -v
```
```xmake
xmake f -cv
```
- 配置 CPU(默认配置)
#### 配置加速卡
```shell
xmake f -cv
```
```xmake
# 英伟达
# 可以指定 CUDA 路径, 一般环境变量为 `CUDA_HOME` 或者 `CUDA_ROOT`
xmake f --nv-gpu=true --cuda=$CUDA_HOME -cv
- 配置加速卡
# 寒武纪
xmake f --cambricon-mlu=true -cv
```shell
# 英伟达
# 可以指定 CUDA 路径, 一般环境变量为 `CUDA_HOME` 或者 `CUDA_ROOT`
xmake f --nv-gpu=true --cuda=$CUDA_HOME -cv
# 华为昇腾
xmake f --ascend-npu=true -cv
```
# 寒武纪
xmake f --cambricon-mlu=true -cv
### 2. 编译安装
# 华为昇腾
xmake f --ascend-npu=true -cv
```
```xmake
xmake build && xmake install
# 默认安装路径为 $HOME/.infini
```
2. 编译安装
默认安装路径为 `$HOME/.infini`
```shell
xmake build && xmake install
```
3. 设置环境变量
按输出提示设置 `INFINI_ROOT``LD_LIBRARY_PATH` 环境变量。
4. 运行算子测试
### 3. 设置环境变量
```shell
python test/infiniop/[operator].py [--cpu | --nvidia | --cambricon | --ascend]
```
按输出提示设置 `INFINI_ROOT``LD_LIBRARY_PATH` 环境变量。
## 开发指南
### 4. 运行算子测试
### 代码格式化
```bash
python test/infiniop/[operator].py [--cpu | --nvidia | --cambricon | --ascend]
本项目使用 [`scripts/format.py`](/scripts/format.py) 脚本实现代码格式化检查和操作。
使用
```shell
python scripts/format.py -h
```
查看脚本帮助信息:
```plaintext
usage: format.py [-h] [--ref REF] [--path [PATH ...]] [--check] [--c C] [--py PY]
options:
-h, --help show this help message and exit
--ref REF Git reference (commit hash) to compare against.
--path [PATH ...] Files to format or check.
--check Check files without modifying them.
--c C C formatter (default: clang-format-16)
--py PY Python formatter (default: black)
```
参数中:
- `ref``path` 控制格式化的文件范围
-`ref``path` 都为空,格式化当前暂存(git added)的文件;
- 否则
-`ref` 非空,将比较指定 commit 和当前代码的差异,只格式化修改过的文件;
-`path` 非空,可传入多个路径(`--path p0 p1 p2`),只格式化指定路径及其子目录中的文件;
- 若设置 `--check`,将检查代码是否需要修改格式,不修改文件内容;
- 通过 `--c` 指定 c/c++ 格式化器,默认为 `clang-format-16`
- 通过 `--python` 指定 python 格式化器 `black`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment