mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-05-02 17:28:44 -05:00
7a9db7d52a
- Replaced 3 overlapping documentation files with 1 authoritative source - Set modules/source/08_optimizers/optimizers_dev.py as reference implementation - Created comprehensive module-rules.md with complete patterns and examples - Added living-example approach: use actual working code as template - Removed redundant files: module-structure-design.md, module-quick-reference.md, testing-design.md - Updated cursor rules to point to consolidated documentation - All module development now follows single source of truth
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
# Module Development Rules
|
|
|
|
**Authoritative Source**: `docs/development/module-rules.md`
|
|
**Reference Implementation**: `modules/source/08_optimizers/optimizers_dev.py`
|
|
|
|
All TinyTorch module development rules, patterns, conventions, and examples are maintained in the comprehensive documentation file:
|
|
|
|
📖 **[docs/development/module-rules.md](../../docs/development/module-rules.md)**
|
|
|
|
## 🎯 **Use Living Examples, Not Static Documentation**
|
|
|
|
Instead of maintaining separate documentation that can get out of sync, **use `08_optimizers` as your reference implementation** - it follows all current patterns perfectly and serves as the living example of proper module structure.
|
|
|
|
## 📋 **What's Covered**
|
|
|
|
- 📁 File structure and organization
|
|
- 🎓 Educational patterns and pedagogical framework
|
|
- 🧪 Testing conventions and inline test standards
|
|
- 📦 NBDev integration and export patterns
|
|
- 🎯 Complete module template with educational content
|
|
- 🏗️ Development workflow and best practices
|
|
- 📋 Module metadata and configuration
|
|
- ✅ Quality standards and checklist
|
|
|
|
## 🔗 **Quick Reference Approach**
|
|
|
|
1. **Check `08_optimizers`** for educational content structure
|
|
2. **Follow exact patterns** for module summaries and takeaways
|
|
3. **Use the rules file** for technical specifications
|
|
4. **Reference living code** instead of static documentation
|
|
|
|
**Remember**: When in doubt, reference `08_optimizers` - it follows all patterns perfectly! |