Commit Graph

7 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
a7fb897eed Update documentation and cleanup rules
- Enhanced tensor module documentation with mathematical foundations
- Improved explanations for scalars, vectors, and matrices
- Added NBGrader workflow documentation to activations module
- Cleaned up .cursor/rules/ directory structure
- Updated user preferences for better development workflow

These changes improve the educational content and developer experience
while maintaining the core functionality of all modules.
2025-07-13 17:00:21 -04:00
Vijay Janapa Reddi
5213050131 Update CLI references and virtual environment activation
- Replace all 'python bin/tito.py' references with correct 'tito' commands
- Update command structure to use proper subcommands (tito system info, tito module test, etc.)
- Add virtual environment activation to all workflows
- Update Makefile to use correct tito commands with .venv activation
- Update activation script to use correct tito path and command examples
- Add Tiny🔥Torch branding to activation script header
- Update documentation to reflect correct CLI usage patterns
2025-07-13 15:52:09 -04:00
Vijay Janapa Reddi
39a85fb455 Add descriptions to all .cursor/rules files
- Add brief descriptions to YAML frontmatter for all rule files
- Descriptions explain the purpose and content of each rule
- Follow consistent format matching ml-systems-course-context.mdc
- Improve rule discoverability and understanding

Files updated:
- user-preferences.mdc: User preferences and development conventions
- tinytorch-project-structure.mdc: Dual-structure architecture guide
- testing-patterns.mdc: Testing standards with pytest and real data
- nbdev-educational-pattern.mdc: Educational NBDev patterns
- module-development-best-practices.mdc: Real Data, Real Systems principles
- git-workflow.mdc: Git workflow guidelines for incremental commits
- development-workflow.mdc: Complete development workflow with tito CLI
- cli-patterns.mdc: CLI development patterns for tito tool
2025-07-11 22:47:03 -04:00
Vijay Janapa Reddi
febc7d62aa Update cursor rules to mandate pytest for all testing
- Add explicit pytest requirement to testing-patterns.mdc
- Update user-preferences.mdc to include pytest preference
- Modify development-workflow.mdc to reference pytest usage
- Specify that all tests must use pytest framework
- Document pytest features to use (classes, fixtures, assertions)
- Add comprehensive examples of proper pytest structure
- Include DO NOT USE section for prohibited testing approaches
- Ensure CLI integration expects pytest-compatible test files
- Make it clear that manual testing and other frameworks are not allowed
2025-07-10 19:32:04 -04:00
Vijay Janapa Reddi
3356a10495 Update test discovery and documentation for new module structure
- Fix CLI tool to look for tests in modules/{module}/tests/ instead of tests/
- Update test imports to use parent directory module imports
- Update Cursor rules to reflect new test structure:
  * Project structure shows tests/ subdirectory
  * Testing patterns show correct paths and import patterns
  * Development workflow shows updated test locations
- Test imports now work: from tensor_dev import Tensor
- CLI commands now find tests in correct locations

Tests are now properly organized and discoverable
2025-07-10 18:45:09 -04:00
Vijay Janapa Reddi
35c9f0ce5f Ensure all Cursor rules have proper descriptions and follow best practices
- Fix frontmatter for all rules to include proper descriptions
- Update rule types according to Cursor guidelines:
  * alwaysApply: project-structure, user-preferences
  * globs: nbdev-educational-pattern, testing-patterns
  * description only: development-workflow, ml-systems-course-context
- All rules under 500 lines, focused and actionable
- Follow MDC format with proper metadata
- Ready for proper Cursor rule functionality
2025-07-10 18:28:26 -04:00
Vijay Janapa Reddi
f167ca333e Add comprehensive Cursor rules for TinyTorch development
- Project structure guide (always applied)
- NBDev educational pattern for module development files
- Development workflow and CLI usage
- Testing patterns and conventions
- ML Systems course context and learning approach
- User preferences and conventions

These rules will help with codebase navigation, understanding the educational approach,
and maintaining consistency across the TinyTorch framework.
2025-07-10 18:24:12 -04:00