已合并
[DOC] 资料优化:安装部署资料优化,新增功能特性章节 #2322
penghuiyang创建于 3月19日
[DOC] 资料优化:安装部署资料优化,新增功能特性章节 #2322
已合并
penghuiyang创建于 3月19日
penghuiyang成员
3月19日

问题/功能描述

本次PR主要包含三部分文档优化工作。首先,重构了主项目文档,将冗长的Roadmap细节外链以简化README,并优化了目录结构和术语解释。其次,重构了Rec SDK Torch的安装部署文档,解决了原文档结构分散、依赖不清、步骤复杂的问题,旨在提供更清晰的安装指南。最后,为hybrid_torchrec和torchrec_embcache两个组件新增了详细的测试套件说明文档,解决了用户缺乏明确测试指引的问题,提升了组件的易用性和可测试性。

修改方案描述

  1. 项目文档重构与优化:仓库最外层README.md中增加部分子章节: 各组件说明、代码分支说明、适配模型说明等。
  2. 安装部署文档重构:torch_rec_v1组件,系统性重组了安装指南,新增“配套版本”和“依赖软件说明”章节,并以表格清晰列出。将安装流程重构为三种明确方案(容器、源码编译、Release+源码),并为每种方案提供了完整、独立的操作步骤。新增了“安装验证”章节。
  3. 测试文档补充:在主README中新增“运行测试”章节并链接到详细文档。分别为hybrid_torchrec和torchrec_embcache创建/更新了详细的测试套件说明文档(test/st/README.md和tests/acc_test/README.md),介绍了测试用例、目录结构和运行方法。
  4. 新增功能特性章节:torch_rec_v1组件新增功能特性章节,介绍各个功能特性说明,以及代码使用示例。

开发自检

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 penghuiyang 的贡献)
Ppenghuiyang成员
3月19日 创建了 pull request,commit 5451ecc6
ascend-robotascend-robot成员
3月19日 添加了label:stat/needs-squash
ascend-robot
ascend-robot成员
3月19日 评论:

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-Ascend/RecSDK ✅ xiajunhua, aizouba, tqy1998, zxorange_321 (4/3) ✅ tqy1998 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
ascend-robotascend-robot成员
3月19日 添加了label:ascend-cla/yes
ascend-robotascend-robot成员
3月19日 添加了label:ci-pipeline-running
此处折叠了351条消息 查看更多
ascend-robotascend-robot成员
3月30日 添加了label:lgtm
taoqiuyu1998
taoqiuyu1998成员
3月30日 评论:

/approve

likedislike
ascend-robotascend-robot成员
3月30日 添加了label:approved
ascend-robot
ascend-robot成员
3月30日 评论:

Review Guide

This pull-request passes review.
Committers who wrote a comment of /approve are: tqy1998.
Reviewers who wrote a comment of /lgtm are: zxorange_321, xiajunhua, tqy1998, aizouba.

likedislike
ascend-robotascend-robot成员
3月30日 合入了pull request,合并节点 SHA:fe0bc2e7c0226d3d402c6100ec2a556ed96b8391