mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-12 19:13:32 -05:00

Files

Vijay Janapa Reddi 3e36b520b3 Complete src-modules separation: Update all symlinks and infrastructure

## Symlink Updates (modules/ → src/)
- Update all 20 site/modules/*_ABOUT.md symlinks to point to src/
- Update all 20 src/*/ABOUT.md internal references

## Infrastructure Changes
- Remove bin/ directory scripts (moved to scripts/ in previous commit)
- Update .envrc: Reference new scripts/ directory structure
- Update pyproject.toml: Reflect src/ as primary source location
- Update docs/development/MODULE_ABOUT_TEMPLATE.md: src/ paths
- Update site/requirements.txt: Documentation dependencies

## Restructuring Complete

The repository now has clean separation:
- `src/`: Developer source code (graded notebooks with solutions)
- `modules/`: Student workspace (generated from src/)
- `scripts/`: Build and utility scripts
- `site/`: Documentation and Jupyter Book website

This enables the intended workflow:
1. Developers work in src/
2. Students receive generated notebooks in modules/
3. Both can coexist without conflicts

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-11-25 11:30:06 -05:00

development

Complete src-modules separation: Update all symlinks and infrastructure

2025-11-25 11:30:06 -05:00

history

Reorganize repository structure and add build tooling

2025-11-25 11:29:41 -05:00

nbgrader

…

_config_pdf.yml

…

_toc_pdf.yml

…

cifar10-training-guide.md

…

cover.md

…

INSTRUCTOR_GUIDE.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -05:00

preface.md

…

PRIVACY_DATA_RETENTION.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -05:00

README.md

Remove references to non-existent documentation files

2025-11-19 22:03:57 -05:00

STUDENT_QUICKSTART.md

Update documentation for new src/ structure

2025-11-25 02:13:19 -05:00

TEAM_ONBOARDING.md

Add community and benchmark features with baseline validation

2025-11-20 00:17:21 -05:00

tinytorch-assumptions.md

…

README.md

TinyTorch Documentation

This directory contains essential documentation for TinyTorch development and usage.

📚 User Documentation

STUDENT_QUICKSTART.md - Getting started guide for students
INSTRUCTOR_GUIDE.md - Setup and grading guide for instructors
cifar10-training-guide.md - Complete guide to achieving the north star goal (75% CIFAR-10 accuracy)

🔧 Development Documentation

tinytorch-assumptions.md - CRITICAL: TinyTorch complexity framework and implementation guidelines

Development Standards

development/module-rules.md - Module development standards and patterns

NBGrader Integration

nbgrader/NBGrader_Quick_Reference.md - Daily use commands and workflow
nbgrader/NBGRADER_STYLE_GUIDE.md - Style guide for NBGrader cells
nbgrader/NBGrader_Text_Response_Technical_Implementation.md - Technical implementation details

Start here:

Students: Read STUDENT_QUICKSTART.md
Instructors: Read INSTRUCTOR_GUIDE.md
Developers: Read tinytorch-assumptions.md FIRST, then development/module-rules.md