mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-04-28 07:17:33 -05:00

Files

Vijay Janapa Reddi 7826e167b6 Reorganize repository structure and add build tooling

## Repository Organization
- Move scripts from bin/ to scripts/ directory
  - activate-tinytorch: Environment activation script
  - generate_module_metadata.py: Module metadata generator
  - generate_student_notebooks.py: Student notebook generator
  - tito: TinyTorch CLI tool

## Build System
- Add site/build.sh: Jupyter Book 1.x build automation script
  - Auto-detects project root or site directory
  - Activates virtual environment if available
  - Handles clean builds with proper error handling

## Documentation
- Add docs/history/ for migration documentation
  - ROLLBACK_TO_JB1.md: Jupyter Book 1.x rollback documentation
  - MIGRATION_TO_V2.md: Jupyter Book 2.0 migration attempt notes

## Infrastructure Updates
- Update all site/modules/*_ABOUT.md symlinks: modules/ → src/
- Update all src/*/ABOUT.md symlinks: modules/ → src/
- Update .envrc: Reflect new scripts/ directory structure
- Update pyproject.toml: Add build system dependencies

This commit completes the src-modules separation restructuring and
adds necessary tooling for the new repository layout.

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

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

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

development

Update documentation for new src/ structure

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

history

Reorganize repository structure and add build tooling

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

nbgrader

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

_config_pdf.yml

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

_toc_pdf.yml

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

cifar10-training-guide.md

docs: update module references in README and guides

2025-11-09 12:42:27 -05:00

cover.md

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

INSTRUCTOR_GUIDE.md

Add community and benchmark features with baseline validation

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

preface.md

Update documentation for site/ migration and restructuring

2025-11-10 19:42:48 -05:00

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

feat: Implement TinyTorch complexity framework for academic friendliness

2025-09-27 16:59:00 -04:00

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