mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-07-19 18:14:33 -05:00
- Remove circular imports where modules imported from themselves - Convert tinytorch.core imports to sys.path relative imports - Only import dependencies that are actually used in each module - Preserve documentation imports in markdown cells - Use consistent relative path pattern across all modules - Remove hardcoded absolute paths in favor of relative imports Affected modules: 02_activations, 03_layers, 04_losses, 06_optimizers, 07_training, 09_spatial, 12_attention, 17_quantization
48 KiB
48 KiB
In [ ]:
#| default_exp core.training
import numpy as np
import pickle
import time
from typing import Dict, List, Optional, Tuple, Any, Callable
from pathlib import PathIn [ ]:
class CosineSchedule:
"""
Cosine annealing learning rate schedule.
Starts at max_lr, decreases following a cosine curve to min_lr over T epochs.
This provides aggressive learning initially, then fine-tuning at the end.
TODO: Implement cosine annealing schedule
APPROACH:
1. Store max_lr, min_lr, and total_epochs
2. In get_lr(), compute cosine factor: (1 + cos(π * epoch / total_epochs)) / 2
3. Interpolate: min_lr + (max_lr - min_lr) * cosine_factor
EXAMPLE:
>>> schedule = CosineSchedule(max_lr=0.1, min_lr=0.01, total_epochs=100)
>>> print(schedule.get_lr(0)) # Start: 0.1
>>> print(schedule.get_lr(50)) # Middle: ~0.055
>>> print(schedule.get_lr(100)) # End: 0.01
HINT: Use np.cos() and np.pi for the cosine calculation
"""
### BEGIN SOLUTION
def __init__(self, max_lr: float = 0.1, min_lr: float = 0.01, total_epochs: int = 100):
self.max_lr = max_lr
self.min_lr = min_lr
self.total_epochs = total_epochs
def get_lr(self, epoch: int) -> float:
"""Get learning rate for current epoch."""
if epoch >= self.total_epochs:
return self.min_lr
# Cosine annealing formula
cosine_factor = (1 + np.cos(np.pi * epoch / self.total_epochs)) / 2
return self.min_lr + (self.max_lr - self.min_lr) * cosine_factor
### END SOLUTIONIn [ ]:
def test_unit_cosine_schedule():
"""🔬 Test CosineSchedule implementation."""
print("🔬 Unit Test: CosineSchedule...")
# Test basic schedule
schedule = CosineSchedule(max_lr=0.1, min_lr=0.01, total_epochs=100)
# Test start, middle, and end
lr_start = schedule.get_lr(0)
lr_middle = schedule.get_lr(50)
lr_end = schedule.get_lr(100)
print(f"Learning rate at epoch 0: {lr_start:.4f}")
print(f"Learning rate at epoch 50: {lr_middle:.4f}")
print(f"Learning rate at epoch 100: {lr_end:.4f}")
# Validate behavior
assert abs(lr_start - 0.1) < 1e-6, f"Expected 0.1 at start, got {lr_start}"
assert abs(lr_end - 0.01) < 1e-6, f"Expected 0.01 at end, got {lr_end}"
assert 0.01 < lr_middle < 0.1, f"Middle LR should be between min and max, got {lr_middle}"
# Test monotonic decrease in first half
lr_quarter = schedule.get_lr(25)
assert lr_quarter > lr_middle, "LR should decrease monotonically in first half"
print("✅ CosineSchedule works correctly!")
if __name__ == "__main__":
test_unit_cosine_schedule()In [ ]:
def clip_grad_norm(parameters: List, max_norm: float = 1.0) -> float:
"""
Clip gradients by global norm to prevent exploding gradients.
This is crucial for training stability, especially with RNNs and deep networks.
Instead of clipping each gradient individually, we compute the global norm
across all parameters and scale uniformly if needed.
TODO: Implement gradient clipping by global norm
APPROACH:
1. Compute total norm: sqrt(sum of squared gradients across all parameters)
2. If total_norm > max_norm, compute clip_coef = max_norm / total_norm
3. Scale all gradients by clip_coef: grad *= clip_coef
4. Return the original norm for monitoring
EXAMPLE:
>>> params = [Tensor([1, 2, 3], requires_grad=True)]
>>> params[0].grad = Tensor([10, 20, 30]) # Large gradients
>>> original_norm = clip_grad_norm(params, max_norm=1.0)
>>> print(f"Clipped norm: {np.linalg.norm(params[0].grad.data):.2f}") # Should be ≤ 1.0
HINTS:
- Use np.linalg.norm() to compute norms
- Only clip if total_norm > max_norm
- Modify gradients in-place for efficiency
"""
### BEGIN SOLUTION
if not parameters:
return 0.0
# Collect all gradients and compute global norm
total_norm = 0.0
for param in parameters:
if hasattr(param, 'grad') and param.grad is not None:
# Handle both Tensor gradients and numpy array gradients
if isinstance(param.grad, np.ndarray):
grad_data = param.grad
elif hasattr(param.grad, 'data'):
grad_data = param.grad.data
else:
grad_data = np.array(param.grad)
total_norm += np.sum(grad_data ** 2)
total_norm = np.sqrt(total_norm)
# Clip if necessary
if total_norm > max_norm:
clip_coef = max_norm / total_norm
for param in parameters:
if hasattr(param, 'grad') and param.grad is not None:
# Handle both Tensor gradients and numpy array gradients
if isinstance(param.grad, np.ndarray):
param.grad = param.grad * clip_coef
elif hasattr(param.grad, 'data'):
param.grad.data = param.grad.data * clip_coef
else:
param.grad = param.grad * clip_coef
return float(total_norm)
### END SOLUTIONIn [ ]:
def test_unit_clip_grad_norm():
"""🔬 Test clip_grad_norm implementation."""
print("🔬 Unit Test: Gradient Clipping...")
# Use real Tensor from Module 01
import sys
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/01_tensor')
from tensor_dev import Tensor
# Test case 1: Large gradients that need clipping
param1 = Tensor([1.0, 2.0], requires_grad=True)
param1.grad = np.array([3.0, 4.0]) # norm = 5.0
param2 = Tensor([3.0, 4.0], requires_grad=True)
param2.grad = np.array([6.0, 8.0]) # norm = 10.0
params = [param1, param2]
# Total norm = sqrt(5² + 10²) = sqrt(125) ≈ 11.18
original_norm = clip_grad_norm(params, max_norm=1.0)
# Check original norm was large
assert original_norm > 1.0, f"Original norm should be > 1.0, got {original_norm}"
# Check gradients were clipped
new_norm = 0.0
for param in params:
if isinstance(param.grad, np.ndarray):
grad_data = param.grad
elif hasattr(param.grad, 'data'):
grad_data = param.grad.data
else:
grad_data = np.array(param.grad)
new_norm += np.sum(grad_data ** 2)
new_norm = np.sqrt(new_norm)
print(f"Original norm: {original_norm:.2f}")
print(f"Clipped norm: {new_norm:.2f}")
assert abs(new_norm - 1.0) < 1e-6, f"Clipped norm should be 1.0, got {new_norm}"
# Test case 2: Small gradients that don't need clipping
small_param = Tensor([1.0, 2.0], requires_grad=True)
small_param.grad = np.array([0.1, 0.2])
small_params = [small_param]
original_small = clip_grad_norm(small_params, max_norm=1.0)
assert original_small < 1.0, "Small gradients shouldn't be clipped"
print("✅ Gradient clipping works correctly!")
if __name__ == "__main__":
test_unit_clip_grad_norm()In [ ]:
class Trainer:
"""
Complete training orchestrator for neural networks.
Handles the full training lifecycle: forward pass, loss computation,
backward pass, optimization, scheduling, checkpointing, and evaluation.
This is the central class that brings together all the components
you've built in previous modules.
TODO: Implement complete Trainer class
APPROACH:
1. Store model, optimizer, loss function, and optional scheduler
2. train_epoch(): Loop through data, compute loss, update parameters
3. evaluate(): Similar loop but without gradient updates
4. save/load_checkpoint(): Persist training state for resumption
DESIGN PATTERNS:
- Context managers for train/eval modes
- Gradient accumulation for effective large batch sizes
- Progress tracking for monitoring
- Flexible scheduling integration
"""
### BEGIN SOLUTION
def __init__(self, model, optimizer, loss_fn, scheduler=None, grad_clip_norm=None):
"""
Initialize trainer with model and training components.
Args:
model: Neural network to train
optimizer: Parameter update strategy (SGD, Adam, etc.)
loss_fn: Loss function (CrossEntropy, MSE, etc.)
scheduler: Optional learning rate scheduler
grad_clip_norm: Optional gradient clipping threshold
"""
self.model = model
self.optimizer = optimizer
self.loss_fn = loss_fn
self.scheduler = scheduler
self.grad_clip_norm = grad_clip_norm
# Training state
self.epoch = 0
self.step = 0
self.training_mode = True
# History tracking
self.history = {
'train_loss': [],
'eval_loss': [],
'learning_rates': []
}
def train_epoch(self, dataloader, accumulation_steps=1):
"""
Train for one epoch through the dataset.
Args:
dataloader: Iterable yielding (inputs, targets) batches
accumulation_steps: Number of batches to accumulate before update
Returns:
Average loss for the epoch
"""
self.model.training = True
self.training_mode = True
total_loss = 0.0
num_batches = 0
accumulated_loss = 0.0
for batch_idx, (inputs, targets) in enumerate(dataloader):
# Forward pass
outputs = self.model.forward(inputs)
loss = self.loss_fn.forward(outputs, targets)
# Scale loss for accumulation
scaled_loss = loss.data / accumulation_steps
accumulated_loss += scaled_loss
# Backward pass
if hasattr(loss, 'backward'):
loss.backward()
# Update parameters every accumulation_steps
if (batch_idx + 1) % accumulation_steps == 0:
# Gradient clipping
if self.grad_clip_norm is not None:
params = []
if hasattr(self.model, 'parameters'):
params = self.model.parameters()
clip_grad_norm(params, self.grad_clip_norm)
# Optimizer step
self.optimizer.step()
self.optimizer.zero_grad()
total_loss += accumulated_loss
accumulated_loss = 0.0
num_batches += 1
self.step += 1
# Handle remaining accumulated gradients
if accumulated_loss > 0:
if self.grad_clip_norm is not None:
params = []
if hasattr(self.model, 'parameters'):
params = self.model.parameters()
clip_grad_norm(params, self.grad_clip_norm)
self.optimizer.step()
self.optimizer.zero_grad()
total_loss += accumulated_loss
num_batches += 1
avg_loss = total_loss / max(num_batches, 1)
self.history['train_loss'].append(avg_loss)
# Update scheduler
if self.scheduler is not None:
current_lr = self.scheduler.get_lr(self.epoch)
# Update optimizer learning rate
if hasattr(self.optimizer, 'lr'):
self.optimizer.lr = current_lr
self.history['learning_rates'].append(current_lr)
self.epoch += 1
return avg_loss
def evaluate(self, dataloader):
"""
Evaluate model on dataset without updating parameters.
Args:
dataloader: Iterable yielding (inputs, targets) batches
Returns:
Average loss and accuracy
"""
self.model.training = False
self.training_mode = False
total_loss = 0.0
correct = 0
total = 0
for inputs, targets in dataloader:
# Forward pass only
outputs = self.model.forward(inputs)
loss = self.loss_fn.forward(outputs, targets)
total_loss += loss.data
# Calculate accuracy (for classification)
if hasattr(outputs, 'data') and hasattr(targets, 'data'):
if len(outputs.data.shape) > 1: # Multi-class
predictions = np.argmax(outputs.data, axis=1)
if len(targets.data.shape) == 1: # Integer targets
correct += np.sum(predictions == targets.data)
else: # One-hot targets
correct += np.sum(predictions == np.argmax(targets.data, axis=1))
total += len(predictions)
avg_loss = total_loss / len(dataloader) if len(dataloader) > 0 else 0.0
accuracy = correct / total if total > 0 else 0.0
self.history['eval_loss'].append(avg_loss)
return avg_loss, accuracy
def save_checkpoint(self, path: str):
"""
Save complete training state for resumption.
Args:
path: File path to save checkpoint
"""
checkpoint = {
'epoch': self.epoch,
'step': self.step,
'model_state': self._get_model_state(),
'optimizer_state': self._get_optimizer_state(),
'scheduler_state': self._get_scheduler_state(),
'history': self.history,
'training_mode': self.training_mode
}
Path(path).parent.mkdir(parents=True, exist_ok=True)
with open(path, 'wb') as f:
pickle.dump(checkpoint, f)
def load_checkpoint(self, path: str):
"""
Load training state from checkpoint.
Args:
path: File path to load checkpoint from
"""
with open(path, 'rb') as f:
checkpoint = pickle.load(f)
self.epoch = checkpoint['epoch']
self.step = checkpoint['step']
self.history = checkpoint['history']
self.training_mode = checkpoint['training_mode']
# Restore states (simplified for educational purposes)
if 'model_state' in checkpoint:
self._set_model_state(checkpoint['model_state'])
if 'optimizer_state' in checkpoint:
self._set_optimizer_state(checkpoint['optimizer_state'])
if 'scheduler_state' in checkpoint:
self._set_scheduler_state(checkpoint['scheduler_state'])
def _get_model_state(self):
"""Extract model parameters for checkpointing."""
if hasattr(self.model, 'parameters'):
return {i: param.data.copy() for i, param in enumerate(self.model.parameters())}
return {}
def _set_model_state(self, state):
"""Restore model parameters from checkpoint."""
if hasattr(self.model, 'parameters'):
for i, param in enumerate(self.model.parameters()):
if i in state:
param.data = state[i].copy()
def _get_optimizer_state(self):
"""Extract optimizer state for checkpointing."""
state = {}
if hasattr(self.optimizer, 'lr'):
state['lr'] = self.optimizer.lr
if hasattr(self.optimizer, 'momentum_buffers'):
state['momentum_buffers'] = self.optimizer.momentum_buffers.copy()
return state
def _set_optimizer_state(self, state):
"""Restore optimizer state from checkpoint."""
if 'lr' in state and hasattr(self.optimizer, 'lr'):
self.optimizer.lr = state['lr']
if 'momentum_buffers' in state and hasattr(self.optimizer, 'momentum_buffers'):
self.optimizer.momentum_buffers = state['momentum_buffers']
def _get_scheduler_state(self):
"""Extract scheduler state for checkpointing."""
if self.scheduler is None:
return None
return {
'max_lr': getattr(self.scheduler, 'max_lr', None),
'min_lr': getattr(self.scheduler, 'min_lr', None),
'total_epochs': getattr(self.scheduler, 'total_epochs', None)
}
def _set_scheduler_state(self, state):
"""Restore scheduler state from checkpoint."""
if state is None or self.scheduler is None:
return
for key, value in state.items():
if hasattr(self.scheduler, key):
setattr(self.scheduler, key, value)
### END SOLUTIONIn [ ]:
def test_unit_trainer():
"""🔬 Test Trainer implementation."""
print("🔬 Unit Test: Trainer...")
# Create mock components for testing
# Use REAL components from previous modules - no mocks!
import sys
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/01_tensor')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/03_layers')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/04_losses')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/06_optimizers')
from tensor_dev import Tensor
from layers_dev import Linear
from losses_dev import MSELoss
from optimizers_dev import SGD
# Create a simple model using REAL Linear layer
class SimpleModel:
def __init__(self):
self.layer = Linear(2, 1) # Real Linear from Module 03
self.training = True
def forward(self, x):
return self.layer.forward(x)
def parameters(self):
return self.layer.parameters()
# Create trainer with REAL components
model = SimpleModel()
optimizer = SGD(model.parameters(), lr=0.01) # Real SGD from Module 06
loss_fn = MSELoss() # Real MSELoss from Module 04
scheduler = CosineSchedule(max_lr=0.1, min_lr=0.01, total_epochs=10)
trainer = Trainer(model, optimizer, loss_fn, scheduler, grad_clip_norm=1.0)
# Test training
print("Testing training epoch...")
# Use real Tensors for data
dataloader = [
(Tensor([[1.0, 0.5]]), Tensor([[2.0]])),
(Tensor([[0.5, 1.0]]), Tensor([[1.5]]))
]
loss = trainer.train_epoch(dataloader)
assert isinstance(loss, (float, np.floating)), f"Expected float loss, got {type(loss)}"
assert trainer.epoch == 1, f"Expected epoch 1, got {trainer.epoch}"
# Test evaluation
print("Testing evaluation...")
eval_loss, accuracy = trainer.evaluate(dataloader)
assert isinstance(eval_loss, (float, np.floating)), f"Expected float eval_loss, got {type(eval_loss)}"
assert isinstance(accuracy, (float, np.floating)), f"Expected float accuracy, got {type(accuracy)}"
# Test checkpointing
print("Testing checkpointing...")
checkpoint_path = "/tmp/test_checkpoint.pkl"
trainer.save_checkpoint(checkpoint_path)
# Modify trainer state
original_epoch = trainer.epoch
trainer.epoch = 999
# Load checkpoint
trainer.load_checkpoint(checkpoint_path)
assert trainer.epoch == original_epoch, f"Checkpoint didn't restore epoch correctly"
# Clean up
import os
if os.path.exists(checkpoint_path):
os.remove(checkpoint_path)
print(f"✅ Trainer works correctly! Final loss: {loss:.4f}")
if __name__ == "__main__":
test_unit_trainer()In [ ]:
def test_module():
"""
Comprehensive test of entire module functionality.
This final test runs before module summary to ensure:
- All unit tests pass
- Functions work together correctly
- Module is ready for integration with TinyTorch
"""
print("🧪 RUNNING MODULE INTEGRATION TEST")
print("=" * 50)
# Run all unit tests
print("Running unit tests...")
test_unit_cosine_schedule()
test_unit_clip_grad_norm()
test_unit_trainer()
print("\nRunning integration scenarios...")
# Test complete training pipeline integration with REAL components
print("🔬 Integration Test: Complete Training Pipeline...")
# Use REAL components from previous modules
import sys
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/01_tensor')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/03_layers')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/04_losses')
sys.path.append('/Users/VJ/GitHub/TinyTorch/modules/06_optimizers')
from tensor_dev import Tensor
from layers_dev import Linear
from losses_dev import MSELoss
from optimizers_dev import SGD
# Create a simple model using REAL Linear layer
class SimpleModel:
def __init__(self):
self.layer = Linear(2, 1) # Real Linear from Module 03
self.training = True
def forward(self, x):
return self.layer.forward(x)
def parameters(self):
return self.layer.parameters()
# Create integrated system with REAL components
model = SimpleModel()
optimizer = SGD(model.parameters(), lr=0.01) # Real SGD from Module 06
loss_fn = MSELoss() # Real MSELoss from Module 04
scheduler = CosineSchedule(max_lr=0.1, min_lr=0.001, total_epochs=3)
trainer = Trainer(
model=model,
optimizer=optimizer,
loss_fn=loss_fn,
scheduler=scheduler,
grad_clip_norm=0.5
)
# Test data using REAL Tensors
data = [
(Tensor([[1.0, 0.5]]), Tensor([[0.8]])),
(Tensor([[0.5, 1.0]]), Tensor([[0.2]]))
]
# Test training
initial_loss = trainer.train_epoch(data)
assert isinstance(initial_loss, (float, np.floating)), "Training should return float loss"
assert trainer.epoch == 1, "Epoch should increment"
# Test evaluation
eval_loss, accuracy = trainer.evaluate(data)
assert isinstance(eval_loss, (float, np.floating)), "Evaluation should return float loss"
assert isinstance(accuracy, (float, np.floating)), "Evaluation should return float accuracy"
# Test scheduling
lr_epoch_0 = scheduler.get_lr(0)
lr_epoch_1 = scheduler.get_lr(1)
assert lr_epoch_0 > lr_epoch_1, "Learning rate should decrease"
# Test gradient clipping with large gradients using real Tensor
large_param = Tensor([1.0, 2.0], requires_grad=True)
large_param.grad = np.array([100.0, 200.0])
large_params = [large_param]
original_norm = clip_grad_norm(large_params, max_norm=1.0)
assert original_norm > 1.0, "Original norm should be large"
if isinstance(large_params[0].grad, np.ndarray):
grad_data = large_params[0].grad
elif hasattr(large_params[0].grad, 'data'):
grad_data = large_params[0].grad.data
else:
grad_data = np.array(large_params[0].grad)
new_norm = np.linalg.norm(grad_data)
assert abs(new_norm - 1.0) < 1e-6, "Clipped norm should equal max_norm"
# Test checkpointing
checkpoint_path = "/tmp/integration_test_checkpoint.pkl"
trainer.save_checkpoint(checkpoint_path)
original_epoch = trainer.epoch
trainer.epoch = 999
trainer.load_checkpoint(checkpoint_path)
assert trainer.epoch == original_epoch, "Checkpoint should restore state"
# Clean up
import os
if os.path.exists(checkpoint_path):
os.remove(checkpoint_path)
print("✅ End-to-end training pipeline works!")
print("\n" + "=" * 50)
print("🎉 ALL TESTS PASSED! Module ready for export.")
print("Run: tito module complete 07")
# test_module() # Moved to main guardIn [ ]:
# Run comprehensive module test
if __name__ == "__main__":
test_module()