mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-05-02 01:47:30 -05:00
Update documentation for site/ migration and restructuring
Documentation updates across the codebase: Root documentation: - README.md: Updated references from book/ to site/ - CONTRIBUTING.md: Updated build and workflow instructions - .shared-ai-rules.md: Updated AI assistant rules for new structure GitHub configuration: - Issue templates updated for new module locations - Workflow references updated from book/ to site/ docs/ updates: - STUDENT_QUICKSTART.md: New paths and structure - module-rules.md: Updated module development guidelines - NBGrader documentation: Updated for module restructuring - Archive documentation: Updated references Module documentation: - modules/17_memoization/README.md: Updated after reordering All documentation now correctly references: - site/ instead of book/ - modules/XX_name/ instead of modules/source/
This commit is contained in:
@@ -24,7 +24,7 @@ Break each complex module into **smaller, focused sub-components** while maintai
|
||||
|
||||
**Current Structure:**
|
||||
```
|
||||
modules/source/02_tensor/
|
||||
modules/02_tensor/
|
||||
├── tensor_dev.py # 1,578 lines - everything in one file
|
||||
├── module.yaml
|
||||
└── README.md
|
||||
@@ -32,7 +32,7 @@ modules/source/02_tensor/
|
||||
|
||||
**Proposed Structure:**
|
||||
```
|
||||
modules/source/02_tensor/
|
||||
modules/02_tensor/
|
||||
├── parts/
|
||||
│ ├── 01_foundations.py # Mathematical foundations & tensor theory
|
||||
│ ├── 02_creation.py # Tensor creation & initialization
|
||||
@@ -49,7 +49,7 @@ modules/source/02_tensor/
|
||||
|
||||
**Current Structure:**
|
||||
```
|
||||
modules/source/15_mlops/
|
||||
modules/15_mlops/
|
||||
├── mlops_dev.py # 1,667 lines - entire MLOps pipeline
|
||||
├── module.yaml
|
||||
└── README.md
|
||||
@@ -57,7 +57,7 @@ modules/source/15_mlops/
|
||||
|
||||
**Proposed Structure:**
|
||||
```
|
||||
modules/source/15_mlops/
|
||||
modules/15_mlops/
|
||||
├── parts/
|
||||
│ ├── 01_monitoring.py # Model and data drift detection
|
||||
│ ├── 02_deployment.py # Model serving & API endpoints
|
||||
|
||||
Reference in New Issue
Block a user