Skip to content

docs: update DirectHit algorithm section in documentation#1158

Closed
Windsland52 wants to merge 3 commits intomainfrom
Windsland52-patch-1
Closed

docs: update DirectHit algorithm section in documentation#1158
Windsland52 wants to merge 3 commits intomainfrom
Windsland52-patch-1

Conversation

@Windsland52
Copy link
Copy Markdown
Member

@Windsland52 Windsland52 commented Feb 27, 2026

Added additional fields for the DirectHit algorithm in the documentation.

由 Sourcery 提供的摘要

文档:

  • 在中文版用户指南中记录 DirectHit 算法的更多配置字段。
Original summary in English

Summary by Sourcery

Documentation:

  • 在英文 pipeline 协议文档中描述 DirectHit 算法的 roiroi_offset 配置字段,并在其他算法章节中引用这些字段以避免重复。
Original summary in English

Summary by Sourcery

Documentation:

  • Describe roi and roi_offset configuration fields for the DirectHit algorithm in the English pipeline protocol documentation and reference these fields from other algorithm sections to avoid duplication.

Added additional fields for the DirectHit algorithm in the documentation.
Copy link
Copy Markdown
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 - 我已经审查了你的更改,看起来非常棒!


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

Hey - I've reviewed your changes and they look great!


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.

Added additional fields required for the DirectHit algorithm.
Comment thread docs/zh_cn/3.1-任务流水线协议.md Outdated
该算法属性需额外部分字段:

- `roi`: *array<int, 4>* | *string*
同 `TemplateMatch`.`roi` 。
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

DirectHit 在前面的,同后面的 TemplateMatch 总感觉哪里不对劲)

另外再好说一下这玩意在 DirectHit 里的实际效果?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

难道写在directhit里,别的同directhit吗,感觉怪怪的
效果的话,跟别的好像也没啥区别吧,就是直接把roi作为box返回

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

因为这是个现象而非设计(大概
所以很难说有没有用(

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

要是 and or 改之前的话还是有点用的

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

directhit用roi的感觉大部分都是没搞懂roi box 和target区别的

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

是吧,所以更要说清楚一点了,不然很多人都来问这个干嘛用的

@Windsland52 Windsland52 marked this pull request as draft February 28, 2026 11:57
@Windsland52 Windsland52 marked this pull request as ready for review March 3, 2026 18:41
@Windsland52
Copy link
Copy Markdown
Member Author

先这样吧,roi,box,target区分另开一个pr

Copy link
Copy Markdown
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.roi 这样的交叉引用行内代码格式有点别扭;可以考虑改成 `Same as DirectHit.roi.` 或 `Same as \\`DirectHit\\`.\\`roi\\,这样在 Markdown 渲染时会更清晰。
  • roi 的说明中使用表情符号标记 **💡 v5.6** 可能与文档其余部分的风格不太一致;为保持一致性,可以考虑改成纯文本提示,例如 Note (v5.6): ...
给 AI Agent 的提示词
Please address the comments from this code review:

## Overall Comments
- The inline code formatting for cross-references like `Same as `DirectHit`.`roi`` is a bit awkward; consider using `Same as DirectHit.roi.` or `Same as \\`DirectHit\\`.\\`roi\\`` for clearer markdown rendering.
- The use of the emoji marker `**💡 v5.6**` in the `roi` description may be inconsistent with the rest of the docs style; consider switching to a plain text note like `Note (v5.6): ...` for consistency.

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

Hey - I've left some high level feedback:

  • The inline code formatting for cross-references like Same as DirectHit.roi is a bit awkward; consider using `Same as DirectHit.roi.` or `Same as \\`DirectHit\\`.\\`roi\\ for clearer markdown rendering.
  • The use of the emoji marker **💡 v5.6** in the roi description may be inconsistent with the rest of the docs style; consider switching to a plain text note like Note (v5.6): ... for consistency.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The inline code formatting for cross-references like `Same as `DirectHit`.`roi`` is a bit awkward; consider using `Same as DirectHit.roi.` or `Same as \\`DirectHit\\`.\\`roi\\`` for clearer markdown rendering.
- The use of the emoji marker `**💡 v5.6**` in the `roi` description may be inconsistent with the rest of the docs style; consider switching to a plain text note like `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.

@Windsland52
Copy link
Copy Markdown
Member Author

草了,修改直接被新pr给合了

@Windsland52 Windsland52 closed this Mar 3, 2026
@Windsland52 Windsland52 deleted the Windsland52-patch-1 branch March 13, 2026 03:59
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.

3 participants