annotated-transformer

GitHub
7.2k 1.5k 简单 1 次阅读 昨天MIT语言模型其他
AI 解读 由 AI 自动生成,仅供参考

annotated-transformer 是经典 Transformer 论文的代码实现版本,其核心特色在于每一行代码都配有详尽的中文注释与原理解析。它源自哈佛大学 NLP 团队广受欢迎的"The Annotated Transformer"博客教程,旨在解决深度学习初学者和研究者在阅读原始论文及官方代码时面临的“黑盒”难题,帮助用户真正理解模型内部的数学逻辑与工程细节。

该项目非常适合自然语言处理领域的研究人员、高校学生以及希望深入掌握 Transformer 架构的开发者使用。不同于仅提供运行结果的封装库,annotated-transformer 将复杂的注意力机制、位置编码等模块拆解为可读性极强的 Python 代码,并配合 Markdown 说明,让学习者能像阅读教科书一样逐行钻研。

技术亮点方面,项目采用 Jupytext 工具链管理代码,通过同步维护 .py 脚本与 .ipynb 笔记本,既保证了版本控制的整洁性,又提供了交互式学习的便利。此外,代码严格遵循 PEP8 规范,并集成 Black 和 flake8 进行自动化格式化与检查,确保了代码风格的高质量与一致性。无论是用于教学演示还是个人进阶学习,annotated-transformer 都是打通理论与实战的优秀桥梁。

使用场景

某高校 NLP 实验室的研究生在复现 Transformer 论文以进行模型改进实验时,面对复杂的原始代码感到无从下手。

没有 annotated-transformer 时

  • 直接阅读官方或第三方实现的源码时,缺乏逐行注释,难以将数学公式与具体的代码逻辑对应起来,理解成本极高。
  • 试图修改网络结构(如调整注意力头数)时,因不熟悉内部数据流向,极易引发维度不匹配的错误且排查困难。
  • 本地配置深度学习环境耗时耗力,依赖冲突频发,导致在开始实际研究前就耗费了大量时间。
  • 代码风格不统一且缺乏自动化检查,协作开发时难以保证代码质量,合并分支时经常产生冲突。

使用 annotated-transformer 后

  • 借助其详尽的行级注释和博客对照,研究者能清晰看到每一个矩阵变换如何对应论文公式,迅速掌握核心机制。
  • 基于清晰的结构化代码,学生可以快速定位并修改特定模块(如位置编码或掩码机制),安全地验证创新想法。
  • 利用提供的 Colab 笔记本链接,无需本地配置即可直接在云端运行和调试代码,实现了“开箱即用”。
  • 项目内置了 Black 和 flake8 自动化格式化与检查流程,确保代码符合 PEP8 标准,极大降低了团队协作的沟通成本。

annotated-transformer 通过将晦涩的论文转化为可读性极强的教学级代码,显著降低了深度学习前沿模型的学习门槛与复现周期。

运行环境要求

操作系统
  • 未说明
GPU

未说明

内存

未说明

依赖
notes该项目主要是一个教学用的代码实现(基于哈佛 NLP 博客文章),核心文件为 Python 脚本 (.py),需使用 jupytext 同步生成 Jupyter Notebook (.ipynb)。运行前需安装 jupytext 并执行 'make notebook' 生成笔记文件。代码格式检查依赖 black 和 flake8,提交 PR 前建议运行 'make black' 和 'make flake' 以确保符合 PEP8 标准。README 中未列出具体的深度学习框架(如 PyTorch)版本要求,具体依赖请参阅项目中的 requirements.txt 文件。
python未说明
jupytext
black
flake8
jupyter
nbconvert
annotated-transformer hero image

快速开始

带注释的 Transformer 博文代码:

http://nlp.seas.harvard.edu/annotated-transformer/

在 Colab 中打开

image

软件包依赖

使用 requirements.txt 文件通过 pip 安装库依赖:

pip install -r requirements.txt

笔记本设置

带注释的 Transformer 是使用 jupytext 创建的。

常规笔记本文件会给版本控制带来问题——单元格输出会进入仓库历史,导致难以查看提交之间的差异。而使用 jupytext 时,会有一个 Python 脚本(.py 文件),它由 jupytext 插件自动与笔记本文件保持同步。

