已合并
fix(rl): correct README structure and references #450
fix(rl): correct README structure and references #450
已合并
zhoujian创建于 27 天前
zhoujian
zhoujian成员
27 天前

描述

correct README structure and references

关联的Issue

测试

文档更新

类型标签

其他信息

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 zhoujian 的贡献)
zhoujianzhoujian成员
27 天前 创建了 pull request,commit 13a3cd6b
atomgit-bot
atomgit-bot
27 天前 评论:

变更摘要

本次 PR 主要修复了 RL(强化学习)相关 README 文档的结构和引用问题。变更涉及 1 个文件,共新增 4 行、删除 6 行,属于文档层面的 Bug 修复与内容优化。

主要改动

  • README 结构调整:重新组织了 RL 模块 README 的章节/内容布局,修正了文档结构上的不当之处
  • 文档引用修正:修复了 README 中错误的内部或外部引用链接/路径,确保引用指向正确
likedislike
atomgit-bot
atomgit-bot
27 天前 评论:

代码审查

我已完整审查了变更文件 tutorials/rl_training_pipeline/README.md。以下是我的分析:


变更分析

变更 1:CANN 安装指南 URL(第 33 行)

  • …/CANNCommunityEdition/600alpha003/…/atlasdeploy_03_0001.html
  • …/CANNCommunityEdition/900/…/index.html

版本从 600alpha003 更新为 900,与第 12 行声明的「CANN 版本 9.0.0 及以上」一致。URL 路径结构变化符合昇腾文档站点的重构惯例。✅ 无问题。

变更 2:第 1 章标题修正(第 45–47 行)

  • ### 01-sft:Wordle SFT 监督微调 + #### 第 1 章:SFT 概念与 Wordle 任务 (01_sft_and_wordle/)
  • ### 第 1 章:强化学习训练环境准备

旧标题错误地将第 1 章标注为「SFT 监督微调」,但该章节下所有 notebook 均链接到 01_environment_setup/,内容为 verl/vLLM-Ascend 环境准备。旧标题还引用了一个不存在的目录 01_sft_and_wordle/。新标题与实际内容一致,且与其他章节(第 2–4 章)的 ### 层级一致。✅ 无问题。

变更 3:参考链接更新(第 85–86 行)

  • Prime-RL Wordle 示例路径从 …/examples/wordle 更正为 …/examples/basic/wordle(上游仓库已重组目录)。
  • Verifiers 链接从 main 分支浮动引用改为固定 commit 8d4b332… 的永久链接,并标注「课程参考版本」,避免上游变更导致链接失效。✅ 无问题。

审查结论

该 diff 是一个纯粹的文档修正,修复了 Issue #208 提出的章节标题错误,并同步更新了两个外部参考链接。所有变更均正确、一致,未引入任何正确性、安全性、可靠性或破坏性变更问题。

本次审查未发现需要报告的问题。

优先级 数量
P0 0
P1 0
P2 0
P3 0

整体风险判断:无风险,可安全合入。

已审查文件

  • tutorials/rl_training_pipeline/README.md — 无问题

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
CANN-robotCANN-robot成员
27 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
27 天前 评论:

CLA Signature Pass

qianbi1999, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
27 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/cann-learning-hub 张德鹏, waimaidaole (2/2) 张德鹏, waimaidaole (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

qianbi1999, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
zhoujianzhoujian成员
27 天前 update merge request[project id: 9260575, iid: 450, commit_id: 524886ddf2ec91b7412cb5848ae512ac57751fde] virtual merging success
zhoujianzhoujian成员
27 天前 推送  1 个提交:730ec4a5-docs(rl): align chapter heading format
zhoujianzhoujian成员
27 天前 update merge request[project id: 9260575, iid: 450, commit_id: e0138cb4cc9be8bb8706e02ba9d6e99449eb95e4] virtual merging success
CANN-robotCANN-robot成员
27 天前 添加了label:stat/needs-squash
zhoujianzhoujian成员
27 天前 关联了issue:[Documentation|文档反馈]: RL 课程 README 将第 1 章误标为 SFT
meme成员
24 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
24 天前 添加了label:approved
张德鹏成员
20 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
20 天前 添加了label:lgtm
CANN-robotCANN-robot成员
20 天前 合入了pull request
zhoujianzhoujian成员
18 天前 修改了pull request 的描述