mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-03-12 00:03:35 -05:00
Add canonical student workflow documentation
Created new student-workflow.md as the single source of truth for the TinyTorch development cycle. Updated quickstart-guide.md, tito-essentials.md, and intro.md to emphasize the simple workflow and reference the canonical guide. Key changes: - **New file**: site/student-workflow.md - Complete workflow guide - **quickstart-guide.md**: Added workflow context and step-by-step examples - **tito-essentials.md**: Simplified to focus on essential commands, marked checkpoint system as optional - **intro.md**: Added workflow section early, simplified getting started, marked instructor features as "coming soon" The actual workflow: 1. Edit modules in modules/source/ 2. Export with `tito module complete N` 3. Validate by running milestone scripts Checkpoint system and instructor features are documented as optional/coming soon, not primary workflow.
This commit is contained in:
Vijay Janapa Reddi
@@ -31,6 +31,18 @@ TinyTorch is an educational ML systems course where you **build complete neural
|
||||
|
||||
**Core Learning Approach**: Build → Profile → Optimize. You'll implement each system component, measure its performance characteristics, and understand the engineering trade-offs that shape production ML systems.
|
||||
|
||||
## The Simple Workflow
|
||||
|
||||
TinyTorch follows a three-step cycle:
|
||||
|
||||
```
|
||||
1. Edit modules → 2. Export to package → 3. Validate with milestones
|
||||
```
|
||||
|
||||
You work on module source files (`modules/source/`), export them to the TinyTorch package (`tito module complete N`), and prove they work by running historical milestone scripts. That's it.
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete development cycle.
|
||||
|
||||
## Three-Tier Learning Pathway
|
||||
|
||||
TinyTorch organizes learning through **three pedagogically-motivated tiers** that follow ML history:
|
||||
@@ -221,7 +233,7 @@ You master modern LLM optimizations
|
||||
<!-- Bottom Row -->
|
||||
<div style="background: #faf5ff; border: 1px solid #b794f6; padding: 2rem; border-radius: 0.5rem; text-align: center;">
|
||||
<h3 style="margin: 0 0 1rem 0; font-size: 1.2rem; color: #495057;">🎓 Instructors</h3>
|
||||
<p style="margin: 0 0 1.5rem 0; font-size: 0.95rem; color: #6c757d;">Classroom-ready • NBGrader integration • Automated grading</p>
|
||||
<p style="margin: 0 0 1.5rem 0; font-size: 0.95rem; color: #6c757d;">Classroom-ready • NBGrader integration (coming soon)</p>
|
||||
<a href="usage-paths/classroom-use.html" style="display: inline-block; background: #6f42c1; color: white; padding: 0.75rem 1.5rem; border-radius: 0.25rem; text-decoration: none; font-weight: 500; font-size: 1rem;">Teaching Guide →</a>
|
||||
</div>
|
||||
|
||||
@@ -235,11 +247,23 @@ You master modern LLM optimizations
|
||||
|
||||
## Getting Started
|
||||
|
||||
Whether you're just exploring or ready to dive in, here are helpful resources: **📖 See [Essential Commands](tito-essentials.html)** for complete setup and command reference, or **📖 See [Three-Tier Learning Structure](chapters/00-introduction.html#three-tier-learning-pathway-build-complete-ml-systems)** for detailed tier breakdown and learning outcomes.
|
||||
Ready to build ML systems from scratch? Here's how to start:
|
||||
|
||||
**Additional Resources**:
|
||||
- **[Progress Tracking](learning-progress.html)** - Monitor your learning journey with 21 capability checkpoints
|
||||
- **[Testing Framework](testing-framework.html)** - Understand our comprehensive validation system
|
||||
- **[Documentation & Guides](resources.html)** - Complete technical documentation and tutorials
|
||||
**Quick Setup** (15 minutes):
|
||||
1. Clone the repository
|
||||
2. Run `./setup-environment.sh`
|
||||
3. Start with Module 01 (Tensors)
|
||||
4. Export with `tito module complete 01`
|
||||
5. Validate by running milestone scripts
|
||||
|
||||
**📖 See [Quick Start Guide](quickstart-guide.html)** for detailed setup instructions.
|
||||
|
||||
**Understanding the Workflow**:
|
||||
- **📖 See [Student Workflow](student-workflow.html)** - The essential edit → export → validate cycle
|
||||
- **📖 See [Essential Commands](tito-essentials.html)** - Complete TITO command reference
|
||||
- **📖 See [Three-Tier Learning Structure](chapters/00-introduction.html)** - Detailed course structure
|
||||
|
||||
**Optional Progress Tracking**:
|
||||
- **[Progress Tracking](learning-progress.html)** - Monitor your journey with capability checkpoints (optional)
|
||||
|
||||
TinyTorch is more than a course—it's a community of learners building together. Join thousands exploring ML systems from the ground up.
|
||||
@@ -52,7 +52,13 @@ You should see all green checkmarks! This confirms your environment is ready for
|
||||
|
||||
## 🏗️ 15-Minute First Module Walkthrough
|
||||
|
||||
Let's build your first neural network component and unlock your first capability:
|
||||
Let's build your first neural network component following the **TinyTorch workflow**:
|
||||
|
||||
```
|
||||
1. Edit modules → 2. Export to package → 3. Validate with milestones
|
||||
```
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete development cycle.
|
||||
|
||||
### Module 01: Tensor Foundations
|
||||
|
||||
@@ -65,9 +71,9 @@ Let's build your first neural network component and unlock your first capability
|
||||
**💻 Action:** Start with Module 01 to build tensor operations from scratch.
|
||||
|
||||
```bash
|
||||
# Navigate to the tensor module
|
||||
cd modules/01_tensor
|
||||
jupyter lab tensor_dev.py
|
||||
# Step 1: Edit the module source
|
||||
cd modules/source/01_tensor
|
||||
jupyter lab 01_tensor_dev.py
|
||||
```
|
||||
|
||||
You'll implement core tensor operations:
|
||||
@@ -78,7 +84,14 @@ You'll implement core tensor operations:
|
||||
|
||||
**Key Implementation:** Build the `Tensor` class that forms the foundation of all neural networks
|
||||
|
||||
**📖 See [Essential Commands](tito-essentials.html)** for module workflow commands.
|
||||
```bash
|
||||
# Step 2: Export to package when ready
|
||||
tito module complete 01
|
||||
```
|
||||
|
||||
This makes your implementation importable: `from tinytorch import Tensor`
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete edit → export → validate cycle.
|
||||
|
||||
**✅ Achievement Unlocked:** Foundation capability - "Can I create and manipulate the building blocks of ML?"
|
||||
|
||||
@@ -94,6 +107,12 @@ You'll implement core tensor operations:
|
||||
|
||||
**💻 Action:** Continue with Module 02 to add activation functions.
|
||||
|
||||
```bash
|
||||
# Step 1: Edit the module
|
||||
cd modules/source/02_activations
|
||||
jupyter lab 02_activations_dev.py
|
||||
```
|
||||
|
||||
You'll implement essential activation functions:
|
||||
- ReLU (Rectified Linear Unit) - the workhorse of deep learning
|
||||
- Softmax - for probability distributions
|
||||
@@ -102,7 +121,12 @@ You'll implement essential activation functions:
|
||||
|
||||
**Key Implementation:** Build activation functions that allow neural networks to learn complex patterns
|
||||
|
||||
**📖 See [Essential Commands](tito-essentials.html)** for module development workflow.
|
||||
```bash
|
||||
# Step 2: Export when ready
|
||||
tito module complete 02
|
||||
```
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete edit → export → validate cycle.
|
||||
|
||||
**✅ Achievement Unlocked:** Intelligence capability - "Can I add nonlinearity to enable learning?"
|
||||
|
||||
@@ -114,28 +138,38 @@ After completing your first modules:
|
||||
|
||||
<div style="background: #f8f9fa; padding: 1.5rem; border: 1px solid #dee2e6; border-radius: 0.5rem; margin: 1.5rem 0;">
|
||||
|
||||
**Check your new capabilities:** Track your progress through the 21-checkpoint system to see your growing ML systems expertise.
|
||||
**Check your new capabilities:** Use the optional checkpoint system to track your progress:
|
||||
|
||||
**📖 See [Track Your Progress](learning-progress.html)** for detailed capability tracking and [Essential Commands](tito-essentials.html)** for progress monitoring commands.
|
||||
```bash
|
||||
tito checkpoint status # View your completion tracking
|
||||
```
|
||||
|
||||
This is helpful for self-assessment but not required for the core workflow.
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the essential edit → export → validate cycle, and [Track Your Progress](learning-progress.html)** for detailed capability tracking.
|
||||
|
||||
</div>
|
||||
|
||||
## 🏆 Unlock Historical Milestones
|
||||
## 🏆 Validate with Historical Milestones
|
||||
|
||||
As you progress, **prove what you've built** by recreating history's greatest ML breakthroughs:
|
||||
After exporting your modules, **prove what you've built** by running milestone scripts:
|
||||
|
||||
<div style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); padding: 2rem; border-radius: 0.5rem; margin: 1.5rem 0; color: white;">
|
||||
|
||||
**After Module 04**: Build **Rosenblatt's 1957 Perceptron** - the first trainable neural network
|
||||
**After Module 06**: Solve the **1969 XOR Crisis** with multi-layer networks
|
||||
**After Module 08**: Achieve **95%+ accuracy on MNIST** with 1986 backpropagation
|
||||
**After Module 09**: Hit **75%+ on CIFAR-10** with 1998 CNNs - your North Star goal! 🎯
|
||||
**After Module 07**: Build **Rosenblatt's 1957 Perceptron** - the first trainable neural network
|
||||
**After Module 07**: Solve the **1969 XOR Crisis** with multi-layer networks
|
||||
**After Module 08**: Achieve **95%+ accuracy on MNIST** with 1986 backpropagation
|
||||
**After Module 09**: Hit **75%+ on CIFAR-10** with 1998 CNNs
|
||||
**After Module 13**: Generate text with **2017 Transformers**
|
||||
**After Module 18**: Optimize for production with **2018 MLPerf**
|
||||
|
||||
**📖 See [Journey Through ML History](chapters/milestones.html)** for complete milestone demonstrations.
|
||||
|
||||
</div>
|
||||
|
||||
**Why Milestones Matter**: These aren't toy demos - they're historically significant achievements proving YOUR implementations work at production scale!
|
||||
**The Workflow**: Edit modules → Export with `tito module complete N` → Run milestone scripts to validate
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete cycle.
|
||||
|
||||
## 🎯 What You Just Accomplished
|
||||
|
||||
@@ -166,14 +200,15 @@ In 15 minutes, you've:
|
||||
|
||||
### Immediate Next Actions (Choose One):
|
||||
|
||||
**🔥 Continue Building (Recommended):** Begin Module 03 to add intelligence to your network with nonlinear activation functions.
|
||||
**🔥 Continue Building (Recommended):** Begin Module 03 to add layers to your network.
|
||||
|
||||
**📚 Learn the Workflow:**
|
||||
- **📖 See [Essential Commands](tito-essentials.html)** for complete TITO command guide
|
||||
**📚 Master the Workflow:**
|
||||
- **📖 See [Student Workflow](student-workflow.html)** for the complete edit → export → validate cycle
|
||||
- **📖 See [Essential Commands](tito-essentials.html)** for complete TITO command reference
|
||||
- **📖 See [Track Your Progress](learning-progress.html)** for the full learning path
|
||||
|
||||
**🎓 For Instructors:**
|
||||
- **📖 See [Classroom Setup Guide](usage-paths/classroom-use.html)** for NBGrader integration and grading workflow
|
||||
- **📖 See [Classroom Setup Guide](usage-paths/classroom-use.html)** for NBGrader integration (coming soon)
|
||||
|
||||
</div>
|
||||
|
||||
@@ -181,13 +216,12 @@ In 15 minutes, you've:
|
||||
|
||||
<div style="background: #fff5f5; padding: 1.5rem; border: 1px solid #fed7d7; border-radius: 0.5rem; margin: 1rem 0;">
|
||||
|
||||
**Essential Development Practices:**
|
||||
- Always verify your environment before starting
|
||||
- Track your progress through capability checkpoints
|
||||
- Follow the standard module development workflow
|
||||
- Use diagnostic commands when debugging issues
|
||||
**The TinyTorch Development Cycle:**
|
||||
1. Edit module sources in `modules/source/`
|
||||
2. Export with `tito module complete N`
|
||||
3. Validate by running milestone scripts
|
||||
|
||||
**📖 See [Essential Commands](tito-essentials.html)** for complete workflow commands and troubleshooting guide.
|
||||
**📖 See [Student Workflow](student-workflow.html)** for detailed workflow guide and best practices.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
153
site/student-workflow.md
Normal file
153
site/student-workflow.md
Normal file
@@ -0,0 +1,153 @@
|
||||
# Student Workflow
|
||||
|
||||
This guide explains the actual day-to-day workflow for building your ML framework with TinyTorch.
|
||||
|
||||
## The Core Workflow
|
||||
|
||||
TinyTorch follows a simple three-step cycle:
|
||||
|
||||
```
|
||||
1. Edit modules → 2. Export to package → 3. Validate with milestones
|
||||
```
|
||||
|
||||
### Step 1: Edit Modules
|
||||
|
||||
Work on module source files in `modules/source/`:
|
||||
|
||||
```bash
|
||||
# Example: Working on Module 03 (Layers)
|
||||
cd modules/source/03_layers
|
||||
# Edit the *_dev.py files with your implementation
|
||||
```
|
||||
|
||||
Each module is a Jupyter notebook in Python format (`.py` files with cell markers). You'll:
|
||||
- Implement the required functionality
|
||||
- Add docstrings and comments
|
||||
- Include tests within the module
|
||||
|
||||
### Step 2: Export to Package
|
||||
|
||||
Once your module implementation is complete, export it to the main TinyTorch package:
|
||||
|
||||
```bash
|
||||
tito module complete MODULE_NUMBER
|
||||
```
|
||||
|
||||
This command:
|
||||
- Converts your source files to the `tinytorch/` package
|
||||
- Validates NBGrader metadata
|
||||
- Makes your implementation available for import
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
tito module complete 03 # Export Module 03 (Layers)
|
||||
```
|
||||
|
||||
After export, your code is importable:
|
||||
```python
|
||||
from tinytorch.layers import Linear # YOUR implementation!
|
||||
```
|
||||
|
||||
### Step 3: Validate with Milestones
|
||||
|
||||
Run milestone scripts to prove your implementation works:
|
||||
|
||||
```bash
|
||||
cd milestones/01_1957_perceptron
|
||||
python 01_rosenblatt_forward.py # Uses YOUR Tensor (M01)
|
||||
python 02_rosenblatt_trained.py # Uses YOUR layers (M01-M07)
|
||||
```
|
||||
|
||||
Each milestone has a README explaining:
|
||||
- Required modules
|
||||
- Historical context
|
||||
- Expected results
|
||||
- What you're learning
|
||||
|
||||
See [Milestones Guide](chapters/milestones.md) for the full progression.
|
||||
|
||||
## Module Progression
|
||||
|
||||
TinyTorch has 18 modules organized in three tiers:
|
||||
|
||||
### 🏗️ Foundation (Modules 01-07)
|
||||
Core ML infrastructure - tensors, autograd, training loops
|
||||
|
||||
**Milestones unlocked:**
|
||||
- M01: Perceptron (after Module 07)
|
||||
- M02: XOR Crisis (after Module 07)
|
||||
|
||||
### 🏛️ Architecture (Modules 08-13)
|
||||
Neural network architectures - data loading, CNNs, transformers
|
||||
|
||||
**Milestones unlocked:**
|
||||
- M03: MLPs (after Module 08)
|
||||
- M04: CNNs (after Module 09)
|
||||
- M05: Transformers (after Module 13)
|
||||
|
||||
### ⚡ Optimization (Modules 14-18)
|
||||
Production optimization - profiling, quantization, acceleration
|
||||
|
||||
**Milestones unlocked:**
|
||||
- M06: MLPerf (after Module 18)
|
||||
|
||||
## Typical Development Session
|
||||
|
||||
Here's what a typical session looks like:
|
||||
|
||||
```bash
|
||||
# 1. Work on a module
|
||||
cd modules/source/05_autograd
|
||||
# Edit 05_autograd_dev.py with your implementation
|
||||
|
||||
# 2. Export when ready
|
||||
tito module complete 05
|
||||
|
||||
# 3. Validate with existing milestones
|
||||
cd ../../milestones/01_1957_perceptron
|
||||
python 01_rosenblatt_forward.py # Should still work!
|
||||
|
||||
# 4. Continue to next module or milestone
|
||||
```
|
||||
|
||||
## TITO Commands Reference
|
||||
|
||||
The most important commands you'll use:
|
||||
|
||||
```bash
|
||||
# Export module to package
|
||||
tito module complete MODULE_NUMBER
|
||||
|
||||
# Check module status (optional capability tracking)
|
||||
tito checkpoint status
|
||||
|
||||
# System information
|
||||
tito system info
|
||||
```
|
||||
|
||||
For complete command documentation, see [TITO Essentials](tito-essentials.md).
|
||||
|
||||
## Checkpoint System (Optional)
|
||||
|
||||
TinyTorch includes an optional checkpoint system for tracking progress:
|
||||
|
||||
```bash
|
||||
tito checkpoint status # View completion tracking
|
||||
```
|
||||
|
||||
This is helpful for self-assessment but **not required** for the core workflow. The essential cycle remains: edit → export → validate.
|
||||
|
||||
## Instructor Integration (Coming Soon)
|
||||
|
||||
TinyTorch supports NBGrader for classroom use. Documentation for instructors using the autograding features will be available in future releases.
|
||||
|
||||
For now, focus on the student workflow: building your implementations and validating them with milestones.
|
||||
|
||||
## What's Next?
|
||||
|
||||
1. **Start with Module 01**: See [Getting Started](intro.md)
|
||||
2. **Follow the progression**: Each module builds on previous ones
|
||||
3. **Run milestones**: Prove your implementations work
|
||||
4. **Build intuition**: Understand ML systems from first principles
|
||||
|
||||
The goal isn't just to write code - it's to **understand** how modern ML frameworks work by building one yourself.
|
||||
@@ -7,9 +7,23 @@
|
||||
|
||||
**Purpose**: Complete command reference for the TITO CLI. Master the essential commands for development workflow, progress tracking, and system management.
|
||||
|
||||
## 🚀 First 4 Commands (Start Here)
|
||||
## The Core Workflow
|
||||
|
||||
Every TinyTorch journey begins with these essential commands:
|
||||
TinyTorch follows a simple three-step cycle:
|
||||
|
||||
```
|
||||
1. Edit modules → 2. Export to package → 3. Validate with milestones
|
||||
```
|
||||
|
||||
**The essential command**: `tito module complete MODULE_NUMBER` - exports your code to the TinyTorch package.
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for the complete development cycle guide.
|
||||
|
||||
This page documents all available TITO commands. The checkpoint system (`tito checkpoint status`) is optional for progress tracking.
|
||||
|
||||
## 🚀 Most Important Commands
|
||||
|
||||
The commands you'll use most often:
|
||||
|
||||
<div style="display: grid; grid-template-columns: 1fr; gap: 1rem; margin: 2rem 0;">
|
||||
|
||||
@@ -19,67 +33,55 @@ Every TinyTorch journey begins with these essential commands:
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">Verify your setup is ready for development</p>
|
||||
</div>
|
||||
|
||||
<div style="background: #f0fdf4; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #22c55e;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #15803d;">🎯 Track Your Progress</h4>
|
||||
<code style="background: #263238; color: #ffffff; padding: 0.5rem; border-radius: 0.25rem; display: block; margin: 0.5rem 0;">tito checkpoint status</code>
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">See which capabilities you've mastered</p>
|
||||
</div>
|
||||
|
||||
<div style="background: #fffbeb; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #f59e0b;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #d97706;">🔨 Work on a Module</h4>
|
||||
<code style="background: #263238; color: #ffffff; padding: 0.5rem; border-radius: 0.25rem; display: block; margin: 0.5rem 0;">tito module work 02_tensor</code>
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">Open and start building tensor operations</p>
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #d97706;">🔨 Export Module to Package (Essential)</h4>
|
||||
<code style="background: #263238; color: #ffffff; padding: 0.5rem; border-radius: 0.25rem; display: block; margin: 0.5rem 0;">tito module complete 01</code>
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">Export your module to the TinyTorch package - use this after editing modules</p>
|
||||
</div>
|
||||
|
||||
<div style="background: #fdf2f8; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #ec4899;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #be185d;">✅ Complete Your Work</h4>
|
||||
<code style="background: #263238; color: #ffffff; padding: 0.5rem; border-radius: 0.25rem; display: block; margin: 0.5rem 0;">tito module complete 02_tensor</code>
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">Export your code and test your capabilities</p>
|
||||
<div style="background: #f0fdf4; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #22c55e;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #15803d;">🎯 Track Your Progress (Optional)</h4>
|
||||
<code style="background: #263238; color: #ffffff; padding: 0.5rem; border-radius: 0.25rem; display: block; margin: 0.5rem 0;">tito checkpoint status</code>
|
||||
<p style="margin: 0.5rem 0 0 0; font-size: 0.9rem; color: #64748b;">See which capabilities you've mastered (optional capability tracking)</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
## 🔄 Your Daily Learning Workflow
|
||||
## 🔄 Typical Development Session
|
||||
|
||||
Follow this proven pattern for effective learning:
|
||||
Here's what a typical session looks like:
|
||||
|
||||
<div style="background: #f8f9fa; padding: 1.5rem; border: 1px solid #dee2e6; border-radius: 0.5rem; margin: 1.5rem 0;">
|
||||
|
||||
**Morning Start:**
|
||||
**Edit modules:**
|
||||
```bash
|
||||
# 1. Check environment
|
||||
tito system doctor
|
||||
|
||||
# 2. See your progress
|
||||
tito checkpoint status
|
||||
|
||||
# 3. Start working on next module
|
||||
tito module work 03_activations
|
||||
cd modules/source/03_layers
|
||||
jupyter lab 03_layers_dev.py
|
||||
# Make your implementation...
|
||||
```
|
||||
|
||||
**During Development:**
|
||||
**Export to package:**
|
||||
```bash
|
||||
# Test your understanding anytime
|
||||
tito checkpoint test 02
|
||||
|
||||
# View your learning timeline
|
||||
tito checkpoint timeline
|
||||
# From repository root
|
||||
tito module complete 03
|
||||
```
|
||||
|
||||
**End of Session:**
|
||||
**Validate with milestones:**
|
||||
```bash
|
||||
# Complete and export your work
|
||||
tito module complete 03_activations
|
||||
|
||||
# Celebrate your progress!
|
||||
tito checkpoint status
|
||||
cd milestones/01_1957_perceptron
|
||||
python 01_rosenblatt_forward.py # Uses YOUR implementation!
|
||||
```
|
||||
|
||||
**Optional progress tracking:**
|
||||
```bash
|
||||
tito checkpoint status # See what you've completed
|
||||
```
|
||||
|
||||
**📖 See [Student Workflow](student-workflow.html)** for complete development cycle details.
|
||||
|
||||
</div>
|
||||
|
||||
## 💪 Most Important Commands (Top 10)
|
||||
|
||||
Master these commands for maximum efficiency:
|
||||
## 📖 Complete Command Reference
|
||||
|
||||
### 🏥 System & Health
|
||||
<div style="background: #f8f9fa; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
@@ -90,124 +92,73 @@ tito system doctor
|
||||
```
|
||||
*Diagnose environment issues before they block you*
|
||||
|
||||
**Module Status**
|
||||
**System Info**
|
||||
```bash
|
||||
tito module status
|
||||
tito system info
|
||||
```
|
||||
*See all available modules and your completion status*
|
||||
*View configuration details*
|
||||
|
||||
</div>
|
||||
|
||||
### 📊 Progress Tracking
|
||||
### 🔨 Module Management
|
||||
<div style="background: #f8f9fa; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
|
||||
**Export Module to Package (Essential)**
|
||||
```bash
|
||||
tito module complete MODULE_NUMBER
|
||||
```
|
||||
*Export your implementation to the TinyTorch package - the key command in the workflow*
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
tito module complete 05 # Export Module 05 (Autograd)
|
||||
```
|
||||
|
||||
After exporting, your code is importable:
|
||||
```python
|
||||
from tinytorch.autograd import backward # YOUR implementation!
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
### 📊 Progress Tracking (Optional)
|
||||
<div style="background: #f8f9fa; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
|
||||
**Capability Overview**
|
||||
```bash
|
||||
tito checkpoint status
|
||||
```
|
||||
*Quick view of your 16 core capabilities*
|
||||
*Quick view of your capabilities (optional tracking)*
|
||||
|
||||
**Detailed Progress**
|
||||
```bash
|
||||
tito checkpoint status --detailed
|
||||
```
|
||||
*Module-by-module breakdown with test status*
|
||||
*Module-by-module breakdown*
|
||||
|
||||
**Visual Timeline**
|
||||
```bash
|
||||
tito checkpoint timeline
|
||||
```
|
||||
*See your learning journey in beautiful visual format*
|
||||
|
||||
</div>
|
||||
|
||||
### 🔨 Module Development
|
||||
<div style="background: #f8f9fa; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
|
||||
**Start Working**
|
||||
```bash
|
||||
tito module work 05_dense
|
||||
```
|
||||
*Open module and start building*
|
||||
|
||||
**Export to Package**
|
||||
```bash
|
||||
tito module complete 05_dense
|
||||
```
|
||||
*Export your code to the TinyTorch package + run capability test*
|
||||
|
||||
**Quick Export (No Test)**
|
||||
```bash
|
||||
tito module export 05_dense
|
||||
```
|
||||
*Export without running capability tests*
|
||||
|
||||
</div>
|
||||
|
||||
### 🧪 Testing & Validation
|
||||
<div style="background: #f8f9fa; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
*See your learning journey in visual format*
|
||||
|
||||
**Test Specific Capability**
|
||||
```bash
|
||||
tito checkpoint test 03
|
||||
tito checkpoint test CHECKPOINT_NUMBER
|
||||
```
|
||||
*Verify you've mastered a specific capability*
|
||||
|
||||
**Run Checkpoint with Details**
|
||||
```bash
|
||||
tito checkpoint run 03 --verbose
|
||||
```
|
||||
*See detailed output of capability validation*
|
||||
|
||||
</div>
|
||||
|
||||
## 🎓 Learning Stages & Commands
|
||||
|
||||
### Stage 1: Foundation (Modules 1-4)
|
||||
**Key Commands:**
|
||||
- `tito module work 01_setup` → `tito module complete 01_setup`
|
||||
- `tito checkpoint test 00` (Environment)
|
||||
- `tito checkpoint test 01` (Foundation)
|
||||
|
||||
### Stage 2: Core Learning (Modules 5-8)
|
||||
**Key Commands:**
|
||||
- `tito checkpoint status` (Track your capabilities)
|
||||
- `tito checkpoint timeline` (Visual progress)
|
||||
- Complete modules 5-8 systematically
|
||||
|
||||
### Stage 3: Advanced Systems (Modules 9+)
|
||||
**Key Commands:**
|
||||
- `tito checkpoint timeline --horizontal` (Linear view)
|
||||
- Focus on systems optimization modules
|
||||
- Use `tito checkpoint test XX` for validation
|
||||
|
||||
## 👩🏫 Instructor Commands (NBGrader)
|
||||
|
||||
For instructors managing the course:
|
||||
## 👩🏫 Instructor Commands (Coming Soon)
|
||||
|
||||
<div style="background: #f3e5f5; padding: 1rem; border-radius: 0.25rem; margin: 1rem 0;">
|
||||
|
||||
**Setup Course:**
|
||||
```bash
|
||||
tito nbgrader init # Initialize NBGrader environment
|
||||
tito nbgrader status # Check assignment status
|
||||
```
|
||||
TinyTorch includes NBGrader integration for classroom use. Full documentation for instructor workflows (assignment generation, autograding, etc.) will be available in future releases.
|
||||
|
||||
**Manage Assignments:**
|
||||
```bash
|
||||
tito nbgrader generate 01_setup # Create assignment from module
|
||||
tito nbgrader release 01_setup # Release to students
|
||||
tito nbgrader collect 01_setup # Collect submissions
|
||||
tito nbgrader autograde 01_setup # Automatic grading
|
||||
```
|
||||
**For now, focus on the student workflow**: edit modules → export → validate with milestones.
|
||||
|
||||
**Reports & Export:**
|
||||
```bash
|
||||
tito nbgrader report # Generate grade report
|
||||
tito nbgrader export # Export grades to CSV
|
||||
```
|
||||
|
||||
*For detailed instructor workflow, see [Instructor Guide](usage-paths/classroom-use.html)*
|
||||
*For current instructor capabilities, see [Classroom Use Guide](usage-paths/classroom-use.html)*
|
||||
|
||||
</div>
|
||||
|
||||
@@ -223,13 +174,7 @@ tito system doctor # Diagnose problems
|
||||
tito system info # Show configuration details
|
||||
```
|
||||
|
||||
**Module Problems:**
|
||||
```bash
|
||||
tito module status # Check what's available
|
||||
tito module info 02_tensor # Get specific module details
|
||||
```
|
||||
|
||||
**Progress Confusion:**
|
||||
**Progress Tracking (Optional):**
|
||||
```bash
|
||||
tito checkpoint status --detailed # See exactly where you are
|
||||
tito checkpoint timeline # Visualize your progress
|
||||
@@ -237,27 +182,6 @@ tito checkpoint timeline # Visualize your progress
|
||||
|
||||
</div>
|
||||
|
||||
## 🎯 Pro Tips for Efficiency
|
||||
|
||||
<div style="display: grid; grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); gap: 1rem; margin: 2rem 0;">
|
||||
|
||||
<div style="background: #e6fffa; padding: 1rem; border-radius: 0.5rem; border-left: 3px solid #26d0ce;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #0d9488;">🔥 Hot Tip</h4>
|
||||
<p style="margin: 0; font-size: 0.9rem;">Use tab completion! Type `tito mod` + TAB to auto-complete commands</p>
|
||||
</div>
|
||||
|
||||
<div style="background: #f0f9ff; padding: 1rem; border-radius: 0.5rem; border-left: 3px solid #3b82f6;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #1d4ed8;">⚡ Speed Boost</h4>
|
||||
<p style="margin: 0; font-size: 0.9rem;">Alias common commands: `alias ts='tito checkpoint status'`</p>
|
||||
</div>
|
||||
|
||||
<div style="background: #fefce8; padding: 1rem; border-radius: 0.5rem; border-left: 3px solid #eab308;">
|
||||
<h4 style="margin: 0 0 0.5rem 0; color: #a16207;">🎯 Focus</h4>
|
||||
<p style="margin: 0; font-size: 0.9rem;">Always run `tito system doctor` first when starting a new session</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
## 🚀 Ready to Build?
|
||||
|
||||
<div style="background: #f8f9fa; padding: 2rem; border-radius: 0.5rem; margin: 2rem 0; text-align: center;">
|
||||
|
||||
Reference in New Issue
Block a user