docs: add reference to REQUIREMENTS.md in setup instructions (#157)

[soma-enyi]

• Summary

  This PR resolves the documentation gap around the three requirements files by improving discoverability and linking users to
  comprehensive guidance.

  Changes

  📝 Documentation Updates

  • README.md: Added a note in the setup instructions that directs users to REQUIREMENTS.md for guidance on selecting the
    appropriate requirements file based on their environment

  🔍 What was verified

  • ✅ All three requirements files (requirements.txt, requirements-cpu.txt, requirements-minimal.txt) maintain consistent
    version pins for shared packages
  • ✅ Existing REQUIREMENTS.md documentation is comprehensive and accurate with:
    • Clear decision tree for environment-based selection
    • Detailed purpose and use case for each file
    • Pin policy table ensuring version consistency
    • Guidance on when to use each file

  Issue Resolution

  Issue requirements.txt and requirements-cpu.txt divergence unclear #157: requirements.txt and requirements-cpu.txt divergence unclear

  Problem: Differences between the three requirements files were undocumented and unclear to users.

  Solution:

  1. Verified that comprehensive documentation already exists in REQUIREMENTS.md
  2. Enhanced discoverability by adding a reference in the main README.md setup section
  3. Users are now directed to clear guidance on:
     • When to use requirements.txt (GPU training stack)
     • When to use requirements-cpu.txt (CPU-only training stack)
     • When to use requirements-minimal.txt (Hydra + dataframes only)

  Testing

  • Verified all three requirements files have consistent version pins for shared packages
  • Confirmed REQUIREMENTS.md accurately documents all differences and use cases
  • README now clearly directs users to the comprehensive requirements documentation

  Closes

  Closes requirements.txt and requirements-cpu.txt divergence unclear #157

[drips-wave]

@soma-enyi Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits