Skip to content

Commit 48dc215

Browse files
authored
Merge pull request #126 from 1985312383/main
Update Readme files
2 parents eae70fd + 5d2b336 commit 48dc215

4 files changed

Lines changed: 37 additions & 14 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Q&A / 使用咨询
5+
url: https://github.com/datawhalechina/torch-rechub/discussions
6+
about: 请在 Discussions 中提出一般性问题、使用咨询或非 Bug 报告
7+

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
English | [简体中文](README_zh.md)
1616

17+
**Online Documentation:** https://datawhalechina.github.io/torch-rechub/ (English) | https://datawhalechina.github.io/torch-rechub/zh/ (简体中文)
18+
1719
**Torch-RecHub** is a flexible and extensible recommender system framework built with PyTorch. It aims to simplify research and application of recommendation algorithms by providing common model implementations, data processing tools, and evaluation metrics.
1820

1921
![Torch-RecHub Banner](docs/public/img/readme_banner_1.png)
@@ -22,7 +24,7 @@ English | [简体中文](README_zh.md)
2224

2325
* **Modular Design:** Easy to add new models, datasets, and evaluation metrics.
2426
* **PyTorch-based:** Leverages PyTorch's dynamic graph and GPU acceleration capabilities.
25-
* **Rich Model Library:** Contains various classic and cutting-edge recommendation algorithms.
27+
* **Rich Model Library:** Contains various classic and cutting-edge recommendation algorithms, including matching, ranking, multi-task, and **generative models (HSTU, HLLM)**.
2628
* **Standardized Pipeline:** Provides unified data loading, training, and evaluation workflows.
2729
* **Easy Configuration:** Adjust experiment settings via config files or command-line arguments.
2830
* **Reproducibility:** Designed to ensure reproducible experimental results.
@@ -124,13 +126,13 @@ torch-rechub/ # Root directory
124126
│ └── mtl.py # Multi-task utilities
125127
├── examples/ # Example scripts
126128
│ ├── matching/ # Matching task examples
127-
│ └── ranking/ # Ranking task examples
128-
├── docs/ # Documentation
129+
│ ├── ranking/ # Ranking task examples
130+
│ └── generative/ # Generative recommendation examples (HSTU, HLLM, etc.)
131+
├── docs/ # Documentation (VitePress: multi-language, English & Chinese)
129132
├── tutorials/ # Jupyter tutorials
130133
├── tests/ # Unit tests
131134
├── config/ # Configuration files
132-
├── scripts/ # Utility scripts
133-
└── mkdocs.yml # MkDocs config file
135+
└── scripts/ # Utility scripts
134136
```
135137

136138
## 💡 Supported Models
@@ -163,11 +165,17 @@ The framework currently supports the following recommendation models:
163165
**Multi-Task Recommendation:**
164166

165167
* **[ESMM](https://arxiv.org/pdf/1804.07931.pdf):** Entire Space Multi-Task Model
166-
* **[MMoE](https://dl.acm.org/doi/pdf/10.1145/3219819.3220007):** Multi-Task Multi-Interest Network for Recommendation
168+
* **[MMoE](https://dl.acm.org/doi/pdf/10.1145/3219819.3220007):** Multi-gate Mixture-of-Experts for Multi-Task Learning
167169
* **[PLE](https://dl.acm.org/doi/pdf/10.1145/3394486.3403394):** Personalized Learning to Rank
168170
* **[AITM](https://arxiv.org/pdf/2005.02553.pdf):** Adaptive Interest-Task Matching
169171
* ...
170172

173+
**Generative Recommendation:**
174+
175+
* **[HSTU](https://arxiv.org/abs/2402.17152v3):** Hierarchical Sequential Transduction Units based generative sequential recommendation model.
176+
* **[HLLM](https://arxiv.org/abs/2508.18118v1):** Hierarchical Large Language Model for recommendation with LLM-based item embeddings.
177+
* ...
178+
171179
## 📊 Supported Datasets
172180

173181
The framework provides built-in support or preprocessing scripts for the following common datasets:
@@ -299,4 +307,4 @@ If you use this framework in your research or work, please consider citing:
299307

300308
---
301309

302-
*Last updated: [2025-06-30]*
310+
*Last updated: [2025-11-27]*

README_zh.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
[English](README.md) | 简体中文
1616

17+
**在线文档:** https://datawhalechina.github.io/torch-rechub/ (英文)| https://datawhalechina.github.io/torch-rechub/zh/ (简体中文)
18+
1719
**Torch-RecHub** 是一个使用 PyTorch 构建的、灵活且易于扩展的推荐系统框架。它旨在简化推荐算法的研究和应用,提供常见的模型实现、数据处理工具和评估指标。
1820

1921
![Torch-RecHub 横幅](docs/public/img/readme_banner_1.png)
@@ -22,7 +24,7 @@
2224

2325
* **模块化设计:** 易于添加新的模型、数据集和评估指标。
2426
* **基于 PyTorch:** 利用 PyTorch 的动态图和 GPU 加速能力。
25-
* **丰富的模型库:** 包含多种经典和前沿的推荐算法(请在下方列出)。
27+
* **丰富的模型库:** 包含多种经典和前沿的推荐算法(召回、排序、多任务、**生成式推荐模型 HSTU/HLLM 等**)。
2628
* **标准化流程:** 提供统一的数据加载、训练和评估流程。
2729
* **易于配置:** 通过配置文件或命令行参数轻松调整实验设置。
2830
* **可复现性:** 旨在确保实验结果的可复现性。
@@ -126,13 +128,13 @@ torch-rechub/ # 根目录
126128
│ └── mtl.py # 多任务工具
127129
├── examples/ # 示例脚本
128130
│ ├── matching/ # 召回任务示例
129-
│ └── ranking/ # 排序任务示例
130-
├── docs/ # 文档
131+
│ ├── ranking/ # 排序任务示例
132+
│ └── generative/ # 生成式推荐示例(HSTU、HLLM 等)
133+
├── docs/ # 文档(VitePress,多语言)
131134
├── tutorials/ # Jupyter教程
132135
├── tests/ # 单元测试
133136
├── config/ # 配置文件
134-
├── scripts/ # 工具脚本
135-
└── mkdocs.yml # MkDocs配置文件
137+
└── scripts/ # 工具脚本
136138
```
137139

