mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-09 12:12:09 -05:00

Files

Vijay Janapa Reddi 90581b23c0 Update test suite for module restructuring

Updated test imports and paths after modules/source/ removal:
- Progressive integration tests for modules 03, 06, 08, 13, 14
- Checkpoint integration tests
- Module completion orchestrator
- Optimizer integration tests
- Gradient flow regression tests

Updated test documentation:
- tests/README.md with new module paths
- tests/TEST_STRATEGY.md with restructuring notes

All tests now reference modules/XX_name/ instead of modules/source/.

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

3.2 KiB

Raw Permalink Blame History

TinyTorch Test Suite

Comprehensive testing organized by purpose and scope.

Test Organization

📦 Module Tests (`XX_modulename/`)

Purpose: Test individual module functionality
Scope: Single module, isolated behavior
Example: 01_tensor/test_progressive_integration.py

These tests validate that each module works correctly in isolation.

🔗 Integration Tests (`integration/`)

Purpose: Test cross-module interactions
Scope: Multiple modules working together
Files:

test_gradient_flow.py - CRITICAL: Validates gradients flow through entire training stack
test_end_to_end_training.py - Full training loops (TODO)
test_module_compatibility.py - Module interfaces (TODO)

Why this matters:

Catches bugs that unit tests miss
Validates the "seams" between modules
Ensures training actually works end-to-end

🐛 Debugging Tests (`debugging/`)

Purpose: Catch common student pitfalls
Scope: Pedagogical - teaches debugging
Files:

test_gradient_vanishing.py - Detect/diagnose vanishing gradients (TODO)
test_gradient_explosion.py - Detect/diagnose exploding gradients (TODO)
test_common_mistakes.py - "Did you forget backward()?" style tests (TODO)

Philosophy: When these tests fail, the error message should teach the student what went wrong and how to fix it.

⚡ Autograd Edge Cases (`05_autograd/`)

Purpose: Stress-test autograd system
Scope: Autograd internals and edge cases
Files:

test_broadcasting.py - Broadcasting gradient bugs (TODO)
test_computation_graph.py - Graph construction edge cases (TODO)
test_backward_edge_cases.py - Numerical stability, etc. (TODO)

Running Tests

All tests

pytest tests/ -v

Integration tests only (recommended for debugging training issues)

pytest tests/integration/ -v

Specific test

pytest tests/integration/test_gradient_flow.py -v

Run without pytest

python tests/integration/test_gradient_flow.py

Test Philosophy

Integration tests catch real bugs: The gradient flow test caught the exact bugs that prevented training
Descriptive names: Test names should explain what they test
Good error messages: When tests fail, students should understand why
Pedagogical value: Tests teach correct usage patterns

Adding New Tests

When adding a test, ask:

Is it testing one module? → Put in XX_modulename/
Is it testing modules working together? → Put in integration/
Is it teaching debugging? → Put in debugging/
Is it an autograd edge case? → Put in 05_autograd/

Most Important Tests

🔥 Must pass before merging:

integration/test_gradient_flow.py - If this fails, training is broken

📚 Module validation:

Each module's inline tests (in modules/)
Module-specific tests in tests/XX_modulename/

Test Coverage Goals

✅ All tensor operations have gradient tests
✅ All layers compute gradients correctly
✅ All activations integrate with autograd
✅ All loss functions compute gradients
✅ All optimizers update parameters
⏳ End-to-end training converges (TODO)
⏳ Common pitfalls are detected (TODO)

3.2 KiB Raw Permalink Blame History