torch-rechub 0.0.6__tar.gz → 0.2.0__tar.gz

{torch_rechub-0.0.6 → torch_rechub-0.2.0}/.github/workflows/ci.yml

@@ -56,7 +56,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Cache pip packages
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-lint-${{ hashFiles('pyproject.toml') }}
@@ -104,6 +104,9 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
 
+    env:
+      SKIP_MILVUS_TESTS: ${{ matrix.os != 'ubuntu-latest' && '1' || '0' }}
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
@@ -114,7 +117,7 @@ jobs:
           python-version: '3.9'
 
       - name: Cache pip packages
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: |
             ~/.cache/pip
@@ -136,12 +139,36 @@ jobs:
           # Install CPU-only PyTorch for faster CI
           pip install torch --index-url ${{ env.TORCH_INDEX_URL }}
           # Install the package with dev and onnx dependencies
-          pip install -e ".[dev,onnx]" || pip install -r requirements-dev.txt && pip install -e .
+          pip install -e ".[dev,annoy,faiss,milvus,onnx]" || pip install -r requirements-dev.txt && pip install -e .
+
+      - name: Start Milvus
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          # Download the installation script
+          curl -sfL https://raw.githubusercontent.com/milvus-io/milvus/master/scripts/standalone_embed.sh -o standalone_embed.sh
+
+          # Start the Docker container
+          bash standalone_embed.sh start
+
+      - name: Wait for Milvus
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          for i in {1..60}; do
+            if curl -fsS http://localhost:9091/healthz >/dev/null; then exit 0; fi
+            sleep 2
+          done
+          exit 1
 
       - name: Run tests
+        if: matrix.os != 'macos-latest'
         run: |
           pytest -c config/pytest.ini tests/ -v
 
+      - name: Run tests (skip indexing tests)
+        if: matrix.os == 'macos-latest'
+        run: |
+          pytest -c config/pytest.ini tests/ -v --ignore=tests/test_serving.py
+
       - name: Run tests with coverage (Ubuntu only)
         if: matrix.os == 'ubuntu-latest'
         run: |
@@ -155,6 +182,16 @@ jobs:
           flags: unittests
           name: codecov-umbrella
 
+      - name: Shutdown Milvus
+        if: always() && matrix.os == 'ubuntu-latest'
+        run: |
+          # Stop Milvus
+          bash standalone_embed.sh stop
+
+          # Delete Milvus data
+          bash standalone_embed.sh delete
+
+
   # ===================================================================
   # 依赖兼容性验证 (Python 3.10+) - 仅验证依赖安装成功
   # (仅在 push/PR 时运行，release 时跳过)
@@ -221,7 +258,7 @@ jobs:
           bandit -r torch_rechub/ -s B101,B311,B614 -x tests,docs,examples -f txt
 
       - name: Upload security scan results
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         if: always()
         with:
           name: bandit-security-report
