mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-06-03 14:37:10 -05:00
4d70e308ff
- Standardize import structure following TinyTorch dependency chain - Enhance section organization with 6 clear educational sections - Add comprehensive ASCII diagrams matching tokenization patterns - Improve code organization and function naming consistency - Strengthen systems analysis and performance documentation - Align package integration documentation with module standards 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
193 lines
8.2 KiB
Markdown
193 lines
8.2 KiB
Markdown
# Quick Start Guide
|
|
|
|
<div style="background: #f8f9fa; padding: 2rem; border-radius: 0.5rem; margin: 2rem 0; text-align: center;">
|
|
<h2 style="margin: 0 0 1rem 0; color: #495057;">From Zero to Building Neural Networks</h2>
|
|
<p style="margin: 0; font-size: 1.1rem; color: #6c757d;">Complete setup + first module in 15 minutes</p>
|
|
</div>
|
|
|
|
**Purpose**: Get hands-on experience building ML systems in 15 minutes. Complete setup verification and build your first neural network component from scratch.
|
|
|
|
## ⚡ 2-Minute Setup Verification
|
|
|
|
Let's make sure you're ready to build ML systems:
|
|
|
|
<div style="background: #e3f2fd; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #2196f3; margin: 1.5rem 0;">
|
|
<h4 style="margin: 0 0 1rem 0; color: #1976d2;">Step 1: Install & Verify</h4>
|
|
|
|
```bash
|
|
# Clone and install
|
|
git clone https://github.com/veekaybee/tinytorch.git
|
|
cd tinytorch
|
|
pip install -e .
|
|
```
|
|
|
|
**Expected output:** A working TinyTorch development environment ready for hands-on building.
|
|
|
|
**📖 See [Essential Commands](tito-essentials.html)** for complete setup verification and troubleshooting.
|
|
|
|
</div>
|
|
|
|
<div style="background: #f0fdf4; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #22c55e; margin: 1.5rem 0;">
|
|
<h4 style="margin: 0 0 1rem 0; color: #15803d;">Step 2: Verify Your Starting Point</h4>
|
|
|
|
Confirm you're ready to begin building ML systems from scratch. Your development environment should be configured and ready for hands-on implementation.
|
|
|
|
**📖 See [Essential Commands](tito-essentials.html)** for verification commands and troubleshooting.
|
|
|
|
</div>
|
|
|
|
## 🏗️ 15-Minute First Module Walkthrough
|
|
|
|
Let's build your first neural network component and unlock your first capability:
|
|
|
|
### Module 01: Tensor Foundations
|
|
|
|
<div style="background: #fffbeb; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #f59e0b; margin: 1.5rem 0;">
|
|
|
|
**🎯 Learning Goal:** Build N-dimensional arrays - the foundation of all neural networks
|
|
|
|
**⏱️ Time:** 15 minutes
|
|
|
|
**💻 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
|
|
```
|
|
|
|
You'll implement core tensor operations:
|
|
- N-dimensional array creation
|
|
- Basic mathematical operations (add, multiply, matmul)
|
|
- Shape manipulation (reshape, transpose)
|
|
- Memory layout understanding
|
|
|
|
**Key Implementation:** Build the `Tensor` class that forms the foundation of all neural networks
|
|
|
|
**📖 See [Essential Commands](tito-essentials.html)** for module workflow commands.
|
|
|
|
**✅ Achievement Unlocked:** Foundation capability - "Can I create and manipulate the building blocks of ML?"
|
|
|
|
</div>
|
|
|
|
### Next Step: Module 02 - Activations
|
|
|
|
<div style="background: #fdf2f8; padding: 1.5rem; border-radius: 0.5rem; border-left: 4px solid #ec4899; margin: 1.5rem 0;">
|
|
|
|
**🎯 Learning Goal:** Add nonlinearity - the key to neural network intelligence
|
|
|
|
**⏱️ Time:** 10 minutes
|
|
|
|
**💻 Action:** Continue with Module 02 to add activation functions.
|
|
|
|
You'll implement essential activation functions:
|
|
- ReLU (Rectified Linear Unit) - the workhorse of deep learning
|
|
- Softmax - for probability distributions
|
|
- Understand gradient flow and numerical stability
|
|
- Learn why nonlinearity enables learning
|
|
|
|
**Key Implementation:** Build activation functions that allow neural networks to learn complex patterns
|
|
|
|
**📖 See [Essential Commands](tito-essentials.html)** for module development workflow.
|
|
|
|
**✅ Achievement Unlocked:** Intelligence capability - "Can I add nonlinearity to enable learning?"
|
|
|
|
</div>
|
|
|
|
## 📊 Track Your Progress
|
|
|
|
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.
|
|
|
|
**📖 See [Track Your Progress](learning-progress.html)** for detailed capability tracking and [Essential Commands](tito-essentials.html)** for progress monitoring commands.
|
|
|
|
</div>
|
|
|
|
## 🏆 Unlock Historical Milestones
|
|
|
|
As you progress, **prove what you've built** by recreating history's greatest ML breakthroughs:
|
|
|
|
<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! 🎯
|
|
|
|
**📖 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!
|
|
|
|
## 🎯 What You Just Accomplished
|
|
|
|
In 15 minutes, you've:
|
|
|
|
<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;">🔧 Setup Complete</h4>
|
|
<p style="margin: 0; font-size: 0.9rem;">Installed TinyTorch and verified your environment</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;">🧱 Created Foundation</h4>
|
|
<p style="margin: 0; font-size: 0.9rem;">Implemented core tensor operations from scratch</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;">🏆 First Capability</h4>
|
|
<p style="margin: 0; font-size: 0.9rem;">Earned your first ML systems capability checkpoint</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
## 🚀 Your Next Steps
|
|
|
|
<div style="background: #f8f9fa; padding: 2rem; border-radius: 0.5rem; margin: 2rem 0;">
|
|
|
|
### Immediate Next Actions (Choose One):
|
|
|
|
**🔥 Continue Building (Recommended):** Begin Module 03 to add intelligence to your network with nonlinear activation functions.
|
|
|
|
**📚 Learn the Workflow:**
|
|
- **📖 See [Essential Commands](tito-essentials.html)** for complete TITO command guide
|
|
- **📖 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
|
|
|
|
</div>
|
|
|
|
## 💡 Pro Tips for Continued Success
|
|
|
|
<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
|
|
|
|
**📖 See [Essential Commands](tito-essentials.html)** for complete workflow commands and troubleshooting guide.
|
|
|
|
</div>
|
|
|
|
## 🌟 You're Now a TinyTorch Builder!
|
|
|
|
<div style="background: #f8f9fa; padding: 2rem; border-radius: 0.5rem; margin: 2rem 0; text-align: center;">
|
|
<h3 style="margin: 0 0 1rem 0; color: #495057;">Ready to Build Production ML Systems</h3>
|
|
<p style="margin: 0 0 1.5rem 0; color: #6c757d;">You've proven you can build ML components from scratch. Time to keep going!</p>
|
|
<a href="chapters/03-activations.html" style="display: inline-block; background: #007bff; color: white; padding: 0.75rem 1.5rem; border-radius: 0.25rem; text-decoration: none; font-weight: 500; margin-right: 1rem;">Continue Building →</a>
|
|
<a href="tito-essentials.html" style="display: inline-block; background: #28a745; color: white; padding: 0.75rem 1.5rem; border-radius: 0.25rem; text-decoration: none; font-weight: 500;">Master Commands →</a>
|
|
</div>
|
|
|
|
---
|
|
|
|
**What makes TinyTorch different:** You're not just learning *about* neural networks—you're building them from fundamental mathematical operations. Every line of code you write builds toward complete ML systems mastery.
|
|
|
|
**Next milestone:** After Module 08, you'll train real neural networks on actual datasets using 100% your own code! |