mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-05-07 06:17:31 -05:00
4f9c6e40bd
- Added educational metadata (difficulty, time_estimate) to all module.yaml files - Updated convert_readmes.py to read from YAML instead of hardcoded mappings - Standardized difficulty progression: ⭐ → ⭐⭐ → ⭐⭐⭐ → ⭐⭐⭐⭐ → ⭐⭐⭐⭐⭐🥷 - Fixed path resolution for YAML reading in book build process - Eliminated duplication: single source of truth for educational metadata - Capstone gets special ninja treatment (⭐⭐⭐⭐⭐🥷) as beyond-expert level
31 lines
806 B
YAML
31 lines
806 B
YAML
# TinyTorch Module Metadata
|
|
# Essential system information for CLI tools and build systems
|
|
|
|
name: "optimizers"
|
|
title: "Optimizers"
|
|
description: "Gradient-based parameter optimization algorithms"
|
|
|
|
# Dependencies - Used by CLI for module ordering and prerequisites
|
|
dependencies:
|
|
prerequisites: ["setup", "tensor", "autograd"]
|
|
enables: ["training", "compression", "mlops"]
|
|
|
|
# Package Export - What gets built into tinytorch package
|
|
exports_to: "tinytorch.core.optimizers"
|
|
|
|
# File Structure - What files exist in this module
|
|
files:
|
|
dev_file: "optimizers_dev.py"
|
|
readme: "README.md"
|
|
tests: "inline"
|
|
|
|
# Educational Metadata
|
|
difficulty: "⭐⭐⭐⭐"
|
|
time_estimate: "6-8 hours"
|
|
|
|
# Components - What's implemented in this module
|
|
components:
|
|
- "SGD"
|
|
- "Adam"
|
|
- "StepLR"
|
|
- "gradient_descent_step" |