mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-07-18 04:17:32 -05:00

Files

Vijay Janapa Reddi 161fb3d517 Enhance CLI visual design for better student engagement

Improved three key student-facing commands with Rich formatting:

1. tito module status
   - Visual progress bar (███░░░)
   - Clean table with status icons (✅🚀⏳🔒)
   - Smart list collapsing for readability
   - Milestone readiness indicators
   - Clear "Next Action" guidance

2. tito module complete
   - 3-step visual workflow (Test → Export → Track)
   - Celebratory completion message
   - Shows what students can now do
   - Progress percentage tracking
   - Suggests next module

3. tito module start
   - Prerequisite checking (enforces sequential learning)
   - Beautiful locked/unlocked module displays
   - Shows missing prerequisites in table
   - Milestone progress preview
   - Clear step-by-step instructions

Design principles:
- Progressive disclosure (show relevant info only)
- Clear visual hierarchy (panels, tables, separators)
- Pedagogical guidance (always show next action)
- Consistent iconography (✅🚀⏳🔒🏆💡)

Ready for demo GIF recording!

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>

2025-11-25 11:53:29 -05:00

development

Enhance CLI visual design for better student engagement

2025-11-25 11:53:29 -05:00

history

Reorganize repository structure and add build tooling

2025-11-25 11:29:41 -05:00

nbgrader

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

_config_pdf.yml

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

_toc_pdf.yml

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

cifar10-training-guide.md

docs: update module references in README and guides

2025-11-09 12:42:27 -05:00

cover.md

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

INSTRUCTOR_GUIDE.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -05:00

preface.md

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

PRIVACY_DATA_RETENTION.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -05:00

README.md

Remove references to non-existent documentation files

2025-11-19 22:03:57 -05:00

STUDENT_QUICKSTART.md

Update documentation for new src/ structure

2025-11-25 02:13:19 -05:00

TEAM_ONBOARDING.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -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

Development Standards

development/module-rules.md - Module development standards and patterns

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

Start here:

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