Conversation
Signed-off-by: liwuhen <liwuhen5788@gmail.com>
liwuhen
commented
Jun 1, 2026
liwuhen
left a comment
Owner
Author
There was a problem hiding this comment.
Code Review — fix: docs error
结论:✅ 改动正确,建议合并;但同一文件还有一处遗漏需要一并修正。
✅ 本次改动是对的
把 yolov5 改成 a_yolom 是正确的。yolov5 从来就不是构建系统支持的模型参数,只有两个合法模型:
scripts/config.sh:48→MODEL_SETS=("yolop" "a_yolom")scripts/build.sh:70-73→ 只有yolop和a_yolom会设置LIB_PATH/APP_PATH
所以原来文档里的 build.sh yolov5 ... / run.sh yolov5 ... 会因为 APP_PATH 为空而失败。改成 a_yolom 后命令才能真正跑通(a_yolom 确实存在:runapp/a_yolom/main.cpp、modules/config/yaml/a_yolom/a_yolom_config.yaml)。
🔴 同文件还有一处遗漏(Quickstart.md:51-53)
"Available model parameters" 表格仍然写着错误的模型名:
- Available model parameters are as follows:
|yolov5|yolox|
|:-:|:-:|
yolov5 和 yolox 都不是受支持的模型。既然这个 PR 就是修 "docs error" 且正好改的就是这一节,建议把表格也一起改成与 MODEL_SETS 一致:
- Available model parameters are as follows:
|yolop|a_yolom|
|:-:|:-:|
否则文档在修正后的命令上方几行,仍然在引导用户使用非法的模型名。
🟡 小问题(不阻塞合并)
- 平台表格大小写不一致(Quickstart.md:49):平台表写的是
|NVIDIA|QNN|,但示例命令里用的都是小写nvidia。建议确认脚本期望的大小写并统一。 - 示例里的多余空格:
build.sh a_yolom nvidia -x86在 flag 前有两个空格,属于历史遗留、无害,可顺手清理。
建议
命令示例的修改本身是正确的;请在本 PR 内一并修正第 52 行的 |yolov5|yolox| 模型表格,使这一节内部保持一致。
🤖 Reviewed with Claude Code
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
#1
Fix: Quickstart error#1
Type of Change
The [x] notation can be used to indicate compliance with the selection.
Checklist
The [x] notation can be used to indicate compliance with the selection.