该 Python 脚本会提交到仓库中,包含所有单元格内容,并可用于生成笔记本文件。Python 脚本是一个普通的 Python 源文件,Markdown 部分使用标准的注释格式嵌入其中,且不会保存输出。而笔记本本身则被视为构建产物,不会被提交到 Git 仓库。

在使用此仓库之前,请确保已按照 此处的安装说明 安装 jupytext。

要使用 Markdown 源文件生成 .ipynb 笔记本文件,运行以下命令(在底层,notebook 构建目标只是执行 jupytext --to ipynb the_annotated_transformer.py):

make notebook

要生成笔记本的 HTML 版本,运行:

make html

make html 只是一个快捷方式,它首先使用 jupytext --to ipynb the_annotated_transformer.py 生成笔记本文件,然后使用 Jupyter 的 nbconvert 命令将其转换为 HTML:jupyter nbconvert --to html the_annotated_transformer.ipynb

代码格式化与 linting

为了保持代码格式整洁,带注释的 Transformer 的 Git 仓库配置了 GitHub Actions,用于检查代码是否符合 PEP8 编码规范

为方便操作,Makefile 中提供了两个构建目标,分别用于使用 Black 和 Flake8 自动格式化代码。

请确保已 安装 BlackFlake8

之后您可以运行:

make black

(或者手动调用 black --line-length 79 the_annotated_transformer.py)以使用 Black 自动格式化代码;

以及

make flake

(或者手动调用 flake8 --show-source the_annotated_transformer.py)来检查 PEP8 违规。

建议在提交 PR 时运行这两个命令并修复所有出现的 Flake8 错误,否则 GitHub Actions 的 CI 流水线将会报告错误。

常见问题

相似工具推荐

everything-claude-code

everything-claude-code 是一套专为 AI 编程助手(如 Claude Code、Codex、Cursor 等)打造的高性能优化系统。它不仅仅是一组配置文件,而是一个经过长期实战打磨的完整框架,旨在解决 AI 代理在实际开发中面临的效率低下、记忆丢失、安全隐患及缺乏持续学习能力等核心痛点。 通过引入技能模块化、直觉增强、记忆持久化机制以及内置的安全扫描功能,everything-claude-code 能显著提升 AI 在复杂任务中的表现,帮助开发者构建更稳定、更智能的生产级 AI 代理。其独特的“研究优先”开发理念和针对 Token 消耗的优化策略,使得模型响应更快、成本更低,同时有效防御潜在的攻击向量。 这套工具特别适合软件开发者、AI 研究人员以及希望深度定制 AI 工作流的技术团队使用。无论您是在构建大型代码库,还是需要 AI 协助进行安全审计与自动化测试,everything-claude-code 都能提供强大的底层支持。作为一个曾荣获 Anthropic 黑客大奖的开源项目,它融合了多语言支持与丰富的实战钩子(hooks),让 AI 真正成长为懂上

139k|★★☆☆☆|今天
开发框架Agent语言模型

NextChat

NextChat 是一款轻量且极速的 AI 助手,旨在为用户提供流畅、跨平台的大模型交互体验。它完美解决了用户在多设备间切换时难以保持对话连续性,以及面对众多 AI 模型不知如何统一管理的痛点。无论是日常办公、学习辅助还是创意激发,NextChat 都能让用户随时随地通过网页、iOS、Android、Windows、MacOS 或 Linux 端无缝接入智能服务。 这款工具非常适合普通用户、学生、职场人士以及需要私有化部署的企业团队使用。对于开发者而言,它也提供了便捷的自托管方案,支持一键部署到 Vercel 或 Zeabur 等平台。 NextChat 的核心亮点在于其广泛的模型兼容性,原生支持 Claude、DeepSeek、GPT-4 及 Gemini Pro 等主流大模型,让用户在一个界面即可自由切换不同 AI 能力。此外,它还率先支持 MCP(Model Context Protocol)协议,增强了上下文处理能力。针对企业用户,NextChat 提供专业版解决方案,具备品牌定制、细粒度权限控制、内部知识库整合及安全审计等功能,满足公司对数据隐私和个性化管理的高标准要求。

87.6k|★★☆☆☆|今天
开发框架语言模型

ML-For-Beginners

