这个仓库用于记录我学习 CS336 的笔记、实现和实验。公开展示的内容位于 docs/,会通过 GitHub Pages 发布为静态网站;代码和实验过程分别放在 code/ 与 experiments/。
.
├── docs/ # 笔记网站源码
├── code/ # 课程相关实现
├── experiments/ # 实验记录、脚本和结果摘要
├── tests/ # 针对可复用代码的测试
├── scripts/ # 辅助脚本
├── zensical.toml # Zensical 文档站配置
└── .github/workflows # GitHub Pages 自动部署
建议使用虚拟环境:
python3 -m venv .venv
source .venv/bin/activate
pip install zensical
zensical serve然后访问 http://localhost:8000。
zensical build --clean生成结果位于 site/,该目录不提交到 Git。
docs/面向读者,保留整理后的笔记和总结。code/面向实现,尽量让核心算法可以被测试。experiments/面向过程,记录实验假设、命令、结果和复盘。- 大型数据、模型权重、日志和缓存不提交到仓库。