推荐系统离线任务文档中心

本目录包含推荐系统所有重要文档。

📚 文档目录

快速开始

• 从这里开始.md - 新手入门指南，了解项目结构和基本概念
• 快速开始.md - 快速运行离线任务的步骤
• Swing快速开始.md - C++ Swing算法快速使用指南

使用指南

• Swing算法使用指南.md - 详细的Swing算法使用文档
• 运行脚本指南.md - 所有离线任务脚本的使用说明
• 调试指南.md - Debug模式和日志使用说明

数据规范

• 离线索引数据规范.md - 所有离线索引的格式和说明
• Redis数据规范.md - Redis中数据的key格式和结构
• 完整索引列表.md - 系统中所有索引的完整清单

配置说明

• 数据库配置说明.md - 数据库连接和表结构说明
• 配置文件: ../config/offline_config.py - 所有可配置参数

实现总结

• Swing实现总结.md - C++ Swing集成实现的完整说明

维护文档

• 故障排查指南.md - 常见问题和解决方案
• 更新日志.md - 系统更新历史

📂 相关文档

其他模块文档

• Collaboration模块: ../collaboration/README.md - C++ 协同过滤算法
• GraphEmbedding模块:
  • Session W2V: ../graphembedding/session_w2v/README.md
  • DeepWalk: ../graphembedding/deepwalk/README.md
• Hot模块: ../hot/README.md - 热门商品推荐

项目README

• 项目根目录: ../../README.md - 项目总览
• 离线任务: ../README.md - 离线任务模块说明

🎯 文档使用建议

新用户

1. 先阅读 从这里开始.md 了解整体架构
2. 然后看 快速开始.md 快速运行系统
3. 需要时查阅具体的使用指南和数据规范

开发人员

1. 查看 运行脚本指南.md 了解所有脚本
2. 参考 调试指南.md 进行调试
3. 遵循 数据规范 文档进行开发

运维人员

1. 配置前先看 数据库配置说明.md
2. 遇到问题查看 故障排查指南.md
3. 了解 Redis数据规范.md 便于维护

📝 文档更新

所有文档由项目维护者更新。如有疑问或发现错误，请联系团队。

最后更新: 2024-10-17