Skip to content

docs: fix the broken link in zh rknn docs #1311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jack-ma merged 1 commit into from
Jan 30, 2026
Merged

docs: fix the broken link in zh rknn docs #1311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/common/ai/_rknn_custom_yolo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
很多用户可以跑通 [RKNN Model Zoo](https://github.com/airockchip/rknn_model_zoo) 仓库里的 YOLO 模型示例，但反馈不知道如何转换自己训练的 YOLO 系列模型，在 [板端部署 YOLOv5 目标检测](rknn_toolkit_lite2_yolov5) 或者在
很多用户可以跑通 [RKNN Model Zoo](https://github.com/airockchip/rknn_model_zoo) 仓库里的 YOLO 模型示例，但反馈不知道如何转换自己训练的 YOLO 系列模型，在 [板端部署 YOLOv5 目标检测](rknn-toolkit-lite2-yolov5) 或者在
[RKNN Model Zoo](https://github.com/airockchip/rknn_model_zoo) 中的 YOLO 系列模型，
使用的模型是 Rockchip 提供下载的 ONNX 模型和 radxa 提供的预编译 rknn 模型。此文档将讲述如何使用 RKNN 编译自训练的 YOLO 模型，并在板端上进行推理

Expand Down Expand Up @@ -106,7 +106,7 @@ Results saved to /mnt/ssd/rknn/rknn_model_zoo/examples/yolo11/model/runs/detect/

#### 使用 ultralytics 转换

如果是 ultralytics 发布的模型，可以使用 Ultralytics 进行模型转换, 详细介绍请参考 [RKNN Ultralytics YOLOv11](./rknn_ultralytics)
如果是 ultralytics 发布的模型，可以使用 Ultralytics 进行模型转换, 详细介绍请参考 [RKNN Ultralytics YOLOv11](./rknn-ultralytics)

<NewCodeBlock tip="X86 Linux PC" type="PC">

Expand Down Expand Up @@ -160,7 +160,7 @@ Results saved to /mnt/ssd/rknn/rknn_model_zoo/examples/yolo11/model/runs/detect/
如果非 ultralytics 的 yolo 模型，rknn_model_zoo/examples 下对应的 yolo 模型目录下都有一个 `python/convert.py` 脚本，可以使用此脚本对 ONNX 模型直接转换成 fp 格式的 RKNN 模型
将 pytorch 模型导出为 ONNX 模型后使用 convert.py 脚本指定量化类型为 `fp` 即可

具体请参考 [板端部署 YOLOv5 目标检测](rknn_toolkit_lite2_yolov5#pc端模型转换)
具体请参考 [板端部署 YOLOv5 目标检测](rknn-toolkit-lite2-yolov5#pc端模型转换)

### 转换 INT8 量化模型

Expand Down Expand Up @@ -325,7 +325,7 @@ done

- 修改 `rknn_model_zoo/py_utils/rknn_executor.py` 代码，**请备份原版代码**

请根据[板端安装 RKNN Model Zoo](./rknn_model_zoo) 配置 RKNN Model Zoo 代码仓库
请根据 [板端安装 RKNN Model Zoo](./rknn-model-zoo) 配置 RKNN Model Zoo 代码仓库

<NewCodeBlock tip="Python Code" type="device">

Expand Down
29 changes: 28 additions & 1 deletion docs/common/dev/_rknn-install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ conda activate rknn

</NewCodeBlock>

## 安装依赖包
## 安装 rknn-toolkit2

<NewCodeBlock tip="X86 Linux PC" type="PC">

Expand Down Expand Up @@ -129,6 +129,33 @@ $ python3

</NewCodeBlock>

## 安装 rknn-toolkit-lite2

:::tip
rknn-toolkit-lite2 区别于 rknn_toolkit2 是 rknn-toolkit-lite2 去除模型转换的功能仅集成 NPU 推理的 Python API，
体积更小巧。适合于仅在板端做推理的用户，用户可根据需求选择板端对应 python 版本的 rknn-toolkit-lite2。
:::

<NewCodeBlock tip="Device" type="device">

```bash
cd rknn-toolkit2/rknn-toolkit-lite2/packages
pip3 install rknn_toolkit2-2.3.2-cp3X-cp3X-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Copy link
Contributor

@windsurf-bot windsurf-bot bot Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The installation command for rknn-toolkit-lite2 uses a placeholder 'cp3X-cp3X' in the filename which should be replaced with the actual Python version (e.g., cp38-cp38, cp39-cp39, etc.) based on the Python version being used.

Suggested change
pip3 install rknn_toolkit2-2.3.2-cp3X-cp3X-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
cd rknn-toolkit2/rknn-toolkit-lite2/packages
pip3 install rknn_toolkit2-2.3.2-cp$(python3 -c 'import sys; print(f"{sys.version_info.major}{sys.version_info.minor}")')-cp$(python3 -c 'import sys; print(f"{sys.version_info.major}{sys.version_info.minor}")')-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Alternatively, you could provide examples for common Python versions like 3.8, 3.9, etc.

Copy link
Contributor Author

@zifeng-radxa zifeng-radxa Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is OK, because it have multi python versions

```

</NewCodeBlock>

执行以下命令，若没有报错，则代表 rknn_toolkit-lite2 环境安装成功。

<NewCodeBlock tip="Device" type="device">

```bash
$ python3
>>> from rknnlite.api import RKNNLite as RKNN
```

</NewCodeBlock>

## 编译工具

编译板端运行代码时需要用到交叉编译工具链。
Expand Down
8 changes: 4 additions & 4 deletions docs/common/dev/_rknn-toolkit-lite2-yolov5.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::tip
本文档旨在演示如何在 rockchip RK3588/3566 系列芯片上运行板端推理 YOLOv5 目标检测模型，所需环境配置请参考[ RKNN 安装](./rknn_install)
本文档旨在演示如何在 rockchip RK3588/3566 系列芯片上运行板端推理 YOLOv5 目标检测模型，所需环境配置请参考[ RKNN 安装](./rknn-install)
:::

此示例用 [rknn_model_zoo](https://github.com/airockchip/rknn_model_zoo) 中预训练好的 ONNX 格式模型为例子通过模型转换到板端推理做完整示例。
Expand Down Expand Up @@ -93,7 +93,7 @@ RK356X 产品用户使用 NPU 前需要在终端使用 **rsetup** 开启 NPU: `s

- 修改 `rknn_model_zoo/py_utils/rknn_executor.py` 代码，**请备份原版代码**

请根据[板端安装 RKNN Model Zoo](./rknn_install#可选-板端安装-rknn-model-zoo) 配置 RKNN Model Zoo 代码仓库
请根据 [RKNN Model Zoo](./rknn-model-zoo) 配置 RKNN Model Zoo 代码仓库

<NewCodeBlock tip="Python Code" type="device">

Expand Down Expand Up @@ -140,9 +140,9 @@ RK356X 产品用户使用 NPU 前需要在终端使用 **rsetup** 开启 NPU: `s

- 进入虚拟环境

虚拟环境使用请参考: [Python 虚拟环境使用](./venv_usage)
虚拟环境使用请参考: [Python 虚拟环境使用](../venv-usage)

安装 rknn_toolkit-lite2 Python API 请参考 [板端虚拟环境中安装 rknn_toolkit-lite2 Python API](./rknn_install#可选-板端虚拟环境中安装-rknn_toolkit-lite2-python-api)
安装 rknn_toolkit-lite2 Python API 请参考 [安装 rknn_toolkit-lite2](./rknn-install#安装-rknn_toolkit-lite2)

- 安装依赖环境
```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/common/dev/_rknn-toolkit-lite2-yolov8.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::tip
本文档旨在演示如何在 rk3588 上运行板端推理 YOLOv8 目标检测模型，所需环境配置请参考[ RKNN 安装](./rknn_install)
本文档旨在演示如何在 rk3588 上运行板端推理 YOLOv8 目标检测模型，所需环境配置请参考[ RKNN 安装](./rknn-install)
:::

此示例用 [rknn_model_zoo](https://github.com/airockchip/rknn_model_zoo) 中预训练好的 ONNX 格式模型为例子通过模型转换到板端推理做完整示例，此示例目标平台为 rk3588。
Expand All @@ -11,7 +11,7 @@

### PC端模型转换

**Radxa 已提供预转换好的 `yolov8.rknn` 模型，用户可直接参考[板端推理 YOLOv8 ](#板端推理-yolov8)跳过 PC 端模型转换章节**
**Radxa 已提供预转换好的 `yolov8.rknn` 模型，用户可直接参考 [板端推理 YOLOv8 ](#板端推理-yolov8)跳过 PC 端模型转换章节**

- 如使用 conda 请先激活 rknn conda 环境

Expand Down
2 changes: 1 addition & 1 deletion docs/common/dev/_rknn-toolkit2-pc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:::tip
本文档旨在演示如何在 x86 PC 上使用 rknn-toolkit2 脱离开发板模拟推理 YOLOv5 目标分割模型，所需环境配置请参考[ RKNN 安装](./rknn_install)
本文档旨在演示如何在 x86 PC 上使用 rknn-toolkit2 脱离开发板模拟推理 YOLOv5 目标分割模型，所需环境配置请参考[ RKNN 安装](./rknn-install)
:::

## 准备模型
Expand Down
4 changes: 2 additions & 2 deletions docs/common/dev/_rknn-ultralytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## PC 端模型转换

**Radxa 已提供预转换好的 `yolov11n.rknn` 模型，用户可直接参考[板端推理 YOLOv11 ](#板端推理-yolov11)跳过 PC 端模型转换章节**
**Radxa 已提供预转换好的 `yolov11n.rknn` 模型，用户可直接参考 [板端推理 YOLOv11](#板端推理-yolov11) 跳过 PC 端模型转换章节**

- 安装最新版本的 ultralytics

Expand Down Expand Up @@ -80,7 +80,7 @@ RK356X 产品用户使用 NPU 前需要在终端使用 **rsetup** 开启 NPU: `s

- 在虚拟环境下安装最新版本的 ultralytics

虚拟环境安装请参考 [Python 虚拟环境使用](venv_usage)
虚拟环境安装请参考 [Python 虚拟环境使用](../venv-usage)

<NewCodeBlock tip="Radxa OS" type="device">

Expand Down
4 changes: 1 addition & 3 deletions docs/common/dev/_venv_usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,8 @@ error: externally-managed-environment

### 安装虚拟环境

以 python3.11 为例子

```bash
sudo apt install python3.11-venv
sudo apt install python3-venv
```

### 建立虚拟环境
Expand Down
Loading