@@ -259,7 +296,7 @@ jobs:
           twine check dist/*
 
       - name: Upload build artifacts
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: dist-packages
           path: dist/

{torch_rechub-0.0.6 → torch_rechub-0.2.0}/CHANGELOG.md

@@ -7,6 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [0.2.0] - 2026-01-11
+
+<!-- Release notes generated using configuration in .github/release.yml at main -->
+
+## What's Changed
+### 🐛 Bug 修复 / Bug Fixes
+* Update HSTULayer with L2 norm and SiLU attention by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/157
+* Add ONNX quantization scripts and tests, improve dataloader split  by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/161
+### 📝 文档更新 / Documentation
+* Update docs and README with new architecture image by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/154
+* Add comprehensive vector index docs (EN & ZH) by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/162
+* Update quick start and tracking docs in EN and ZH by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/163
+
+
+**Full Changelog**: https://github.com/datawhalechina/torch-rechub/compare/v0.1.0...v0.2.0
+
+---
+
+
+
+## [0.1.0] - 2025-12-17
+
+<!-- Release notes generated using configuration in .github/release.yml at main -->
+
+## What's Changed
+### ✨ 新特性 / Features
+* Update docs and tutorials && Add ONNX quantization utilities and enhance export  by @1985312383 in https://github.com/datawhalechina/torch-rechub/pull/150
+* REFACTOR+FEATURE: Standardize retrieval backends (ANNOY/FAISS/Milvus) by @ywuenthought in https://github.com/datawhalechina/torch-rechub/pull/151
+
+
+**Full Changelog**: https://github.com/datawhalechina/torch-rechub/compare/v0.0.6...v0.1.0
+
+---
+
+
+
 ## [0.0.6] - 2025-12-11
 
 <!-- Release notes generated using configuration in .github/release.yml at main -->

{torch_rechub-0.0.6 → torch_rechub-0.2.0}/CONTRIBUTING.md

@@ -150,18 +150,25 @@ def test_deepfm_forward():
 ```python
 def train_model(model, data_loader, optimizer):
     """Train a recommendation model.
-    
-    Args:
-        model (torch.nn.Module): The model to train
-        data_loader (DataLoader): Training data loader
-        optimizer (torch.optim.Optimizer): Optimizer for training
-        
-    Returns:
-        float: Training loss
-        
-    Example:
-        >>> model = DeepFM(features, mlp_params)
-        >>> loss = train_model(model, train_loader, optimizer)
+
+    Parameters
+    ----------
+    model : torch.nn.Module
+        Model to train.
+    data_loader : DataLoader
+        Training data loader.
+    optimizer : torch.optim.Optimizer
+        Optimizer for training.
+
+    Returns
+    -------
+    float
+        Training loss.
+
+    Examples
+    --------
+    >>> model = DeepFM(features, mlp_params)
+    >>> loss = train_model(model, train_loader, optimizer)
     """
     # Implementation here
 ```

{torch_rechub-0.0.6 → torch_rechub-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: torch-rechub
-Version: 0.0.6
+Version: 0.2.0
 Summary: A Pytorch Toolbox for Recommendation Models, Easy-to-use and Easy-to-extend.
 Project-URL: Homepage, https://github.com/datawhalechina/torch-rechub
 Project-URL: Documentation, https://www.torch-rechub.com
@@ -28,8 +28,10 @@ Requires-Dist: scikit-learn>=0.24.0
 Requires-Dist: torch>=1.10.0
 Requires-Dist: tqdm>=4.60.0
 Requires-Dist: transformers>=4.46.3
+Provides-Extra: annoy
+Requires-Dist: annoy>=1.17.2; extra == 'annoy'
 Provides-Extra: bigdata
-Requires-Dist: pyarrow~=21.0; extra == 'bigdata'
+Requires-Dist: pyarrow<23,>=21; extra == 'bigdata'
 Provides-Extra: dev
 Requires-Dist: bandit>=1.7.0; extra == 'dev'
 Requires-Dist: flake8>=3.8.0; extra == 'dev'
@@ -41,8 +43,13 @@ Requires-Dist: pytest-cov>=2.0; extra == 'dev'
 Requires-Dist: pytest>=6.0; extra == 'dev'
 Requires-Dist: toml>=0.10.2; extra == 'dev'
 Requires-Dist: yapf==0.43.0; extra == 'dev'
+Provides-Extra: faiss
+Requires-Dist: faiss-cpu==1.13.0; extra == 'faiss'
+Provides-Extra: milvus
+Requires-Dist: pymilvus>=2.6.5; extra == 'milvus'
 Provides-Extra: onnx
 Requires-Dist: onnx>=1.14.0; extra == 'onnx'
+Requires-Dist: onnxconverter-common>=1.14.0; extra == 'onnx'
 Requires-Dist: onnxruntime>=1.14.0; extra == 'onnx'
 Provides-Extra: tracking
 Requires-Dist: swanlab>=0.1.0; extra == 'tracking'
@@ -53,9 +60,11 @@ Requires-Dist: graphviz>=0.20; extra == 'visualization'
 Requires-Dist: torchview>=0.2.6; extra == 'visualization'
 Description-Content-Type: text/markdown
 
-# 🔥 Torch-RecHub - 轻量、高效、易用的 PyTorch 推荐系统框架
+<div align="center">
 
-> 🚀 **30+ 主流推荐模型** | 🎯 **开箱即用** | 📦 **一键部署 ONNX** | 🤖 **支持生成式推荐 (HSTU/HLLM)**
+![Torch-RecHub 横幅](docs/public/img/banner.png)
+
+# Torch-RecHub: 轻量、高效、易用的 PyTorch 推荐系统框架
 
 [![许可证](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE)
 ![GitHub Repo stars](https://img.shields.io/github/stars/datawhalechina/torch-rechub?style=for-the-badge)
@@ -71,21 +80,13 @@ Description-Content-Type: text/markdown
 
 [English](README_en.md) | 简体中文
 
-**在线文档：** https://datawhalechina.github.io/torch-rechub/ （英文）| https://datawhalechina.github.io/torch-rechub/zh/ （简体中文）
+![架构图](docs/public/img/project_framework.png)
 
-**Torch-RecHub** —— **10 行代码实现工业级推荐系统**。30+ 主流模型开箱即用，支持一键 ONNX 部署，让你专注于业务而非工程。
+</div>
 
-![Torch-RecHub 横幅](docs/public/img/banner.png)
+**在线文档：** https://datawhalechina.github.io/torch-rechub/zh/
 
-## 🎯 为什么选择 Torch-RecHub？
-
-| 特性          | Torch-RecHub                | 其他框架   |
-| ------------- | --------------------------- | ---------- |
-| 代码行数      | **10行** 完成训练+评估+部署 | 100+ 行    |
-| 模型覆盖      | **30+** 主流模型            | 有限       |
-| 生成式推荐    | ✅ HSTU/HLLM (Meta 2024)     | ❌          |
-| ONNX 一键导出 | ✅ 内置支持                  | 需手动适配 |
-| 学习曲线      | 极低                        | 陡峭       |
+**Torch-RecHub** —— **10 行代码实现工业级推荐系统**。30+ 主流模型开箱即用，支持一键 ONNX 部署，让你专注于业务而非工程。
 
 ## ✨ 特性
 
@@ -102,7 +103,6 @@ Description-Content-Type: text/markdown
 ## 📖 目录
 
 - [🔥 Torch-RecHub - 轻量、高效、易用的 PyTorch 推荐系统框架](#-torch-rechub---轻量高效易用的-pytorch-推荐系统框架)
-  - [🎯 为什么选择 Torch-RecHub？](#-为什么选择-torch-rechub)
   - [✨ 特性](#-特性)
   - [📖 目录](#-目录)
   - [🔧 安装](#-安装)
@@ -214,6 +214,8 @@ torch-rechub/             # 根目录
 
 本框架目前支持 **30+** 主流推荐模型：
 
+<details>
+
 ### 排序模型 (Ranking Models) - 13个
 
 | 模型          | 论文                                             | 简介                    |
@@ -229,7 +231,11 @@ torch-rechub/             # 根目录
 | **AutoInt**   | [CIKM 2019](https://arxiv.org/abs/1810.11921)    | 自动特征交互学习        |
 | **FiBiNET**   | [RecSys 2019](https://arxiv.org/abs/1905.09433)  | 特征重要性 + 双线性交互 |
 | **DeepFFM**   | [RecSys 2019](https://arxiv.org/abs/1611.00144)  | 场感知因子分解机        |
-| **EDCN**      | [KDD 2021](https://arxiv.org/abs/2106.03032)     | 增强型交叉网络          |
+| **EDCN**      | [KDD 2021](https://arxiv.org/abs/2106.03032)     | 增强型交叉网络  
+        |
+</details>
+
+<details>
 
 ### 召回模型 (Matching Models) - 12个
 
@@ -246,6 +252,10 @@ torch-rechub/             # 根目录
 | **STAMP**      | [KDD 2018](https://dl.acm.org/doi/10.1145/3219819.3219895)                     | 短期注意力记忆优先 |
 | **ComiRec**    | [KDD 2020](https://arxiv.org/abs/2005.09347)                                   | 可控多兴趣推荐     |
 
+</details>
+
+<details>
+
 ### 多任务模型 (Multi-Task Models) - 5个
 
 | 模型             | 论文                                                          | 简介               |
@@ -256,6 +266,10 @@ torch-rechub/             # 根目录
 | **AITM**         | [KDD 2021](https://arxiv.org/abs/2105.08489)                  | 自适应信息迁移     |
 | **SharedBottom** | -                                                             | 经典多任务共享底层 |
 
+</details>
+
+<details>
+
 ### 生成式推荐 (Generative Recommendation) - 2个
 
 | 模型     | 论文                                          | 简介                                         |
@@ -263,6 +277,8 @@ torch-rechub/             # 根目录
 | **HSTU** | [Meta 2024](https://arxiv.org/abs/2402.17152) | 层级序列转换单元，支撑 Meta 万亿参数推荐系统 |
 | **HLLM** | [2024](https://arxiv.org/abs/2409.12740)      | 层级大语言模型推荐，融合 LLM 语义理解能力    |
 
+</details>
+
 ## 📊 支持的数据集
 
 框架内置了对以下常见数据集格式的支持或提供了处理脚本：

{torch_rechub-0.0.6 → torch_rechub-0.2.0}/README.md

@@ -1,6 +1,8 @@
-# 🔥 Torch-RecHub - 轻量、高效、易用的 PyTorch 推荐系统框架
+<div align="center">
 
-> 🚀 **30+ 主流推荐模型** | 🎯 **开箱即用** | 📦 **一键部署 ONNX** | 🤖 **支持生成式推荐 (HSTU/HLLM)**
+![Torch-RecHub 横幅](docs/public/img/banner.png)
+
+# Torch-RecHub: 轻量、高效、易用的 PyTorch 推荐系统框架
 
 [![许可证](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE)
 ![GitHub Repo stars](https://img.shields.io/github/stars/datawhalechina/torch-rechub?style=for-the-badge)
@@ -16,21 +18,13 @@
 
 [English](README_en.md) | 简体中文
 
-**在线文档：** https://datawhalechina.github.io/torch-rechub/ （英文）| https://datawhalechina.github.io/torch-rechub/zh/ （简体中文）
+![架构图](docs/public/img/project_framework.png)
 
-**Torch-RecHub** —— **10 行代码实现工业级推荐系统**。30+ 主流模型开箱即用，支持一键 ONNX 部署，让你专注于业务而非工程。
+</div>
 
-![Torch-RecHub 横幅](docs/public/img/banner.png)
+**在线文档：** https://datawhalechina.github.io/torch-rechub/zh/
 
-## 🎯 为什么选择 Torch-RecHub？
-
-| 特性          | Torch-RecHub                | 其他框架   |
-| ------------- | --------------------------- | ---------- |
-| 代码行数      | **10行** 完成训练+评估+部署 | 100+ 行    |
-| 模型覆盖      | **30+** 主流模型            | 有限       |
-| 生成式推荐    | ✅ HSTU/HLLM (Meta 2024)     | ❌          |
-| ONNX 一键导出 | ✅ 内置支持                  | 需手动适配 |
-| 学习曲线      | 极低                        | 陡峭       |
+**Torch-RecHub** —— **10 行代码实现工业级推荐系统**。30+ 主流模型开箱即用，支持一键 ONNX 部署，让你专注于业务而非工程。
 
 ## ✨ 特性
 
@@ -47,7 +41,6 @@
 ## 📖 目录
 
 - [🔥 Torch-RecHub - 轻量、高效、易用的 PyTorch 推荐系统框架](#-torch-rechub---轻量高效易用的-pytorch-推荐系统框架)
-  - [🎯 为什么选择 Torch-RecHub？](#-为什么选择-torch-rechub)
   - [✨ 特性](#-特性)
   - [📖 目录](#-目录)
   - [🔧 安装](#-安装)
@@ -159,6 +152,8 @@ torch-rechub/             # 根目录
 
 本框架目前支持 **30+** 主流推荐模型：
 
+<details>
+
 ### 排序模型 (Ranking Models) - 13个
 
 | 模型          | 论文                                             | 简介                    |
@@ -174,7 +169,11 @@ torch-rechub/             # 根目录
 | **AutoInt**   | [CIKM 2019](https://arxiv.org/abs/1810.11921)    | 自动特征交互学习        |
 | **FiBiNET**   | [RecSys 2019](https://arxiv.org/abs/1905.09433)  | 特征重要性 + 双线性交互 |
 | **DeepFFM**   | [RecSys 2019](https://arxiv.org/abs/1611.00144)  | 场感知因子分解机        |
-| **EDCN**      | [KDD 2021](https://arxiv.org/abs/2106.03032)     | 增强型交叉网络          |
+| **EDCN**      | [KDD 2021](https://arxiv.org/abs/2106.03032)     | 增强型交叉网络  
+        |
+</details>
+
+<details>
 
 ### 召回模型 (Matching Models) - 12个
 
@@ -191,6 +190,10 @@ torch-rechub/             # 根目录
 | **STAMP**      | [KDD 2018](https://dl.acm.org/doi/10.1145/3219819.3219895)                     | 短期注意力记忆优先 |
 | **ComiRec**    | [KDD 2020](https://arxiv.org/abs/2005.09347)                                   | 可控多兴趣推荐     |
 
+</details>
+
+<details>
+
 ### 多任务模型 (Multi-Task Models) - 5个
 
 | 模型             | 论文                                                          | 简介               |
@@ -201,6 +204,10 @@ torch-rechub/             # 根目录
 | **AITM**         | [KDD 2021](https://arxiv.org/abs/2105.08489)                  | 自适应信息迁移     |
 | **SharedBottom** | -                                                             | 经典多任务共享底层 |
 
+</details>
+
+<details>
+
 ### 生成式推荐 (Generative Recommendation) - 2个
 
 | 模型     | 论文                                          | 简介                                         |
@@ -208,6 +215,8 @@ torch-rechub/             # 根目录
 | **HSTU** | [Meta 2024](https://arxiv.org/abs/2402.17152) | 层级序列转换单元，支撑 Meta 万亿参数推荐系统 |
 | **HLLM** | [2024](https://arxiv.org/abs/2409.12740)      | 层级大语言模型推荐，融合 LLM 语义理解能力    |
 
+</details>
+
 ## 📊 支持的数据集
 
 框架内置了对以下常见数据集格式的支持或提供了处理脚本：