AXCL 使用手册

Web Preview

1. 项目背景

AXCL 是基于 AX650N 的 PCIE EP 产品 Host API。

• 提供 AXCL 使用 NPU 计算的相关 API 和示例;
• 促进社区开发人员共同维护文档。

2. 本地编译指南

2.1 git clone

git clone https://github.com/AXERA-TECH/axcl-docs.git

目录如下:

.
├── LICENSE
├── Makefile
├── README.md
├── build
│   ├── doctrees
│   └── html
├── requirements.txt
├── res
│   ├── M2_YUNJI_DSC05130.jpg
│   ├── axcl_architecture.svg
│   ├── axcl_concept.svg
│   ├── centos_dmsg_grep_cma.png
│   ├── centos_grub_info.png
│   ├── centos_selinux.png
│   ├── imagenet_cat.jpg
│   ├── transcode_ppl.png
│   ├── voc_dog.jpg
│   ├── voc_dog_yolov5s_out.jpg
│   ├── voc_horse.jpg
│   └── voc_horse_yolov5s_out.jpg
└── source
    ├── axcl_error_lookup.html
    ├── conf.py
    ├── doc_guide_axcl_api.md
    ├── doc_guide_faq.md
    ├── doc_guide_hardware.md
    ├── doc_guide_quick_start.md
    ├── doc_guide_samples.md
    ├── doc_guide_setup.md
    ├── doc_introduction.md
    ├── doc_update_info.md
    ├── index.rst
    └── media

2.2 编译

安装依赖

pip install -r requirements.txt

在项目根目录下执行以下命令

$ make clean
$ make html

2.3 本地预览

编译后，使用浏览器查看它 build/html/index.html

3. 参考设计

这个项目是基于Sphinx，更多关于Sphinx的信息可以在这里找到 https://www.sphinx-doc.org/en/master/

4. 在线发布

基于 ReadtheDocs 平台代理在线 Web 服务。