Skip to content

fix: docs error#2

Merged
liwuhen merged 1 commit into
mainfrom
dev_main
Jun 18, 2026
Merged

fix: docs error#2
liwuhen merged 1 commit into
mainfrom
dev_main

Conversation

@liwuhen

@liwuhen liwuhen commented Jun 1, 2026

Copy link
Copy Markdown
Owner

Description

Related Issue

#1
Fix: Quickstart error#1

Type of Change

The [x] notation can be used to indicate compliance with the selection.

  • Examples / docs / dependencies update.
  • Bug fix.
  • Improvement (non-breaking change which improves an existing feature).
  • New feature (non-breaking change which adds functionality).
  • Security fix.

Checklist

The [x] notation can be used to indicate compliance with the selection.

  • My code follows the style guidelines of this project.
  • I have reviewed the CODE_OF_CONDUCT.md document.
  • I have consulted the CONTRIBUTING.md guide.
  • I have applied the code style updates using make codestyle.
  • I have authored tests for any new methods and classes.
  • I have documented all utilized methods and classes in Google style docstrings.
  • New and existing unit tests pass locally with my changes

Signed-off-by: liwuhen <liwuhen5788@gmail.com>

@liwuhen liwuhen left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Code Review — fix: docs error

结论:✅ 改动正确,建议合并;但同一文件还有一处遗漏需要一并修正。

✅ 本次改动是对的

yolov5 改成 a_yolom 是正确的。yolov5 从来就不是构建系统支持的模型参数,只有两个合法模型:

  • scripts/config.sh:48MODEL_SETS=("yolop" "a_yolom")
  • scripts/build.sh:70-73 → 只有 yolopa_yolom 会设置 LIB_PATH / APP_PATH

所以原来文档里的 build.sh yolov5 ... / run.sh yolov5 ... 会因为 APP_PATH 为空而失败。改成 a_yolom 后命令才能真正跑通(a_yolom 确实存在:runapp/a_yolom/main.cppmodules/config/yaml/a_yolom/a_yolom_config.yaml)。

🔴 同文件还有一处遗漏(Quickstart.md:51-53)

"Available model parameters" 表格仍然写着错误的模型名:

- Available model parameters are as follows:
    |yolov5|yolox|
    |:-:|:-:|

yolov5yolox 都不是受支持的模型。既然这个 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

@liwuhen liwuhen self-assigned this Jun 1, 2026
@liwuhen
liwuhen merged commit 67a2fd1 into main Jun 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant