docs: Update algorithms, models and image banner in README - #298
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Both news entries incorrectly imply that a dedicated M2PO recipe exists.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates both READMEs to reflect current capabilities and resources.
Changes:
- Expands algorithm and model support tables.
- Adds recent updates and examples.
- Resizes the banner and updates repository links.
File summaries
| File | Description |
|---|---|
README.md |
Updates English project documentation. |
README_zh.md |
Mirrors updates in Chinese. |
Review details
- Files reviewed: 2/3 changed files
- Comments generated: 2
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
ShigureNyako
left a comment
ShigureNyako
left a comment
There was a problem hiding this comment.
Approved — I found no blocking issues at 3e32ddf.
I verified the bilingual README changes against the current tree: the algorithm entries are wired into the implementation, the listed model variants and examples have corresponding scripts/directories, all newly linked local guides and examples exist, and the updated 1004×240 banner renders correctly. The earlier recipe wording is now precise about runnable RLOO/REINFORCE++ recipes versus reference coverage.
All five head checks pass (pre-commit, lint, and tests on Python 3.10–3.12).
LGTMeow
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🟡 Changes recommended
Both model tables incorrectly classify Qwen3.8-27B as text-only.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
- Files reviewed: 2/3 changed files
- Comments generated: 2
- Review effort level: Balanced
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🔵 Needs a closer look
The English README links to a Chinese-only algorithm recipes page.
Review details
Suppressed comments (1)
Previously missed (1) — in code that hasn't changed since the last review.
README.md:265
- This new link from the English README opens
examples/algorithms/README.md, whose content is entirely Chinese. That leaves English readers without an English landing page for the advertised recipes. Please add an English/bilingual landing page (and preserve a Chinese entry point forREADME_zh.md) or link this row to the English algorithm reference instead.
- Files reviewed: 2/3 changed files
- Comments generated: 0 new
- Review effort level: Balanced
Co-authored-by: Codex <noreply@openai.com>
# 📝 Documentation ## Add Iris to projects built upon Relax - List Iris in the English and Chinese README project tables - Describe its open-weight long-horizon search and context-management focus Co-authored-by: Codex <noreply@openai.com>
There was a problem hiding this comment.
🔵 Needs a closer look
Both supported-model tables omit several model sizes already configured and used by the repository.
Review details
Suppressed comments (2)
Previously missed (2) — in code that hasn't changed since the last review.
README.md:121
- The refreshed supported-model table remains incomplete: the repository provides model configs for Qwen3 0.6B, 1.7B, 8B, and 32B and Qwen3-VL 2B and 8B; runnable examples also consume the 0.6B, 1.7B, and VL-2B configs. Listing only these two sizes for each family therefore understates what Relax supports. Please include the committed sizes (or explicitly label this as a curated subset).
README_zh.md:121 - 更新后的支持模型表仍不完整：仓库中已有 Qwen3 0.6B、1.7B、8B、32B 以及 Qwen3-VL 2B、8B 的模型配置，可运行示例也实际使用了 0.6B、1.7B 和 VL-2B 配置。当前列表会让读者误以为 Relax 只支持这里列出的两个规模；请补齐已提交的规模，或明确说明该表仅列举部分模型。
- Files reviewed: 2/3 changed files
- Comments generated: 0 new
- Review effort level: Balanced
What
Update algorithms, models and image banner in README.
Why
-How
-Testing
pre-commit run --all-filespassespytest tests/)Type of Change
Screenshots / Logs
-Preview links