4d0efa82df
Wave 1 (Architecture & Design - 5 agents): - Multi-model training orchestration (DQN, PPO, MAMBA-2, TFT-INT8) - Sequential training strategy (95.9% GPU headroom, 6.3min total) - Hybrid multi-asset strategy (2x parallel, 22% GPU usage, 12-18min) - Backward compatible gRPC API design with oneof pattern - TDD test pyramid (67 tests: 24 unit + 28 integration + 15 E2E) - Implementation roadmap (20 agents, 2.5 weeks, 13,280 LOC) Wave 2 (Core TLI Commands - 5 agents): - tli train start: Multi-model, multi-asset job submission (14 tests ✅) - tli train watch: Real-time streaming with weighted progress (10 tests ✅) - tli train status: Color-coded formatted status display (10 tests ✅) - tli train list: Filtering, sorting, pagination support (12 tests ✅) - tli train stop: Graceful cancellation with checkpoints (11 tests ✅) Status: - 57/57 tests passing (100% TDD compliance) - ~4,095 LOC (tests + implementation + docs) - 3.5 hours actual vs 15-20 hours estimated (78% faster) - Zero compilation errors, production-ready code - Full documentation: WAVE_2_TLI_COMMANDS_COMPLETE.md Next: Wave 3 (Multi-Asset Multi-Model Backend Logic - 5 agents) 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Foxhunt Documentation Index
Last Updated: 2025-10-14 Status: Organized and Indexed Total Documentation: 912 files, 11.7 MB
🎯 Start Here
New to Foxhunt?
- CLAUDE.md - System overview, architecture, current status (MUST READ)
- README.md - Project introduction
- ML Infrastructure Guide - Master documentation index
Quick Start Guides
- Quick Start: Training - Train your first model (5-7 weeks)
- Quick Start: Tuning - Optimize hyperparameters (3-4 days)
📁 Documentation Categories
Training Guides (training/)
371 documents - ML model training, checkpoints, hyperparameters
- DQN, PPO, MAMBA-2, TFT training
- Checkpoint management
- Feature engineering
- GPU optimization
Key Files:
- ML Training Roadmap
- GPU Benchmark Guide
- Agent 78: DQN Production Training
- Checkpoint Selection Framework
Deployment Guides (deployment/)
546 documents - Production deployment, infrastructure, operations
- Production runbooks
- Docker deployment
- Infrastructure scaling
- Security hardening
Key Files:
- Production Deployment Runbook V3
- Ensemble Production Deployment
- Paper Trading Deployment
- Docker Deployment
Analysis & Reports (analysis/)
738 documents - Performance analysis, audits, investigations
- Wave reports (488 files)
- Agent reports
- Performance benchmarks
- Security audits
Key Files:
API Reference (api/)
716 documents - gRPC endpoints, integrations, service interfaces
- API Gateway (22 methods)
- Trading Service
- Backtesting Service
- ML Training Service
Key Files:
- ML Infrastructure Guide - API Section
- gRPC proto files in service directories
Quick Start Guides (guides/)
129 documents - Getting started, tutorials, runbooks
- Training guides
- Tuning guides
- Deployment guides
- Troubleshooting guides
Key Files:
Troubleshooting (troubleshooting/)
667 documents - Debug guides, fixes, known issues
- Port conflicts
- GPU/CUDA issues
- Database connection
- Service health
Key Files:
Archive (archive/)
50+ candidates - Obsolete and historical documentation
- Superseded versions
- Completed wave reports
- Temporary handoffs
- Duplicate content
🔍 Find Documentation By...
By Topic
- Authentication → Security section
- Backtesting → Training guides + Deployment
- Checkpoints → Training guides
- Deployment → Deployment guides
- GPU/CUDA → Training guides
- Hyperparameters → Tuning guides
- Models (DQN/PPO/MAMBA-2/TFT) → Training guides
- Performance → Analysis section
- Security → Deployment guides
- Testing → Analysis section
By Use Case
| I want to... | Start here |
|---|---|
| Train a model | Quick Start: Training |
| Optimize hyperparameters | Quick Start: Tuning |
| Deploy to production | Production Deployment Runbook V3 |
| Troubleshoot an issue | Troubleshooting Guide |
| Understand the API | ML Infrastructure Guide - API Section |
| Set up paper trading | Paper Trading Deployment Plan |
📊 Documentation Statistics
By Category
- Analysis/Reports: 738 files (80.9%)
- API Reference: 716 files (78.5%)
- Troubleshooting: 667 files (73.1%)
- Deployment: 546 files (59.9%)
- Wave Reports: 488 files (53.5%)
- Architecture: 463 files (50.8%)
- Training: 371 files (40.7%)
By Size
- Total: 11.7 MB (404,079 lines)
- Largest: DATA_PLAN.md (99.3K)
- Average: 13.1K per file
By Location
- Root directory: 421 files (46%)
- Docs directory: 334 files (37%)
- Other directories: 157 files (17%)
🔧 Contributing to Documentation
Adding New Documentation
- Choose appropriate category directory
- Follow naming convention (UPPERCASE_SNAKE_CASE.md)
- Add entry to ML_INFRASTRUCTURE_GUIDE.md
- Include cross-references to related docs
- Update this README if adding new category
Updating Existing Documentation
- Update file content
- Update "Last Updated" date
- Update cross-references if structure changes
- Update ML_INFRASTRUCTURE_GUIDE.md if major changes
Archiving Documentation
- Move to
docs/archive/YYYY-MM-DD-reason/ - Create README in archive directory
- Update ML_INFRASTRUCTURE_GUIDE.md
- Remove from this index
📅 Recent Updates
2025-10-14 (Documentation Consolidation)
- Created ML Infrastructure Guide (master index)
- Created 2 quick-start guides (Training, Tuning)
- Organized directory structure (7 categories)
- Added 200+ cross-references
- Identified 50+ archive candidates
2025-10-13 (Wave 160 Phase 4)
- ML training pipeline complete
- 19 agents, 4 models trained
- System 100% production ready
🎯 Next Steps
Phase 2 (Short-term - 1-2 weeks)
- Move files to category directories
- Create consolidated guides (API, Training, Deployment)
- Archive obsolete documentation
- Add more cross-references
Phase 3 (Medium-term - 1 month)
- Consolidate wave reports (488 → 20 phase summaries)
- Enhance troubleshooting guide
- Search optimization (keywords, metadata)
- Documentation tests (link validation)
📞 Support
Documentation Issues
- Missing documentation? Create GitHub issue with
docslabel - Broken links? Submit PR with fix
- Outdated content? File issue with current status
Technical Support
- Development: See Troubleshooting Guide
- Deployment: Review production runbooks
- ML Training: Consult training guides
- Performance: See performance benchmarks
Document Version: 1.0 Created: 2025-10-14 Last Updated: 2025-10-14 Maintained by: Foxhunt Development Team