TinyTorch/docs/tito/overview.md

TITO Command Reference

Master the TinyTorch CLI

Complete command reference for building ML systems efficiently

Purpose: Quick reference for all TITO commands. Find the right command for every task in your ML systems engineering journey.

Quick Start: Three Commands You Need

1. Check Your Environment

tito system health

Verify your setup is ready for development

2. Build & Export Modules

tito module complete 01

Export your module to the TinyTorch package

3. Run Historical Milestones

tito milestone run 03

Recreate ML history with YOUR code

---

👥 Commands by User Role

TinyTorch serves three types of users. Choose your path:

🎓 Student / Learner

You're learning ML systems by building from scratch

Your Workflow:

# Start learning
tito module start 01

# Complete modules  
tito module complete 01

# Validate with history
tito milestone run 03

# Track progress
tito status

Key Commands:

• tito module - Build components
• tito milestone - Validate
• tito status - Track progress

👨‍🏫 Instructor

You're teaching ML systems engineering

Your Workflow:

# Generate assignments
tito nbgrader generate 01

# Distribute to students
tito nbgrader release 01

# Collect & grade
tito nbgrader collect 01
tito nbgrader autograde 01

# Provide feedback
tito nbgrader feedback 01

Key Commands:

• tito nbgrader - Assignment management
• tito module - Test implementations
• tito milestone - Validate setups

👩‍💻 Developer / Contributor

You're contributing to TinyTorch modules

Your Workflow:

# Edit source code
# src/01_tensor/01_tensor.py

# Export to notebooks & package
tito src export 01_tensor
tito src export --all

# Test implementations
tito src test 01_tensor

# Validate changes
tito milestone run 03

Key Commands:

• tito src - Developer workflow
• tito module - Test as student
• tito milestone - Validate

---

Complete Command Reference

System Commands

Purpose: Environment health, validation, and configuration

Command	Description	Guide
tito system health	Quick environment health check (status only)	Module Workflow
tito system check	Comprehensive validation with 60+ tests	Module Workflow
tito system info	System resources (paths, disk, memory)	Module Workflow
tito system version	Show all package versions	Module Workflow
tito system clean	Clean workspace caches and temp files	Module Workflow
tito system report	Generate JSON diagnostic report	Module Workflow
tito system jupyter	Start Jupyter Lab server	Module Workflow
tito system protect	Student protection system	Module Workflow

Module Commands

Purpose: Build-from-scratch workflow (your main development cycle)

Command	Description	Guide
tito module start XX	Begin working on a module (first time)	Module Workflow
tito module resume XX	Continue working on a module	Module Workflow
tito module complete XX	Test, export, and track module completion	Module Workflow
tito module status	View module completion progress	Module Workflow
tito module reset XX	Reset module to clean state	Module Workflow

See: Module Workflow Guide for complete details

Milestone Commands

Purpose: Run historical ML recreations with YOUR implementations

Command	Description	Guide
tito milestone list	Show all 6 historical milestones (1957-2018)	Milestone System
tito milestone run XX	Run milestone with prerequisite checking	Milestone System
tito milestone info XX	Get detailed milestone information	Milestone System
tito milestone status	View milestone progress and achievements	Milestone System
tito milestone timeline	Visual timeline of your journey	Milestone System

See: Milestone System Guide for complete details

Progress & Data Commands

Purpose: Track progress and manage user data

Command	Description	Guide
tito status	View all progress (modules + milestones)	Progress & Data
tito reset all	Reset all progress and start fresh	Progress & Data
tito reset progress	Reset module completion only	Progress & Data
tito reset milestones	Reset milestone achievements only	Progress & Data

See: Progress & Data Management for complete details

Community Commands

Purpose: Join the global TinyTorch community and track your progress

Command	Description	Guide
tito community join	Join the community (optional info)	Community Guide
tito community update	Update your community profile	Community Guide
tito community profile	View your community profile	Community Guide
tito community stats	View community statistics	Community Guide
tito community leave	Remove your community profile	Community Guide

See: Community Guide for complete details

Benchmark Commands

Purpose: Validate setup and measure performance

Command	Description	Guide
tito benchmark baseline	Quick setup validation ("Hello World")	Community Guide
tito benchmark capstone	Full Module 20 performance evaluation	Community Guide

See: Community Guide for complete details

Developer Commands

Purpose: Source code development and contribution (for developers only)

Command	Description	Use Case
tito src export <module>	Export src/ → modules/ → tinytorch/	After editing source files
tito src export --all	Export all modules	After major refactoring
tito src test <module>	Run tests on source files	During development

Note: These commands work with src/XX_name/XX_name.py files and are for TinyTorch contributors/developers.
Students use tito module commands to work with generated notebooks.

Directory Structure:

src/              ← Developers edit here (Python source)
modules/          ← Students use these (generated notebooks)
tinytorch/        ← Package code (auto-generated)

---

Command Groups by Task

First-Time Setup

# Clone and setup
git clone https://github.com/mlsysbook/TinyTorch.git
cd TinyTorch
./setup-environment.sh
source activate.sh

# Verify environment
tito system health

Student Workflow (Learning)

# Start or continue a module
tito module start 01      # First time
tito module resume 01     # Continue later

# Export when complete
tito module complete 01

# Check progress
tito module status

Developer Workflow (Contributing)

# Edit source files in src/
vim src/01_tensor/01_tensor.py

# Export to notebooks + package
tito src export 01_tensor

# Test implementation
python -c "from tinytorch import Tensor; print(Tensor([1,2,3]))"

# Validate with milestones
tito milestone run 03

Achievement & Validation

# See available milestones
tito milestone list

# Get details
tito milestone info 03

# Run milestone
tito milestone run 03

# View achievements
tito milestone status

Progress Management

# View all progress
tito status

# Reset if needed
tito reset all --backup

---

Typical Session Flow

Here's what a typical TinyTorch session looks like:

1. Start Session

cd TinyTorch
source activate.sh
tito system health         # Verify environment

2. Work on Module

tito module start 03       # Or: tito module resume 03
# Edit in Jupyter Lab...

3. Export & Test

tito module complete 03

4. Run Milestone (when prerequisites met)

tito milestone list        # Check if ready
tito milestone run 03      # Run with YOUR code

5. Track Progress

tito status                # See everything

---

Command Help

Every command has detailed help text:

# Top-level help
tito --help

# Command group help
tito module --help
tito milestone --help

# Specific command help
tito module complete --help
tito milestone run --help

---

Detailed Guides

• Module Workflow - Complete guide to building and exporting modules
• Milestone System - Running historical ML recreations
• Progress & Data - Managing your learning journey
• Troubleshooting - Common issues and solutions

---

Related Resources

• Getting Started Guide - Complete setup and first steps
• Module Workflow - Day-to-day development cycle
• Datasets Guide - Understanding TinyTorch datasets

---

Master these commands and you'll build ML systems with confidence. Every command is designed to accelerate your learning and keep you focused on what matters: building production-quality ML frameworks from scratch.