🤗用户指南 • 🧪模型 • 📜数据集 • 📑SSLRec论文

SSLRec 是一个基于 PyTorch 的开源深度学习框架，专为推荐系统设计，并结合了自监督学习技术。它易于使用，内置常用数据集、数据处理、训练、测试和评估的代码脚本，以及最先进的研究模型。SSLRec 提供了丰富的实用工具函数和简洁易用的接口，大大简化了推荐模型的开发与评估流程。

我们的框架涵盖了多种自监督学习推荐算法，主要分为五大类：

• 通用协同过滤
• 序列推荐
• 多行为推荐
• 社交推荐
• 知识图谱增强型推荐

每个类别都提供统一的训练、验证和测试流程，并采用标准化的数据预处理方法，利用公开可用的数据集进行操作。这使得复现各种模型变得简单，同时也便于不同方法之间的公平比较。

SSLRec 新闻

• 🤗 这里有一个关于如何为 通用协同过滤 创建您自己的数据的快速教程，请 点击这里。

• 📣 我们撰写了一篇关于推荐系统中自监督学习的 综述论文。详情请 查看这里！

• 🎉🎉 SSLRec 论文 已被 WSDM 2024 接受，并将在会议上以 口头报告 形式发表！

• 🔥 训练策略中现已支持早停功能。（更多详情请参阅 此处）

亮点特性

• 🧩 灵活的模块化架构。 SSLRec 框架采用模块化设计，用户可以轻松定制和组合各个模块，从而构建符合自身需求的个性化推荐模型。

• 🌟 覆盖多种推荐场景。 SSLRec 框架是一款多功能工具，适用于对构建高效推荐模型感兴趣的科研人员和从业者，能够应对多样化的推荐系统研究方向。

• 💡 全面的最先进模型。 我们的 SSLRec 框架提供了广泛适用于各类场景的自监督增强型推荐模型。研究人员可以使用先进的评估技术对这些模型进行测试，并将其作为推动推荐系统领域创新的基础。

• 📊 统一的数据加载器和标准评估协议。 SSLRec 框架配备统一的数据加载器和标准评估协议，能够方便地从不同来源和格式加载并预处理数据，同时确保对推荐模型进行客观公正的评估。

• 🛠️ 丰富的实用工具函数。 SSLRec 框架提供了大量实用工具函数，简化了推荐模型的开发和评估过程。这些函数涵盖了推荐系统中的常见功能，以及用于图操作、网络架构和损失函数的自监督学习相关工具。

• 🤖 易用的界面。 我们提供了一个用户友好的界面，简化了推荐模型的训练和评估流程。这使得研究人员和从业者能够轻松高效地尝试不同的模型和配置。

已实现的模型

我们致力于不断向 SSLRec 框架中添加新的自监督学习模型，以紧跟推荐系统领域的最新发展。敬请期待后续更新！🔍

以下列出已实现模型的缩写形式。更多详细信息请参阅 模型。

通用协同过滤

• LightGCN (SIGIR'20), SGL (SIGIR'21), HCCF (SIGIR'22), SimGCL (SIGIR'22), NCL (WWW'22), DirectAU (KDD'22), LightGCL (ICLR'23), AutoCF (WWW'23), DCCF (SIGIR'23), GFormer (SIGIR'23), AdaGCL (KDD'23)

序列推荐

• BERT4Rec (CIKM'19), CL4SRec (ICDE'22), DuoRec (WSDM'22), ICLRec (WWW'22), DCRec (WWW'23), MAERec (SIGIR'23)

社交推荐

• MHCN (WWW'21), KCGN (AAAI'21), SMIN (CIKM'21), DSL (IJCAI'23)

知识图谱增强型推荐

• KGIN (WWW'21), KGCL (SIGIR'22), KGRec (KDD'23), DiffKG (WSDM'24)

多行为推荐

• MBGMN (SIGIR'21), HMG-CR (ICDM'21), S-MBRec (IJCAI'22), CML (WSDM'2022), KMCLR (WSDM'23)

开始使用

SSLRec 在以下开发环境中实现：

• python==3.10.4
• numpy==1.22.3
• torch==1.11.0
• scipy==1.7.3
• dgl==1.1.1

您可以通过运行以下脚本，轻松使用我们的框架训练 LightGCN：

python main.py --model LightGCN

该脚本将在 gowalla 数据集上运行 LightGCN 模型。

LightGCN 的训练配置保存在 lightgcn.yml 中。您可以修改此文件中的参数以获得不同的训练效果。此外，如果您对尝试其他已实现的模型感兴趣，可以在 Models 中找到模型列表，并轻松将 LightGCN 替换为您选择的模型。

对于希望深入了解的用户，我们建议阅读我们的 用户指南。该指南全面介绍了 SSLRec 的概念和使用方法，包括：

• SSLRec 框架的架构设计
• 在 SSLRec 中实现您自己的模型
• 在 SSLRec 中部署您自己的数据集
• 在 SSLRec 中实现您自己的训练流程
• SSLRec 中的自动超参数调优 等。

共同改进 SSLRec

如果您遇到任何错误或有改进建议，请随时 提交拉取请求 或 创建问题。

🤗 我们热烈欢迎各种形式的贡献，从修复 bug 到新增功能和扩展。

非常感谢所有贡献者！

引用

SSLRec：用于推荐的自监督学习框架
任旭斌、夏良浩、杨宇豪、魏伟、王天乐、蔡旭恒和黄超*
WSDM 2024

如果您认为这项工作对您的研究有所帮助，请考虑引用我们的论文：

@inproceedings{ren2024sslrec,
  title={SSLRec: A Self-Supervised Learning Framework for Recommendation},
  author={Ren, Xubin and Xia, Lianghao and Yang, Yuhao and Wei, Wei and Wang, Tianle and Cai, Xuheng and Huang, Chao},
  booktitle={Proceedings of the 17th ACM International Conference on Web Search and Data Mining},
  pages={567--575},
  year={2024}
}

SSLRec 快速上手指南

SSLRec 是一个基于 PyTorch 的开源深度学习框架，专为结合自监督学习（Self-Supervised Learning, SSL）技术的推荐系统设计。它提供了丰富的数据集、标准化的数据处理流程以及多种前沿的推荐模型实现。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux / macOS / Windows
• Python: 3.10.4 (推荐)
• 核心依赖:
  • numpy == 1.22.3
  • torch == 1.11.0
  • scipy == 1.7.3
  • dgl == 1.1.1 (Deep Graph Library)

提示：国内用户建议使用清华源或阿里源加速依赖安装。

安装步骤

1. 克隆项目代码

   git clone https://github.com/HKUDS/SSLRec.git
   cd SSLRec
   

2. 创建虚拟环境并安装依赖 推荐使用 conda 或 venv 创建独立环境。

   # 创建并激活环境 (以 conda 为例)
   conda create -n sslrec python=3.10.4
   conda activate sslrec
   
   # 安装 PyTorch (根据 CUDA 版本选择，此处以 CPU 或通用版本为例，生产环境请指定 CUDA)
   # 国内加速示例 (清华源):
   pip install torch==1.11.0 -i https://pypi.tuna.tsinghua.edu.cn/simple
   
   # 安装其他核心依赖
   pip install numpy==1.22.3 scipy==1.7.3 -i https://pypi.tuna.tsinghua.edu.cn/simple
   
   # 安装 DGL (Deep Graph Library)
   # 注意：DGL 安装可能需要匹配特定的 PyTorch 和 CUDA 版本，请参考 DGL 官网或尝试以下命令
   pip install dgl==1.1.1 -i https://pypi.tuna.tsinghua.edu.cn/simple
   

基本使用

SSLRec 提供了统一的命令行接口来运行模型。以下以运行经典的 LightGCN 模型在 Gowalla 数据集上为例：

1. 运行模型 在项目根目录下执行以下命令：

   python main.py --model LightGCN
   

   该命令将自动加载默认配置，使用 Gowalla 数据集进行训练、验证和测试。

2. 修改配置 模型的超参数配置存储在 config/modelconf/ 目录下。例如，LightGCN 的配置文件为 lightgcn.yml。您可以直接编辑该文件以调整学习率、嵌入维度、训练轮数等参数：

   # config/modelconf/lightgcn.yml 示例片段
   learning_rate: 0.001
   embed_dim: 64
   n_layers: 3
   

3. 切换其他模型 若要尝试框架中支持的其他模型（如 SGL, SimGCL, BERT4Rec 等），只需更改 --model 参数即可：

   python main.py --model SGL
   python main.py --model BERT4Rec
   

更多详细用法，包括自定义数据集、开发新模型及自动化调参，请参阅官方 用户指南。