mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-09 07:15:51 -05:00
501ac92bb1
Introduces a pre-commit hook to ensure SVG image files are well-formed XML, preventing potential rendering or processing issues. This leverages `lxml` for parsing, which has been added as a new dependency. Corrects missing whitespace between attributes in existing SVG figures to comply with the new validation requirements.
Python Dependencies
This directory contains Python dependencies organized in a clean, modular structure.
Structure
requirements/
├── base.txt # Core dependencies (pandas, requests, etc.)
├── production.txt # Production-specific (includes base.txt)
└── development.txt # Full ML stack (includes production.txt)
Files
requirements/base.txt (Core Dependencies)
- Essential packages needed by all environments
- Jupyter, pandas, requests, PyYAML, etc.
- Lightweight foundation (~200MB)
requirements/production.txt (Container/Build)
- Includes
base.txt+ production-specific packages - OpenAI API, Groq, pre-commit, Ghostscript, etc.
- Excludes heavy ML libraries
- Optimized for containers (~500MB)
requirements/development.txt (Full ML Stack)
- Includes
production.txt+ ML dependencies - PyTorch, sentence-transformers, FAISS, scikit-learn
- Required for cross-reference generation
- Complete development environment (~4GB)
Convenience Files
requirements.txt (Default - Full)
pip install -r requirements.txt
References requirements/development.txt for complete functionality
requirements-build.txt (Container Optimized)
pip install -r requirements-build.txt
References requirements/production.txt for lightweight builds
requirements-dev.txt (Development Alias)
pip install -r requirements-dev.txt
Alias for requirements/development.txt
Usage Patterns
Container Builds (GitHub Actions)
RUN pip install -r tools/dependencies/requirements-build.txt
Result: Fast builds, small containers (~500MB Python deps)
Local Development
# For full development (recommended)
pip install -r tools/dependencies/requirements.txt
# For container-optimized builds only
pip install -r tools/dependencies/requirements-build.txt
Cross-Reference Generation
# Use full dependencies for ML tools
pip install -r tools/dependencies/requirements.txt
python tools/scripts/cross_refs/cross_refs.py
Migration Notes
requirements.txt: Full dependencies (unchanged for backward compatibility)requirements-build.txt: New minimal set for containers (~500MB vs ~4GB)- Containers should switch to
requirements-build.txtfor 3-4GB savings - Local development: Continue using
requirements.txt