138140
## 💡 支持的模型
@@ -165,11 +167,17 @@ torch-rechub/ # 根目录
165167
**多任务推荐 (Multi-Task Recommendation):**
166168

167169
* **[ESMM](https://arxiv.org/pdf/1804.07931.pdf):** Entire Space Multi-Task Model
168-
* **[MMoE](https://dl.acm.org/doi/pdf/10.1145/3219819.3220007):** Multi-Task Multi-Interest Network for Recommendation
170+
* **[MMoE](https://dl.acm.org/doi/pdf/10.1145/3219819.3220007):** Multi-gate Mixture-of-Experts for Multi-Task Learning
169171
* **[PLE](https://dl.acm.org/doi/pdf/10.1145/3394486.3403394):** Personalized Learning to Rank
170172
* **[AITM](https://arxiv.org/pdf/2005.02553.pdf):** Adaptive Interest-Task Matching
171173
* ...
172174

175+
**生成式推荐 (Generative Recommendation):**
176+
177+
* **[HSTU](https://arxiv.org/abs/2402.17152v3):** 基于层次化序列转导单元的生成式序列推荐模型。
178+
* **[HLLM](https://arxiv.org/abs/2508.18118v1):** 基于大语言模型表征的层次化生成式推荐模型。
179+
* ...
180+
173181
## 📊 支持的数据集
174182

175183
框架内置了对以下常见数据集格式的支持或提供了处理脚本:
@@ -300,4 +308,4 @@ match_trainer.fit(train_dl)
300308

301309
---
302310

303-
*最后更新: [2025-06-30]*
311+
*最后更新: [2025-11-27]*
-524 KB
Loading

0 commit comments

Comments
 (0)