Skip to content

docs: 新增对 roi、box 以及 target 的说明#1174

Merged
MistEO merged 4 commits intomainfrom
docs/roi
Mar 3, 2026
Merged

docs: 新增对 roi、box 以及 target 的说明#1174
MistEO merged 4 commits intomainfrom
docs/roi

Conversation

@Windsland52
Copy link
Member

@Windsland52 Windsland52 commented Mar 3, 2026

由 Sourcery 提供的摘要

在管线协议中明确 ROI、box 和 target 的语义,并通过引用 DirectHit 的定义来统一识别算法中 ROI 配置的文档说明。

文档更新:

  • 增加专门章节,阐明图像识别动作中 roiboxtarget 字段在概念上的差异以及典型的处理流程。
  • 为 DirectHit 编写详细的 roiroi_offset 参数说明,并在英文和中文的协议文档中,通过交叉引用的方式,将该定义复用于其他识别算法。
Original summary in English

Summary by Sourcery

Document the semantics of ROI, box, and target in the pipeline protocol and centralize ROI configuration documentation for recognition algorithms by referencing the DirectHit definition.

Documentation:

  • Add a dedicated section clarifying the conceptual differences and typical flow between roi, box, and target fields in image recognition actions.
  • Document detailed roi and roi_offset parameters for DirectHit and reuse this definition across other recognition algorithms via cross-references in both English and Chinese protocol docs.

@Windsland52 Windsland52 changed the title Docs/roi docs: 新增对 roi、box 以及 target 的说明 Mar 3, 2026
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - 我在这里给出了一些高层面的反馈:

  • Same as DirectHit.roiDirectHit.roi_offset 这样的新引用依赖读者已经知道 DirectHit 在哪里被定义;建议把这些引用改成显式链接,或者添加一个锚点,方便读者快速跳转到权威定义处。
  • 在 ROI 描述中使用 💡 表情符号与文档其他部分偏正式的风格不太一致;为保持一致性,建议改用纯文本(例如 Note (v5.6): ...)。
给 AI 代理的提示词
Please address the comments from this code review:

## Overall Comments
- The new references like `Same as DirectHit.roi` and `DirectHit.roi_offset` rely on the reader knowing where `DirectHit` is defined; consider turning these into explicit links or adding an anchor so it’s easy to jump to the canonical definition.
- The use of the 💡 emoji in the ROI description is inconsistent with the otherwise formal style of the docs; consider replacing it with plain text (e.g., `Note (v5.6): ...`) for consistency.

Sourcery 对开源项目是免费的——如果你觉得我们的评审对你有帮助,欢迎分享给更多人 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈改进后续的评审。
Original comment in English

Hey - I've left some high level feedback:

  • The new references like Same as DirectHit.roi and DirectHit.roi_offset rely on the reader knowing where DirectHit is defined; consider turning these into explicit links or adding an anchor so it’s easy to jump to the canonical definition.
  • The use of the 💡 emoji in the ROI description is inconsistent with the otherwise formal style of the docs; consider replacing it with plain text (e.g., Note (v5.6): ...) for consistency.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new references like `Same as DirectHit.roi` and `DirectHit.roi_offset` rely on the reader knowing where `DirectHit` is defined; consider turning these into explicit links or adding an anchor so it’s easy to jump to the canonical definition.
- The use of the 💡 emoji in the ROI description is inconsistent with the otherwise formal style of the docs; consider replacing it with plain text (e.g., `Note (v5.6): ...`) for consistency.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@MistEO MistEO merged commit 6a97392 into main Mar 3, 2026
1 check passed
@MistEO MistEO deleted the docs/roi branch March 3, 2026 19:12
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.

2 participants