torch-rechub 0.0.3__tar.gz → 0.0.5__tar.gz

torch_rechub-0.0.5/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug Report / Bug反馈
+about: Report a bug to help us improve / 报告Bug帮助我们改进
+title: '[BUG] '
+labels: 'bug'
+assignees: ''
+---
+
+## Bug Description / Bug描述
+
+Describe the bug you encountered / 描述您遇到的Bug
+
+## Environment / 环境信息
+
+- OS / 操作系统: [e.g. Ubuntu 20.04, Windows 10]
+- Python: [e.g. 3.9]
+- PyTorch: [e.g. 1.12.0]
+- torch-rechub: [e.g. 0.0.4]
+
+## To Reproduce / 复现步骤
+
+```python
+# Minimal code to reproduce the issue / 最小复现代码
+```
+
+## Expected vs Actual / 期望 vs 实际
+
+- **Expected / 期望**: 
+- **Actual / 实际**: 
+
+## Error Message / 错误信息
+
+```
+# Paste error message here / 粘贴错误信息
+```
+
+## Additional Context / 额外信息
+
+Any other context about the problem / 其他相关信息 

torch_rechub-0.0.5/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: false
+
+contact_links:
+  - name: Q&A / 使用咨询
+    url: https://github.com/datawhalechina/torch-rechub/discussions
+    about: 请在 Discussions 中提出一般性问题、使用咨询或非 Bug 报告
+

torch_rechub-0.0.5/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,40 @@
+---
+name: Feature Request / 功能请求
+about: Suggest a new model, dataset, or feature / 建议新模型、数据集或功能
+title: '[FEATURE] '
+labels: 'enhancement'
+assignees: ''
+---
+
+## Feature Type / 功能类型
+
+What kind of feature are you requesting? / 您请求什么类型的功能？
+
+- [ ] New model implementation / 新模型实现
+- [ ] New dataset support / 新数据集支持
+- [ ] API improvement / API改进
+- [ ] Documentation / 文档改进
+- [ ] Other / 其他
+
+## Description / 描述
+
+Describe what you would like to see added / 描述您希望添加的功能
+
+## Motivation / 动机
+
+Why is this feature useful for the recommender system community? / 为什么这个功能对推荐系统社区有用？
+
+## Example Usage / 使用示例
+
+```python
+# How would you like to use this feature? / 您希望如何使用这个功能？
+```
+
+## References / 参考资料
+
+- Paper/Blog: [Link if applicable / 相关论文或博客链接]
+- Similar implementations: [Other libraries / 其他库的类似实现]
+
+## Additional Context / 额外信息
+
+Any other context or examples / 其他上下文或示例 

torch_rechub-0.0.5/.github/ISSUE_TEMPLATE/help_wanted.md

