Commit Graph

4 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
0a8c4675f1 Clean up book directory - remove duplicates and archive unused files
Removed duplicate content:
- user-manual.md (17K) - duplicate of quickstart-guide.md
- instructor-guide.md (12K) - duplicate of classroom-use.md
- leaderboard.md (6K) - old Olympics content, superseded by community.md

Archived development/reference files to docs/archive/book-development/:
- THEME_DESIGN.md, convert_*.py, verify_build.py (build scripts)
- faq.md, kiss-principle.md, vision.md (reference docs)
- quick-exploration.md, serious-development.md (unused usage paths)

Archived unused images to book/_static/archive/:
- Gemini_Generated_Image_*.png (3 AI-generated images)

Result:
- 26% reduction in markdown files (39 → 29)
- No duplication of content
- Cleaner repository structure
- All active files in TOC or properly referenced

See docs/archive/book-development/CLEANUP_SUMMARY.md for details.
2025-11-07 18:34:11 -05:00
Vijay Janapa Reddi
73e04f2d12 Clean up repository by removing unnecessary documentation
- Remove archive directories (docs/archive, modules/source/archive, root archive)
- Remove book placeholder files (5 stub chapters)
- Remove historical milestone status and analysis files (13 files)
- Remove outdated documentation (progressive analysis demo, textbook alignment)
- Remove 01-setup chapter (no corresponding module exists)
- Renumber book chapters to match actual module structure
- Fix module references in tokenization chapter

Total: 72 files removed, chapter numbering corrected
2025-11-01 10:06:23 -04:00
Vijay Janapa Reddi
ed80f7e81c docs: Major cleanup - 46 → 12 essential docs
MASSIVE DOCUMENTATION CLEANUP:
- Reduced from 46 docs to 12 essential files
- Archived 34 outdated planning and analysis documents

 KEPT (Essential for current operations):
- STUDENT_QUICKSTART.md - Student onboarding
- INSTRUCTOR_GUIDE.md - Instructor setup
- cifar10-training-guide.md - North star achievement
- tinytorch-assumptions.md - Complexity framework (NEW)
- tinytorch-textbook-alignment.md - Academic alignment

- NBGrader integration docs (3 files)
- Development standards (3 files)
- docs/README.md - Navigation guide (NEW)

🗑️ ARCHIVED (Completed/outdated planning):
- All optimization-modules-* planning docs
- All milestone-* system docs
- All tutorial-master-plan and analysis docs
- Module reordering and structure analysis
- Agent setup and workflow case studies

RESULT: Clean, focused documentation structure
Only active, current docs remain - easy to find what you need!
2025-09-27 17:04:19 -04:00
Vijay Janapa Reddi
bcba1ac3be FOUNDATION: Establish AI Engineering as a discipline through TinyTorch
🎯 NORTH STAR VISION DOCUMENTED:
'Don't Just Import It, Build It' - Training AI Engineers, not just ML users

AI Engineering emerges as a foundational discipline like Computer Engineering,
bridging algorithms and systems to build the AI infrastructure of the future.

🧪 ROBUST TESTING FRAMEWORK ESTABLISHED:
- Created tests/regression/ for sandbox integrity tests
- Implemented test-driven bug prevention workflow
- Clear separation: student tests (pedagogical) vs system tests (robustness)
- Every bug becomes a test to prevent recurrence

 KEY IMPLEMENTATIONS:
- NORTH_STAR.md: Vision for AI Engineering discipline
- Testing best practices: Focus on robust student sandbox
- Git workflow standards: Professional development practices
- Regression test suite: Prevent infrastructure issues
- Conv->Linear dimension tests (found CNN bug)
- Transformer reshaping tests (found GPT bug)

🏗️ SANDBOX INTEGRITY:
Students need a solid, predictable environment where they focus on ML concepts,
not debugging framework issues. The framework must be invisible.

📚 EDUCATIONAL PHILOSOPHY:
TinyTorch isn't just teaching a framework - it's founding the AI Engineering
discipline by training engineers who understand how to BUILD ML systems.

This establishes the foundation for training the first generation of true
AI Engineers who will define this emerging discipline.
2025-09-25 11:16:28 -04:00