ML-For-Beginners 是由微软推出的一套系统化机器学习入门课程,旨在帮助零基础用户轻松掌握经典机器学习知识。这套课程将学习路径规划为 12 周,包含 26 节精炼课程和 52 道配套测验,内容涵盖从基础概念到实际应用的完整流程,有效解决了初学者面对庞大知识体系时无从下手、缺乏结构化指导的痛点。 无论是希望转型的开发者、需要补充算法背景的研究人员,还是对人工智能充满好奇的普通爱好者,都能从中受益。课程不仅提供了清晰的理论讲解,还强调动手实践,让用户在循序渐进中建立扎实的技能基础。其独特的亮点在于强大的多语言支持,通过自动化机制提供了包括简体中文在内的 50 多种语言版本,极大地降低了全球不同背景用户的学习门槛。此外,项目采用开源协作模式,社区活跃且内容持续更新,确保学习者能获取前沿且准确的技术资讯。如果你正寻找一条清晰、友好且专业的机器学习入门之路,ML-For-Beginners 将是理想的起点。

85k|★★☆☆☆|今天
图像数据工具视频

ragflow

RAGFlow 是一款领先的开源检索增强生成(RAG)引擎,旨在为大语言模型构建更精准、可靠的上下文层。它巧妙地将前沿的 RAG 技术与智能体(Agent)能力相结合,不仅支持从各类文档中高效提取知识,还能让模型基于这些知识进行逻辑推理和任务执行。 在大模型应用中,幻觉问题和知识滞后是常见痛点。RAGFlow 通过深度解析复杂文档结构(如表格、图表及混合排版),显著提升了信息检索的准确度,从而有效减少模型“胡编乱造”的现象,确保回答既有据可依又具备时效性。其内置的智能体机制更进一步,使系统不仅能回答问题,还能自主规划步骤解决复杂问题。 这款工具特别适合开发者、企业技术团队以及 AI 研究人员使用。无论是希望快速搭建私有知识库问答系统,还是致力于探索大模型在垂直领域落地的创新者,都能从中受益。RAGFlow 提供了可视化的工作流编排界面和灵活的 API 接口,既降低了非算法背景用户的上手门槛,也满足了专业开发者对系统深度定制的需求。作为基于 Apache 2.0 协议开源的项目,它正成为连接通用大模型与行业专有知识之间的重要桥梁。

77.1k|★★★☆☆|2天前
Agent图像开发框架

PaddleOCR

PaddleOCR 是一款基于百度飞桨框架开发的高性能开源光学字符识别工具包。它的核心能力是将图片、PDF 等文档中的文字提取出来,转换成计算机可读取的结构化数据,让机器真正“看懂”图文内容。 面对海量纸质或电子文档,PaddleOCR 解决了人工录入效率低、数字化成本高的问题。尤其在人工智能领域,它扮演着连接图像与大型语言模型(LLM)的桥梁角色,能将视觉信息直接转化为文本输入,助力智能问答、文档分析等应用场景落地。 PaddleOCR 适合开发者、算法研究人员以及有文档自动化需求的普通用户。其技术优势十分明显:不仅支持全球 100 多种语言的识别,还能在 Windows、Linux、macOS 等多个系统上运行,并灵活适配 CPU、GPU、NPU 等各类硬件。作为一个轻量级且社区活跃的开源项目,PaddleOCR 既能满足快速集成的需求,也能支撑前沿的视觉语言研究,是处理文字识别任务的理想选择。

74.9k|★★★☆☆|今天
语言模型图像开发框架

awesome-machine-learning

awesome-machine-learning 是一份精心整理的机器学习资源清单,汇集了全球优秀的机器学习框架、库和软件工具。面对机器学习领域技术迭代快、资源分散且难以甄选的痛点,这份清单按编程语言(如 Python、C++、Go 等)和应用场景(如计算机视觉、自然语言处理、深度学习等)进行了系统化分类,帮助使用者快速定位高质量项目。 它特别适合开发者、数据科学家及研究人员使用。无论是初学者寻找入门库,还是资深工程师对比不同语言的技术选型,都能从中获得极具价值的参考。此外,清单还延伸提供了免费书籍、在线课程、行业会议、技术博客及线下聚会等丰富资源,构建了从学习到实践的全链路支持体系。 其独特亮点在于严格的维护标准:明确标记已停止维护或长期未更新的项目,确保推荐内容的时效性与可靠性。作为机器学习领域的“导航图”,awesome-machine-learning 以开源协作的方式持续更新,旨在降低技术探索门槛,让每一位从业者都能高效地站在巨人的肩膀上创新。

72.1k|★☆☆☆☆|2天前
开发框架其他