mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-07 18:18:42 -05:00
edbea966bf
Brings the TinyTorch lab guide's Quarto project in line with
book/quarto/, the only other in-tree Quarto publication that builds
both web and PDF outputs from a single source. The previous name had
three redundancies:
- already under tinytorch/, so "site-" prefix wasn't disambiguating
- also produces the PDF lab guide, so "site-" was misleading
- the top-level site/ dir made "site-quarto" read as "the site's
quarto config" rather than "the tinytorch site, in quarto"
After this rename the convention is straightforward:
book/quarto/ -> the textbook (web + PDF)
tinytorch/quarto/ -> the TinyTorch lab guide (web + PDF)
mlsysim/docs/ -> mlsysim API reference (kept as docs/, since it
really is API reference, not a publication)
Touches 7 GitHub workflows, both .gitignore files, the rename target's
own self-references (Makefile, _quarto.yml configs, STYLE.md,
measure-pdf-images.py), and 6 copies of subscribe-modal.js plus a few
shared scripts/configs whose comments documented the old path.
Verified: rebuilt pdf/TinyTorch-Guide.pdf (2.1M) cleanly from the new
location with 'make pdf' from tinytorch/quarto/.
233 lines
4.0 KiB
Plaintext
233 lines
4.0 KiB
Plaintext
# Byte-compiled / optimized / DLL files
|
|
__pycache__/
|
|
*.py[cod]
|
|
*$py.class
|
|
|
|
# C extensions
|
|
*.so
|
|
|
|
# Distribution / packaging
|
|
.Python
|
|
build/
|
|
develop-eggs/
|
|
dist/
|
|
downloads/
|
|
# Whitelist the Quarto site downloads directory: this holds shipped PDFs
|
|
# (e.g. 00_tinytorch.pdf) that are referenced from big-picture.qmd's PDF
|
|
# viewer. The blanket `downloads/` rule above is from the Python packaging
|
|
# template and shouldn't apply to website assets.
|
|
!quarto/assets/downloads/
|
|
!quarto/assets/downloads/**
|
|
eggs/
|
|
.eggs/
|
|
lib/
|
|
lib64/
|
|
parts/
|
|
sdist/
|
|
var/
|
|
wheels/
|
|
share/python-wheels/
|
|
*.egg-info/
|
|
.installed.cfg
|
|
*.egg
|
|
MANIFEST
|
|
|
|
# PyInstaller
|
|
*.manifest
|
|
*.spec
|
|
|
|
# Unit test / coverage reports
|
|
htmlcov/
|
|
.tox/
|
|
.nox/
|
|
.coverage
|
|
.coverage.*
|
|
.cache
|
|
nosetests.xml
|
|
coverage.xml
|
|
*.cover
|
|
*.py,cover
|
|
.hypothesis/
|
|
.pytest_cache/
|
|
cover/
|
|
|
|
# Jupyter Notebook
|
|
.ipynb_checkpoints
|
|
|
|
# IPython
|
|
profile_default/
|
|
ipython_config.py
|
|
|
|
# pyenv
|
|
.python-version
|
|
|
|
# Virtual environments
|
|
.env
|
|
.venv
|
|
env/
|
|
venv/
|
|
ENV/
|
|
env.bak/
|
|
venv.bak/
|
|
bin/
|
|
include/
|
|
lib/
|
|
lib64/
|
|
pyvenv.cfg
|
|
share/
|
|
# Prevent duplicate venvs in subdirectories
|
|
site/.venv/
|
|
**/.venv/
|
|
**/venv/
|
|
**/env/
|
|
|
|
# IDEs
|
|
.vscode/
|
|
.idea/
|
|
*.swp
|
|
*.swo
|
|
*~
|
|
.DS_Store
|
|
|
|
# Jupyter Book
|
|
book/_build/
|
|
site/_build/
|
|
docs/_build/
|
|
|
|
# NBGrader - assignments are dynamically generated via 'tito nbgrader generate'
|
|
# Only ignore student submissions and grading outputs, not source/release (for now)
|
|
assignments/autograded/
|
|
assignments/feedback/
|
|
assignments/submitted/
|
|
# Note: assignments/source/ and assignments/release/ are kept in git for now
|
|
# but should be regenerated with 'tito nbgrader generate' when modules change
|
|
|
|
# Logs
|
|
*.log
|
|
|
|
# LaTeX build artifacts
|
|
*.aux
|
|
*.bbl
|
|
*.blg
|
|
*.out
|
|
*.fls
|
|
*.fdb_latexmk
|
|
*.synctex.gz
|
|
*.toc
|
|
*.lof
|
|
*.lot
|
|
*.pdf
|
|
# Whitelist shipped Quarto-site PDFs (override the blanket *.pdf above,
|
|
# which is meant for transient LaTeX build artifacts, not production
|
|
# downloads served from the website).
|
|
!quarto/assets/downloads/*.pdf
|
|
!site/_static/downloads/*.pdf
|
|
|
|
# Database
|
|
*.db
|
|
*.sqlite
|
|
|
|
# OS
|
|
.DS_Store
|
|
Thumbs.db
|
|
|
|
# Temporary files
|
|
*.tmp
|
|
*.temp
|
|
|
|
# Backup files
|
|
*.bak
|
|
*.backup
|
|
|
|
# AI assistant configs
|
|
.claude/
|
|
.cursor/
|
|
.ai/
|
|
|
|
# Project specific
|
|
tito-cli.log
|
|
COMMIT_LOG.txt
|
|
|
|
# Tito CLI user state and cache (local to each user)
|
|
.tito/
|
|
|
|
# Downloaded datasets (not source-controlled, too large)
|
|
data/
|
|
datasets/
|
|
milestones/datasets/
|
|
|
|
# BUT: Include TinyTorch's curated educational datasets (tiny, ship-with-repo)
|
|
!datasets/tinydigits/
|
|
!datasets/tinytalks/
|
|
!datasets/tinymnist/
|
|
!datasets/README.md
|
|
!datasets/DATASET_ANALYSIS.md
|
|
|
|
# Temporary AI-generated reports (not permanent project docs)
|
|
MODULE_REVIEW_REPORT_*.md
|
|
MODULE_STATUS_SUMMARY.md
|
|
**/*_SUMMARY.md
|
|
**/*_REPORT*.md
|
|
**/*_ANALYSIS.md
|
|
**/*_VERIFICATION.md
|
|
**/*_CHECKLIST.md
|
|
**/*_FIXES*.md
|
|
**/*_CHANGES*.md
|
|
**/*_COMPLETE.md
|
|
**/*_RECOMMENDATIONS.md
|
|
**/*_BEFORE_AFTER.md
|
|
**/*_OUTPUTS.md
|
|
**/*_UPDATE.md
|
|
**/*_STATUS.md
|
|
**/*_MAP.md
|
|
**/*_GUIDE.md
|
|
**/*_FINDINGS.md
|
|
**/*_PLAN.md
|
|
**/*_COMPARISON.md
|
|
**/*_REVIEW*.md
|
|
**/*_MATRIX.md
|
|
**/*_INVENTORY.md
|
|
**/*_ASSESSMENT.md
|
|
**/VERIFY_*.py
|
|
**/NEW_CITATIONS.bib
|
|
**/proposed_figures.tex
|
|
progress.json
|
|
modules/HASATTR_*.md
|
|
|
|
# Generated notebooks (built from src/*.py source files)
|
|
# The modules/ directory contains generated notebooks for learners
|
|
modules/*
|
|
!modules/README.md
|
|
|
|
# Generated website module docs (copied from src/*/ABOUT.md during build)
|
|
# Single source of truth: src/*/ABOUT.md
|
|
docs/modules/*
|
|
docs/chapters/modules/*
|
|
|
|
# AI development files (keep locally)
|
|
.claude/
|
|
|
|
# Site build artifacts
|
|
site/_build/
|
|
.envrc
|
|
|
|
# BUT: Include PDF downloads for the website (shipped with repo)
|
|
!site/_static/downloads/
|
|
!site/_static/downloads/*.pdf
|
|
|
|
# Generated tinytorch package (auto-generated from src/ via nbdev_export)
|
|
# Single source of truth: src/*/*.py files
|
|
# Track __init__.py files (package structure) but ignore generated implementations
|
|
tinytorch/*
|
|
!tinytorch/__init__.py
|
|
!tinytorch/core/
|
|
tinytorch/core/*
|
|
!tinytorch/core/__init__.py
|
|
!tinytorch/perf/
|
|
tinytorch/perf/*
|
|
!tinytorch/perf/__init__.py
|
|
!tinytorch/README.md
|
|
|
|
# Generated benchmark outputs
|
|
.tito/benchmarks/
|