mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-12 02:53:34 -05:00

Files

Vijay Janapa Reddi f5004807eb 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

archive/book-development

Clean up book directory - remove duplicates and archive unused files

2025-11-07 18:34:11 -05:00

development

docs: Major cleanup - 46 → 12 essential docs

2025-09-27 17:04:19 -04:00

nbgrader

Add progressive demo system with repository reorganization

2025-09-18 17:36:32 -04:00

cifar10-training-guide.md

Restructure TinyTorch: Move TinyGPT to examples, improve testing framework

2025-09-22 09:37:18 -04:00

INSTRUCTOR_GUIDE.md

Add progressive demo system with repository reorganization

2025-09-18 17:36:32 -04:00

README.md

docs: Major cleanup - 46 → 12 essential docs

2025-09-27 17:04:19 -04:00

STUDENT_QUICKSTART.md

Consolidate environment setup to ONE canonical path

2025-11-05 17:11:47 -05:00

tinytorch-assumptions.md

feat: Implement TinyTorch complexity framework for academic friendliness

2025-09-27 16:59:00 -04:00

README.md

TinyTorch Documentation

This directory contains essential documentation for TinyTorch development and usage.

📚 User Documentation

STUDENT_QUICKSTART.md - Getting started guide for students
INSTRUCTOR_GUIDE.md - Setup and grading guide for instructors
cifar10-training-guide.md - Complete guide to achieving the north star goal (75% CIFAR-10 accuracy)

🔧 Development Documentation

tinytorch-assumptions.md - CRITICAL: TinyTorch complexity framework and implementation guidelines
tinytorch-textbook-alignment.md - Alignment with ML systems textbooks

Development Standards

development/module-rules.md - Module development standards and patterns
development/nbgrader-standardized-testing.md - Testing standards
development/nbgrader-testing-template.md - Testing templates

NBGrader Integration

nbgrader/NBGrader_Quick_Reference.md - Daily use commands and workflow
nbgrader/NBGRADER_STYLE_GUIDE.md - Style guide for NBGrader cells
nbgrader/NBGrader_Text_Response_Technical_Implementation.md - Technical implementation details

📦 Archive

The archive/ directory contains historical documentation that's no longer actively maintained but preserved for reference.

Start here:

Students: Read STUDENT_QUICKSTART.md
Instructors: Read INSTRUCTOR_GUIDE.md
Developers: Read tinytorch-assumptions.md FIRST, then development/module-rules.md