Commit Graph

277 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
6e357b671a Improve Modules 01 and 02 to meet TinyTorch educational standards
Module 01 (Setup) Improvements:
- Fix duplicate grade_id (changed to setup-verification)
- Add comprehensive 5 C's pattern before implementations
- Replace hardcoded instructor data with generic placeholders
- Implement test-immediately pattern after each function
- Add proper NBGrader metadata to all test cells

Module 02 (Tensor) Improvements:
- Move ALL scaffolding outside BEGIN/END SOLUTION blocks
- Add complete 5 C's pattern before Tensor implementation
- Fix test naming to consistent test_unit_* pattern
- Ensure tests run immediately after implementations
- Maintain proper NBGrader metadata with unique grade_ids

Key Standards Applied:
- 5 C's Pattern: Concept, Code Structure, Connections, Constraints, Context
- Test-immediately: Every implementation followed by immediate validation
- NBGrader Ready: Scaffolding outside solutions for student releases
- Professional Standards: Generic data and consistent patterns

These improvements ensure both modules:
1. Pass NBGrader validation for student releases
2. Provide comprehensive educational scaffolding
3. Follow test-immediately pattern for rapid feedback
4. Meet all TinyTorch quality standards
2025-09-15 14:25:49 -04:00
Vijay Janapa Reddi
19f43a49fb Removes development heading from notebook
Removes a redundant development heading from the dataloader notebook, streamlining the document's structure and improving readability.
2025-07-20 18:02:37 -04:00
Vijay Janapa Reddi
d8dec8a9c2 Add missing markdown documentation to 08_dataloader module
- Add documentation for test_unit_dataset_interface function
- Add documentation for test_unit_dataloader function
- Add documentation for test_unit_simple_dataset function
- Add documentation for test_unit_dataloader_pipeline function
- Ensures every code function has preceding explanatory markdown cell
- Maintains educational clarity and structure
2025-07-20 17:49:03 -04:00
Vijay Janapa Reddi
d14a5a4742 Add missing markdown documentation to 06_spatial module
- Add documentation for test_unit_convolution_operation function
- Add documentation for test_unit_conv2d_layer function
- Add documentation for test_unit_flatten_function function
- Ensures every code function has preceding explanatory markdown cell
- Maintains educational clarity and structure
2025-07-20 17:47:39 -04:00
Vijay Janapa Reddi
0ea11d0a5b Add missing markdown documentation to 05_dense module
- Add documentation for plot_network_architectures function
- Add documentation for MLP class
- Add documentation for test_unit_sequential_networks function
- Add documentation for test_unit_mlp_creation function
- Add documentation for test_unit_network_applications function
- Ensures every code function has preceding explanatory markdown cell
- Maintains educational clarity and structure
2025-07-20 17:46:33 -04:00
Vijay Janapa Reddi
0450d4bbc4 Removes development headers
Removes development headers from several files.

These headers were used during the development process and are no longer needed.
2025-07-20 17:41:57 -04:00
Vijay Janapa Reddi
210a9c79f0 Updates markdown headers in development files
Updates markdown headers in development files to improve consistency and readability.

Removes the redundant "🔧 DEVELOPMENT" headers and standardizes the subsequent headers to indicate the purpose of the following code, such as "🧪 Test Your Matrix Multiplication". This change enhances the clarity and organization of the development files.
2025-07-20 17:36:32 -04:00
Vijay Janapa Reddi
2b7b47a98b Add section organization to 15_mlops module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 17:30:59 -04:00
Vijay Janapa Reddi
362e265e92 Add section organization to 14_benchmarking module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 17:30:18 -04:00
Vijay Janapa Reddi
571913694d Add section organization to 13_kernels module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 17:29:39 -04:00
Vijay Janapa Reddi
254e1250ae Add section organization to 12_compression module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 17:29:02 -04:00
Vijay Janapa Reddi
f54bbb0018 Add section organization to 11_training module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 17:28:21 -04:00
Vijay Janapa Reddi
d2e9c85b00 Add section organization to 10_optimizers module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:06:19 -04:00
Vijay Janapa Reddi
268d558d39 Add section organization to 09_autograd module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:05:44 -04:00
Vijay Janapa Reddi
eaf0886c9c Add section organization to 08_dataloader module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:05:03 -04:00
Vijay Janapa Reddi
a418ed8393 Add section organization to 07_attention module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:04:31 -04:00
Vijay Janapa Reddi
9a189e07c9 Add section organization to 06_spatial module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:03:50 -04:00
Vijay Janapa Reddi
1b6016ca8b Add section organization to 05_dense module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:03:17 -04:00
Vijay Janapa Reddi
d037565804 Add section organization to 04_layers module: Add DEVELOPMENT section header
- Insert ## 🔧 DEVELOPMENT header before first test function
- Organizes module according to educational structure guidelines
- Maintains all existing functionality and test execution
- Improves readability and navigation for educational use
2025-07-20 14:01:13 -04:00
Vijay Janapa Reddi
b41e894850 Add integration test to 15_mlops module: test_module_mlops_tinytorch_integration
- Tests MLOps pipeline integration with complete TinyTorch models and workflows
- Validates performance monitoring with realistic model inference scenarios
- Tests data drift detection with model input features and production data
- Verifies complete MLOps pipeline with TinyTorch Sequential model integration
- Tests retraining triggers with TinyTorch training workflow compatibility
- Validates end-to-end MLOps workflow with comprehensive system health checks
- Positioned before MODULE SUMMARY as per educational structure
2025-07-20 14:00:00 -04:00
Vijay Janapa Reddi
4049492dfb Add integration test to 03_activations module: test_module_activation_tensor_integration
- Tests activation function integration with Tensor class operations
- Validates that activations preserve Tensor types in neural network contexts
- Tests matrix operations for multi-dimensional neural network layers
- Verifies softmax probability distributions for classification scenarios
- Tests chaining tensor operations with activations for complete workflows
- Positioned before MODULE SUMMARY as per educational structure
2025-07-20 13:59:11 -04:00
Vijay Janapa Reddi
5ce9eff9c9 Add integration test to 02_tensor module: test_module_tensor_numpy_integration
- Tests tensor integration with NumPy arrays and operations
- Validates tensor-NumPy compatibility for scientific computing
- Ensures broadcasting works correctly between tensors and scalars
- Verifies integration with NumPy functions on tensor data
- Positioned before MODULE SUMMARY as per educational structure
2025-07-20 13:57:34 -04:00
Vijay Janapa Reddi
b6eeb9d998 Improves clarity of visual understanding sections
Updates loss landscape descriptions to be more easily understood.

Replaces symbols with clearer text in visual explanations of optimizers.
2025-07-20 13:49:40 -04:00
Vijay Janapa Reddi
9826ed0118 Deprecate AUTO TESTING: Remove run_module_tests_auto from all _dev.py modules. Standardize on full-module test execution for reliable, context-aware testing. 2025-07-20 13:28:10 -04:00
Vijay Janapa Reddi
5faa1c17fd Fix indentation issues in dense module - remove duplicate function and fix __main__ block 2025-07-20 13:08:13 -04:00
Vijay Janapa Reddi
ba2512e4e5 Update test function names from test_integration_* to test_module_* for clearer cross-module testing semantics 2025-07-20 13:03:52 -04:00
Vijay Janapa Reddi
9014821c77 Renames and runs integration tests for compression
Refactors integration test names for clarity.

Executes the integration tests to validate the compression functionality.
2025-07-20 13:00:02 -04:00
Vijay Janapa Reddi
90a92b68a6 Renames training integration test function
Updates the name of the unit test function for training
integration to improve clarity and consistency.

This change ensures the test function name accurately
reflects its purpose.
2025-07-20 12:59:58 -04:00
Vijay Janapa Reddi
fd88e44b96 Removes integration test execution
Stops the automatic execution of the integration test.

This change prevents the test from running every time the module is loaded,
allowing for more focused and controlled testing.
2025-07-20 12:59:54 -04:00
Vijay Janapa Reddi
03fe3d3973 Renames integration test function
Updates the integration test function name for clarity
and consistency within the codebase.
2025-07-20 12:59:51 -04:00
Vijay Janapa Reddi
f24ab8348d Removes autogenerated markdown section
Removes a markdown section that appears to be autogenerated documentation, cleaning up the code.
2025-07-20 12:57:02 -04:00
Vijay Janapa Reddi
e9a37652b0 Clean up formatting in layers module 2025-07-20 12:54:57 -04:00
Vijay Janapa Reddi
3bc71f6015 Fix test function calls in spatial and dataloader modules - move test calls outside __main__ blocks 2025-07-20 12:54:15 -04:00
Vijay Janapa Reddi
30b8bc3b59 Fix test function calls - remove __main__ wrapper to ensure tests run during automation 2025-07-20 12:51:47 -04:00
Vijay Janapa Reddi
943c0616cc Simplify plot handling - remove _should_show_plots functions and plot guards 2025-07-20 12:47:14 -04:00
Vijay Janapa Reddi
aa4eb0f809 Removes development headers from notebooks
Removes redundant "DEVELOPMENT" headers from several notebook files.

These headers are no longer necessary and declutter the notebook content, improving readability and focus on the core content and testing sections.
2025-07-20 12:39:21 -04:00
Vijay Janapa Reddi
03ff72928b Standardize section headers for 15_mlops module 2025-07-20 12:32:47 -04:00
Vijay Janapa Reddi
8f9f0e570c Standardize section headers for 14_benchmarking module 2025-07-20 12:32:14 -04:00
Vijay Janapa Reddi
e6c71732b0 Standardize section headers for 13_kernels module 2025-07-20 12:31:42 -04:00
Vijay Janapa Reddi
0482fa1f36 Standardize section headers for 12_compression module 2025-07-20 12:31:12 -04:00
Vijay Janapa Reddi
264dfc940b Standardize section headers for 11_training module 2025-07-20 12:30:42 -04:00
Vijay Janapa Reddi
9ff76bf029 Standardize section headers for 10_optimizers module 2025-07-20 12:30:05 -04:00
Vijay Janapa Reddi
88e4a2ee29 Standardize section headers for 09_autograd module 2025-07-20 12:29:33 -04:00
Vijay Janapa Reddi
1d0238d18c Standardize section headers for 08_dataloader module 2025-07-20 12:29:02 -04:00
Vijay Janapa Reddi
e33e05b7f6 Standardize section headers for 07_attention module 2025-07-20 12:28:32 -04:00
Vijay Janapa Reddi
01a4c78a7d Standardize section headers for 06_spatial module 2025-07-20 12:27:56 -04:00
Vijay Janapa Reddi
8ab305572c Standardize section headers for 05_dense module 2025-07-20 12:26:47 -04:00
Vijay Janapa Reddi
ecf844fd2c Standardize section headers for 04_layers module 2025-07-20 12:25:54 -04:00
Vijay Janapa Reddi
1c2dc6b5da Standardize section headers for 03_activations module 2025-07-20 12:25:17 -04:00
Vijay Janapa Reddi
9ec45d18cb Standardize section headers for 02_tensor module 2025-07-20 12:24:40 -04:00