@@ -0,0 +1,118 @@
+---
+name: Help Wanted / 寻求帮助
+about: Community contribution opportunities for torch-rechub development / torch-rechub开发的社区贡献机会
+title: '[HELP WANTED] '
+labels: 'help wanted, good first issue'
+assignees: ''
+---
+
+## 任务类型 / Task Type
+
+请选择任务类型 / Please select the task type:
+
+- [ ] 新模型实现 / New model implementation
+- [ ] 数据集支持 / Dataset support
+- [ ] 文档编写 / Documentation
+- [ ] 教程制作 / Tutorial creation
+- [ ] 代码优化 / Code optimization
+- [ ] 测试用例 / Test cases
+- [ ] Bug修复 / Bug fixes
+- [ ] 其他 / Other
+
+## 任务描述 / Task Description
+
+### 背景 / Background
+<!-- 描述任务的背景和重要性 / Describe the background and importance of the task -->
+
+### 目标 / Objectives
+<!-- 明确说明需要完成的具体目标 / Clearly state the specific objectives to be completed -->
+
+### 详细要求 / Detailed Requirements
+<!-- 列出具体的技术要求和实现细节 / List specific technical requirements and implementation details -->
+
+## 技能要求 / Required Skills
+
+### 必需技能 / Required Skills
+- [ ] Python编程 / Python programming
+- [ ] PyTorch框架 / PyTorch framework
+- [ ] 推荐系统基础 / Recommender systems basics
+- [ ] 其他: / Other: 
+
+### 加分技能 / Preferred Skills
+- [ ] 深度学习 / Deep learning
+- [ ] 机器学习 / Machine learning
+- [ ] 数据处理 / Data processing
+- [ ] 文档写作 / Technical writing
+- [ ] 其他: / Other: 
+
+## 预期产出 / Expected Deliverables
+
+- [ ] 代码实现 / Code implementation
+- [ ] 单元测试 / Unit tests
+- [ ] 文档更新 / Documentation updates
+- [ ] 使用示例 / Usage examples
+- [ ] 其他: / Other: 
+
+## 参考资料 / References
+
+### 相关论文 / Related Papers
+<!-- 提供相关的学术论文链接 / Provide links to relevant academic papers -->
+
+### 代码参考 / Code References
+<!-- 提供参考的代码实现或类似项目 / Provide reference implementations or similar projects -->
+
+### 文档资源 / Documentation Resources
+<!-- 提供相关的文档和教程链接 / Provide links to relevant documentation and tutorials -->
+
+## 难度评估 / Difficulty Level
+
+- [ ] 🟢 初级 (适合新手) / Beginner (Good for newcomers)
+- [ ] 🟡 中级 (需要一定经验) / Intermediate (Requires some experience)
+- [ ] 🔴 高级 (需要深入理解) / Advanced (Requires deep understanding)
+
+## 预估工作量 / Estimated Effort
+
+- [ ] 📅 1-3天 / 1-3 days
+- [ ] 📅 1周 / 1 week
+- [ ] 📅 2-4周 / 2-4 weeks
+- [ ] 📅 1个月以上 / More than 1 month
+
+## 贡献指南 / Contribution Guidelines
+
+### 开始之前 / Before You Start
+1. 请在评论中表明您的兴趣，避免重复工作 / Please comment to express your interest to avoid duplicate work
+2. 阅读 [CONTRIBUTING.md](../../CONTRIBUTING.md) 了解开发流程 / Read CONTRIBUTING.md to understand the development process
+3. 设置开发环境并熟悉项目结构 / Set up the development environment and familiarize yourself with the project structure
+
+### 开发流程 / Development Process
+1. Fork 项目并创建新分支 / Fork the project and create a new branch
+2. 实现功能并编写测试 / Implement the feature and write tests
+3. 运行代码格式化: `python config/format_code.py` / Run code formatting
+4. 提交 Pull Request / Submit a Pull Request
+
+### 代码规范 / Code Standards
+- 遵循项目的代码风格 / Follow the project's code style
+- 添加适当的注释和文档字符串 / Add appropriate comments and docstrings
+- 确保所有测试通过 / Ensure all tests pass
+- 更新相关文档 / Update relevant documentation
+
+## 联系方式 / Contact Information
+
+### 获取帮助 / Getting Help
+- 💬 在此 Issue 下评论提问 / Comment on this issue with questions
+- 📧 联系项目维护者: [morningsky](https://github.com/morningsky)
+- 🔗 查看更多 Issues: [GitHub Issues](https://github.com/datawhalechina/torch-rechub/issues)
+
+### 社区支持 / Community Support
+- 📖 查看项目文档和示例 / Check project documentation and examples
+- 🤝 与其他贡献者交流 / Communicate with other contributors
+- ⭐ 关注项目更新 / Follow project updates
+
+## 额外信息 / Additional Information
+
+<!-- 添加任何其他相关信息、截图或示例 / Add any other relevant information, screenshots, or examples -->
+
+---
+
+**感谢您对 torch-rechub 项目的贡献兴趣！我们期待与您合作。**
+**Thank you for your interest in contributing to torch-rechub! We look forward to working with you.**

torch_rechub-0.0.5/.github/dependabot.yml

@@ -0,0 +1,29 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "python"
+    commit-message:
+      prefix: "chore(deps)"
+    allow:
+      - dependency-type: "direct"
+      - dependency-type: "indirect"
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 2
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "chore(actions)"

torch_rechub-0.0.5/.github/pull_request_template.md

@@ -0,0 +1,33 @@
+# Pull Request / 拉取请求
+
+## What does this PR do? / 这个PR做了什么？
+
+Briefly describe your changes / 简要描述您的更改
+
+## Type of Change / 变更类型
+
+- [ ] 🐛 Bug fix / Bug修复
+- [ ] ✨ New model/feature / 新模型/功能
+- [ ] 📝 Documentation / 文档
+- [ ] 🔧 Maintenance / 维护
+
+## Related Issues / 相关Issues
+
+Fixes #(issue number) / 修复 #(issue编号)
+
+## How to Test / 如何测试
+
+```python
+# Example of how to test your changes / 如何测试您的更改的示例
+```
+
+## Checklist / 检查清单
+
+- [ ] Code follows project style (ran `python config/format_code.py`) / 代码遵循项目风格（运行了格式化脚本）
+- [ ] Added tests for new functionality / 为新功能添加了测试
+- [ ] Updated documentation if needed / 如需要已更新文档
+- [ ] All tests pass locally / 所有测试在本地通过
+
+## Additional Notes / 附加说明
+
+Any other information for reviewers / 给审查者的其他信息 

torch_rechub-0.0.5/.github/release.yml

@@ -0,0 +1,43 @@
+# GitHub 自动生成 Release Notes 的配置
+# 当你点击 "Generate release notes" 按钮时，会根据此配置生成内容
+# 文档: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+      - duplicate
+      - invalid
+      - wontfix
+    authors:
+      - dependabot
+      - dependabot[bot]
+
+  categories:
+    - title: "✨ 新特性 / Features"
+      labels:
+        - enhancement
+
+    - title: "🐛 Bug 修复 / Bug Fixes"
+      labels:
+        - bug
+
+    - title: "⚡ 性能优化 / Performance"
+      labels:
+        - performance
+
+    - title: "📝 文档更新 / Documentation"
+      labels:
+        - documentation
+
+    - title: "🔧 模型更新 / Models"
+      labels:
+        - model
+
+    - title: "📦 依赖更新 / Dependencies"
+      labels:
+        - dependencies
+
+    - title: "🔄 其他变更 / Other Changes"
+      labels:
+        - "*"

torch_rechub-0.0.5/.github/workflows/ci.yml

@@ -0,0 +1,383 @@
+# ===================================================================
+# CI/CD 流程配置 - 代码质量检查、测试、构建、发布
+# ===================================================================
+# 触发条件：
+# - push/pull_request: 运行完整 CI 检查（lint, test, security, build）
+# - release: 仅运行发布流程（跳过已执行的检查）
+
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches: [ main, develop ]
+    paths:
+      - 'torch_rechub/**'
+      - 'tutorials/**'
+      - 'examples/**'
+      - 'config/**'
+      - 'tests/**'
+      - 'pyproject.toml'
+      - '.github/workflows/ci.yml'
+  pull_request:
+    branches: [ main, develop ]
+    paths:
+      - 'torch_rechub/**'
+      - 'tutorials/**'
+      - 'examples/**'
+      - 'config/**'
+      - 'tests/**'
+      - 'pyproject.toml'
+      - '.github/workflows/ci.yml'
+  release:
+    types: [published]
+
+# 环境变量
+env:
+  PYTHON_VERSION: '3.9'
+  TORCH_INDEX_URL: 'https://download.pytorch.org/whl/cpu'
+
+jobs:
+  # ===================================================================
+  # 代码质量检查 (仅在 push/PR 时运行，release 时跳过)
+  # ===================================================================
+  lint:
+    name: Code Quality Checks
+    runs-on: ubuntu-latest
+    # 跳过 release 事件，因为代码已在合并时检查过
+    if: github.event_name != 'release'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Cache pip packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-lint-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-lint-
+            ${{ runner.os }}-pip-
+
+      - name: Install Dependencies
+        run: |
+          pip install --upgrade pip
+          # 安装特定版本的格式化工具以确保一致性（与 pyproject.toml 保持一致）
+          pip install yapf==0.43.0 isort==5.13.2 flake8>=3.8.0 mypy>=0.800 toml>=0.10.2
+
+      - name: Format & Lint
+        run: |
+          # 步骤1: isort
+          isort --profile black torch_rechub/ examples/ tests/
+          # 步骤2: yapf
+          yapf_style="{based_on_style: google, column_limit: 248, join_multiple_lines: false, split_all_comma_separated_values: true, split_before_logical_operator: true, dedent_closing_brackets: true, align_closing_bracket_with_visual_indent: true, indent_width: 4}"
+          yapf --in-place --recursive --style="$yapf_style" torch_rechub/ examples/ tests/
+          
+          # 步骤3: 检查工作区是否干净，确认所有格式化都已提交
+          git diff --exit-code
+          
+          # 步骤4: 运行flake8进行最终的代码质量检查
+          flake8 --max-line-length=248 --extend-ignore=E203,W503,E501,E722,E402,F821,F523,E711,E741,F401,E265,C901,E301,E305,W293,E261,W291,W292,E111,E117,F841,E302 --max-complexity=30 torch_rechub/ examples/ tests/
+
+      - name: Type checking (MyPy) - Optional
+        continue-on-error: true
+        run: |
+          mypy torch_rechub/ --ignore-missing-imports
+
+  # ===================================================================
+  # 完整测试 (Python 3.9) - 运行所有测试和覆盖率报告
+  # (仅在 push/PR 时运行，release 时跳过)
+  # ===================================================================
+  test:
+    name: Full Test Suite (Python 3.9)
+    runs-on: ${{ matrix.os }}
+    needs: lint
+    if: github.event_name != 'release'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.9'
+
+      - name: Cache pip packages
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.cache/torch
+          key: ${{ runner.os }}-py3.9-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-py3.9-
+            ${{ runner.os }}-
+
+      - name: Install system dependencies (Ubuntu)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # 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 .
+
+      - name: Run tests
+        run: |
+          pytest -c config/pytest.ini tests/ -v
+
+      - name: Run tests with coverage (Ubuntu only)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          pytest -c config/pytest.ini tests/ -v --cov=torch_rechub --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v5
+        with:
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+
+  # ===================================================================
+  # 依赖兼容性验证 (Python 3.10+) - 仅验证依赖安装成功
+  # (仅在 push/PR 时运行，release 时跳过)
+  # ===================================================================
+  compatibility:
+    name: Dependency Check (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    needs: lint
+    if: github.event_name != 'release'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # Install CPU-only PyTorch for faster CI
+          pip install torch --index-url ${{ env.TORCH_INDEX_URL }}
+          # Verify package installation with all optional dependencies
+          pip install -e ".[dev,onnx]"
+
+      - name: Verify imports
+        run: |
+          python -c "import torch_rechub; print(f'torch-rechub {torch_rechub.__version__ if hasattr(torch_rechub, \"__version__\") else \"installed\"} on Python ${{ matrix.python-version }}')"
+          python -c "import onnx; import onnxruntime; print('ONNX dependencies OK')"
+
+  # ===================================================================
+  # 安全检查 (仅在 push/PR 时运行，release 时跳过)
+  # ===================================================================
+  security:
+    name: Security Scan
+    runs-on: ubuntu-latest
+    needs: lint
+    if: github.event_name != 'release'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install bandit
+        run: |
+          python -m pip install --upgrade pip
+          pip install bandit
+
+      - name: Run security scan
+        run: |
+          bandit -r torch_rechub/ -s B101,B311,B614 -x tests,docs,examples -f json -o bandit-report.json || true
+          bandit -r torch_rechub/ -s B101,B311,B614 -x tests,docs,examples -f txt
+
+      - name: Upload security scan results
+        uses: actions/upload-artifact@v5
+        if: always()
+        with:
+          name: bandit-security-report
+          path: bandit-report.json
+
+  # ===================================================================
+  # 构建检查 (仅在 push/PR 时运行，release 时跳过)
+  # ===================================================================
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: [test, compatibility, security]
+    if: github.event_name != 'release'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine wheel setuptools
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Check package
+        run: |
+          twine check dist/*
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v5
+        with:
+          name: dist-packages
+          path: dist/
+
+  # ===================================================================
+  # 自动发布到 PyPI 和 GitHub Release (使用 uv)
+  # 功能：
+  # - 从 GitHub Release 自动同步版本号
+  # - 更新 CHANGELOG.md
+  # - 构建并发布到 PyPI
+  # - 上传构建产物到 GitHub Release 页面
+  # 注意：此 job 仅在 release 事件时运行，不依赖其他 job（代码已在合并时检查过）
+  # ===================================================================
+  publish:
+    name: Publish to PyPI & GitHub Release
+    runs-on: ubuntu-latest
+    # 不再依赖 build job，直接运行（代码质量已在 PR 合并时验证）
+    if: github.event_name == 'release' && github.event.action == 'published'
+    environment: pypi
+    permissions:
+      id-token: write   # Required for trusted publishing
+      contents: write   # Required for pushing changes and uploading release assets
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          ref: main
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get version from tag
+        id: get_version
+        run: |
+          # 从 tag 提取版本号 (去掉 v 前缀)
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          echo "📦 Version: $VERSION"
+
+      - name: Update version in pyproject.toml
+        run: |
+          # 更新 pyproject.toml 中的版本号
+          sed -i "s/^version = \".*\"/version = \"${{ steps.get_version.outputs.VERSION }}\"/" pyproject.toml
+          echo "✅ Updated pyproject.toml version to ${{ steps.get_version.outputs.VERSION }}"
+          grep "^version" pyproject.toml
+
+      - name: Update CHANGELOG.md
+        env:
+          RELEASE_BODY: ${{ github.event.release.body }}
+          RELEASE_NAME: ${{ github.event.release.name }}
+        run: |
+          VERSION="${{ steps.get_version.outputs.VERSION }}"
+          DATE=$(date +%Y-%m-%d)
+
+          # 创建新的 changelog 条目
+          NEW_ENTRY="## [${VERSION}] - ${DATE}
+
+          ${RELEASE_BODY}
+
+          ---
+
+          "
+
+          # 在第一个 --- 分隔符之后插入新版本记录
+          awk -v entry="$NEW_ENTRY" '
+            !found && /^---$/ { print; print ""; print entry; found=1; next }
+            { print }
+          ' CHANGELOG.md > CHANGELOG.tmp && mv CHANGELOG.tmp CHANGELOG.md
+
+          echo "✅ Updated CHANGELOG.md with version $VERSION"
+
+      - name: Commit and push changes
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          git add pyproject.toml CHANGELOG.md
+
+          # 检查是否有变更
+          if git diff --staged --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "chore(release): v${{ steps.get_version.outputs.VERSION }} [skip ci]"
+            git push origin main
+            echo "✅ Pushed version changes to main branch"
+          fi
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install ${{ env.PYTHON_VERSION }}
+
+      - name: Build package with uv
+        id: build
+        run: |
+          uv build
+          echo "✅ Package built successfully"
+          ls -la dist/
+          # 输出构建产物文件名供后续步骤使用
+          echo "WHEEL_FILE=$(ls dist/*.whl)" >> $GITHUB_OUTPUT
+          echo "SDIST_FILE=$(ls dist/*.tar.gz)" >> $GITHUB_OUTPUT
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          uv publish
+          echo "🚀 Published to PyPI successfully!"
+
+      - name: Upload release assets to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}