Skip to content

Commit 5c230fd

Browse files
authored
update readme (#10)
1 parent bc76323 commit 5c230fd

File tree

2 files changed

+59
-3
lines changed

2 files changed

+59
-3
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,57 @@
1-
# pyaxengine
1+
# PyAXEngine
2+
3+
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://raw.githubusercontent.com/AXERA-TECH/pyaxengine/main/LICENSE)
4+
5+
## 简介
6+
7+
**PyAXEngine** 基于 cffi 模块实现了 Axera NPU Runtime 的 Python API,方便开源社区开发者使用 Python 脚本快速构建 NPU 推理脚本
8+
9+
支持芯片
10+
11+
- AX650N
12+
- AX630C
13+
14+
环境版本
15+
16+
- python >= 3.8
17+
- cffi >= 1.0.0
18+
- ml-dtypes >= 0.1.0
19+
20+
## 快速上手
21+
22+
基于社区开发板 **爱芯派Pro(AX650N)** 进行展示
23+
24+
### 获取 wheel 包并安装
25+
26+
- [下载链接](https://github.com/AXERA-TECH/pyaxengine/releases/download/0.0.1rc1/axengine-0.0.1-py3-none-any.whl)
27+
-`axengine-x.x.x-py3-none-any.whl` 拷贝到开发板上,执行 `pip install axengine-x.x.x-py3-none-any.whl` 安装
28+
29+
### 简单示例
30+
31+
[classification.py](https://github.com/AXERA-TECH/pyaxengine/blob/main/examples/classification.py) 拷贝到开发板上并执行。
32+
33+
```
34+
root@ax650:~/samples# python3 classification.py
35+
[INFO] Chip type: ChipType.AX650
36+
[INFO] Engine version: 2.7.2a
37+
[INFO] VNPU type: VNPUType.DISABLED
38+
[INFO] Model type: 0 (single core)
39+
[INFO] Compiler version: 1.2-patch2 7e6b2b5f
40+
Top 5 Predictions:
41+
Class Index: 282, Score: 9.77352523803711
42+
Class Index: 278, Score: 8.981077194213867
43+
Class Index: 277, Score: 8.452778816223145
44+
Class Index: 281, Score: 8.320704460144043
45+
Class Index: 287, Score: 7.924479961395264
46+
```
47+
48+
## 关联项目
49+
50+
- [ax-samples](https://github.com/AXERA-TECH/ax-samples)
51+
- [ax-llm](https://github.com/AXERA-TECH/ax-llm)
52+
- [pulsar2](https://pulsar2-docs.readthedocs.io/zh-cn/latest/)
53+
54+
## 技术讨论
55+
56+
- Github issues
57+
- QQ 群: 139953715

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
],
1818
packages=["axengine"],
1919
ext_modules=[],
20-
install_requires=["cffi>=1.0.0", "numpy>=1.22", "ml-dtypes>=0.1.0"],
21-
setup_requires=["cffi>=1.0.0", "numpy>=1.22", "ml-dtypes>=0.1.0"],
20+
install_requires=["cffi>=1.0.0", "ml-dtypes>=0.1.0"],
21+
setup_requires=["cffi>=1.0.0", "ml-dtypes>=0.1.0"],
2222
)

0 commit comments

Comments
 (0)