Skip to content

Commit e26445a

Browse files
authored
feat(readme): README 重做为简体中文衍生版定位 (#22)
* feat(readme): README 重做为简体中文衍生版定位 把中文仓 README 从「翻译版」升级为「简体中文衍生版」定位,差异化呈现本地化价值: - banner/slogan 中文化 + 新增「在线阅读 aieng-zh.cn」badge,badge 顺序整理 - 新增「这个中文版做了什么」特性表(全站中文 / 独立网站 / AI 检索优化 / 课数护栏) - 新增目录导航行 + 6 处章节标题中文化(How this works→怎么运作 等) - 表格表头中文化(写入路径、你的背景·从哪开始·预计时间、hours→小时) - 修正过时数字:作品 435→近 500、技能 378→388 数字按 site/build.js 口径核准:503 课、388 技能(skill-*.md)、99 提示词 (prompt-*.md)、outputs 493 均属实;TRANSLATION.md / 8 个目录锚点 / 4 语言(py595·ts129·rs10·jl20)说法均验证无误。 * feat(readme): 两个 mermaid 图中文化 + stars badge 绕 camo 缓存 - 「课程的结构」flowchart:20 个 phase 节点中文化(用 README 目录官方译名) - 「一节课的样子」flowchart:六节拍中文化(问题背景/核心概念/动手构建/ 实际使用/拿去用,与课程正文 zh.md 章节一致;MOTTO→主旨) - stars badge URL 加 cacheSeconds=21600:强制 GitHub camo 重新抓图,绕过 shields.io 偶发限流被缓存的「Unable to select token from pool」坏图 课数校验通过(503/20,Contents 表格未受影响)。 * fix(readme): mermaid 去掉 JetBrains Mono 字体,修中文节点截断 根因:init 里的 fontFamily:'JetBrains Mono' 是英文等宽字体、无中文字形, GitHub 渲染 mermaid 时用它测量节点宽度,测中文偏窄→节点画得过窄→中文 (尤其较长的 <sub> 副标题)溢出被裁切("一句话核心理念"被截成"…核心理")。 去掉 fontFamily/fontSize,让 mermaid 用默认 sans 字体栈正确测量中文宽度。 颜色主题(primaryColor/borderColor/lineColor)保留不变。 * fix(readme): mermaid 图2 去掉 <sub> 标签,修中文副标题截断 接上一刀。去掉 JetBrains Mono 后主标题已正常、带空格的副标题也能撑开, 但纯中文的 <sub> 副标题仍被裁切——根因是 mermaid 对 <sub> 标签内文本 宽度算不准、不给节点撑宽,加上中文无空格不能自动断行,于是溢出。 把 <sub>...</sub> 降为普通的第二行文本(<br/> 保留换行,文字全保留, 仅不再小字号),mermaid 即可按副标题实际宽度撑宽节点。
1 parent 8f9ce32 commit e26445a

1 file changed

Lines changed: 66 additions & 46 deletions

File tree

README.md

Lines changed: 66 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
<p align="center">
2-
<img src="assets/banner.svg" alt="AI Engineering from Scratch — reference manual banner" width="100%">
2+
<img src="assets/banner.svg" alt="AI Engineering from Scratch · 简体中文版" width="100%">
33
</p>
44

55
<p align="center">
6-
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-1a1a1a?style=flat-square&labelColor=fafaf5" alt="MIT License"></a>
6+
<b>从零开始,亲手实现每一个 AI 算法</b><br/>
7+
<sub>503 节课 · 20 个阶段 · Python / TypeScript / Rust / Julia · 配套中文网站 <a href="https://aieng-zh.cn">aieng-zh.cn</a></sub>
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://aieng-zh.cn"><img src="https://img.shields.io/badge/在线阅读-aieng--zh.cn-3553ff?style=flat-square&labelColor=fafaf5" alt="在线阅读 aieng-zh.cn"></a>
712
<a href="ROADMAP.md"><img src="https://img.shields.io/badge/lessons-503-3553ff?style=flat-square&labelColor=fafaf5" alt="503 lessons"></a>
813
<a href="#contents"><img src="https://img.shields.io/badge/phases-20-3553ff?style=flat-square&labelColor=fafaf5" alt="20 phases"></a>
9-
<a href="https://github.com/fancyboi999/ai-engineering-from-scratch-zh/stargazers"><img src="https://img.shields.io/github/stars/fancyboi999/ai-engineering-from-scratch-zh?style=flat-square&labelColor=fafaf5&color=3553ff" alt="GitHub stars"></a>
10-
<a href="https://aieng-zh.cn"><img src="https://img.shields.io/badge/website-live-3553ff?style=flat-square&labelColor=fafaf5" alt="Website"></a>
14+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-1a1a1a?style=flat-square&labelColor=fafaf5" alt="MIT License"></a>
15+
<a href="https://github.com/fancyboi999/ai-engineering-from-scratch-zh/stargazers"><img src="https://img.shields.io/github/stars/fancyboi999/ai-engineering-from-scratch-zh?style=flat-square&labelColor=fafaf5&color=3553ff&cacheSeconds=21600" alt="GitHub stars"></a>
1116
</p>
1217

1318
```
@@ -22,9 +27,24 @@
2227
>
2328
> 你不只是学 AI,你亲手把它造出来。从头到尾,全手写。
2429
25-
> 本项目是 [AI Engineering from Scratch](https://github.com/rohitg00/ai-engineering-from-scratch) 的简体中文翻译版。感谢原作者 [Rohit Ghumare](https://github.com/rohitg00) 创作并开源了这套课程。
30+
> 本项目是 [AI Engineering from Scratch](https://github.com/rohitg00/ai-engineering-from-scratch)(作者 [Rohit Ghumare](https://github.com/rohitg00),MIT 协议)的**简体中文衍生版**。衷心感谢原作者创作并开源了这套课程。
31+
32+
### 这个中文版做了什么
33+
34+
不是机器翻译堆出来的镜像。在忠实翻译之上,我们做了一套面向中文读者的本地化:
35+
36+
| | |
37+
|---|---|
38+
| 🇨🇳 **全站简体中文** | 503 节课正文、83 条术语表、测验题、`mermaid` 流程图、交互图表标签全部中文化(`agent``token``transformer` 等技术术语按惯例保留英文) |
39+
| 🌐 **独立中文网站 [aieng-zh.cn](https://aieng-zh.cn)** | 可搜索的课程目录、学习进度追踪、可拖动的交互式图表、命令面板(`Cmd / Ctrl + K`)、深色模式 |
40+
| 🔍 **为 AI 检索优化** | 构建时自动生成 `sitemap.xml` / `llms.txt` / 结构化数据,方便被搜索引擎和 AI 助手引用 |
41+
|**课数一致性护栏** | CI 自动校验课程数(`node site/build.js --check`),防止课程列表与磁盘上的实际内容漂移 |
42+
43+
> 翻译怎么翻见 [TRANSLATION.md](TRANSLATION.md)。课程结构、代码与上游保持一致,译文持续跟进上游更新。
44+
45+
**目录** · [怎么运作](#怎么运作) · [课程结构](#课程的结构) · [一节课的样子](#一节课的样子) · [快速开始](#快速开始) · [每节课都有产出](#每节课都有产出) · [课程目录](#contents) · [工具箱](#工具箱) · [参与贡献](#参与贡献)
2646

27-
## How this works
47+
## 怎么运作
2848

2949
大多数 AI 教材都是碎片化教学。这儿一篇论文,那儿一篇微调心得,别处再来个炫酷的 agent
3050
demo。这些碎片很少能拼到一起。你做出了一个聊天机器人,却讲不清它的 loss 曲线;你给
@@ -41,33 +61,33 @@ agent 挂了个函数,却说不出调用它的那个模型内部,attention
4161
░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒
4262
```
4363

44-
## The shape of the curriculum
64+
## 课程的结构
4565

4666
二十个阶段层层叠起来。数学是地基,agent 和生产部署是屋顶。下层的东西你已经会了,就尽管
4767
往前跳;但别跳过去之后,又回头纳闷上层为什么塌了。
4868

4969
```mermaid
50-
%%{init: {'theme':'base','themeVariables':{'primaryColor':'#fafaf5','primaryTextColor':'#1a1a1a','primaryBorderColor':'#3553ff','lineColor':'#3553ff','fontFamily':'JetBrains Mono','fontSize':'12px'}}}%%
70+
%%{init: {'theme':'base','themeVariables':{'primaryColor':'#fafaf5','primaryTextColor':'#1a1a1a','primaryBorderColor':'#3553ff','lineColor':'#3553ff'}}}%%
5171
flowchart TB
52-
P0["Phase 0 — Setup &amp; Tooling"] --> P1["Phase 1 — Math Foundations"]
53-
P1 --> P2["Phase 2 — ML Fundamentals"]
54-
P2 --> P3["Phase 3 — Deep Learning Core"]
55-
P3 --> P4["Phase 4 — Vision"]
56-
P3 --> P5["Phase 5 NLP"]
57-
P3 --> P6["Phase 6 — Speech &amp; Audio"]
58-
P3 --> P9["Phase 9 — RL"]
59-
P5 --> P7["Phase 7 — Transformers"]
60-
P7 --> P8["Phase 8 — GenAI"]
61-
P7 --> P10["Phase 10 — LLMs from Scratch"]
62-
P10 --> P11["Phase 11 LLM Engineering"]
63-
P10 --> P12["Phase 12 — Multimodal"]
64-
P11 --> P13["Phase 13 — Tools &amp; Protocols"]
65-
P13 --> P14["Phase 14 Agent Engineering"]
66-
P14 --> P15["Phase 15 — Autonomous Systems"]
67-
P15 --> P16["Phase 16 — Multi-Agent &amp; Swarms"]
68-
P14 --> P17["Phase 17 — Infrastructure &amp; Production"]
69-
P15 --> P18["Phase 18 — Ethics &amp; Alignment"]
70-
P16 --> P19["Phase 19 — Capstone Projects"]
72+
P0["阶段 0 · 配置与工具链"] --> P1["阶段 1 · 数学基础"]
73+
P1 --> P2["阶段 2 · 机器学习基础"]
74+
P2 --> P3["阶段 3 · 深度学习核心"]
75+
P3 --> P4["阶段 4 · 计算机视觉"]
76+
P3 --> P5["阶段 5 · NLP"]
77+
P3 --> P6["阶段 6 · 语音与音频"]
78+
P3 --> P9["阶段 9 · 强化学习"]
79+
P5 --> P7["阶段 7 · Transformer"]
80+
P7 --> P8["阶段 8 · 生成式 AI"]
81+
P7 --> P10["阶段 10 · 从零实现 LLM"]
82+
P10 --> P11["阶段 11 · LLM 工程"]
83+
P10 --> P12["阶段 12 · 多模态 AI"]
84+
P11 --> P13["阶段 13 · 工具与协议"]
85+
P13 --> P14["阶段 14 · Agent 工程"]
86+
P14 --> P15["阶段 15 · 自主系统"]
87+
P15 --> P16["阶段 16 · 多 agent 与集群"]
88+
P14 --> P17["阶段 17 · 基础设施与生产"]
89+
P15 --> P18["阶段 18 · 伦理、安全与对齐"]
90+
P16 --> P19["阶段 19 · 综合项目"]
7191
P17 --> P19
7292
P18 --> P19
7393
```
@@ -76,7 +96,7 @@ flowchart TB
7696
░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒
7797
```
7898

79-
## The shape of a lesson
99+
## 一节课的样子
80100

81101
每节课都待在自己的文件夹里,整套课程结构统一:
82102

@@ -93,16 +113,16 @@ phases/<NN>-<phase-name>/<NN>-<lesson-name>/
93113
版本你自己写过。
94114

95115
```mermaid
96-
%%{init: {'theme':'base','themeVariables':{'primaryColor':'#fafaf5','primaryTextColor':'#1a1a1a','primaryBorderColor':'#3553ff','lineColor':'#3553ff','fontFamily':'JetBrains Mono','fontSize':'13px'}}}%%
116+
%%{init: {'theme':'base','themeVariables':{'primaryColor':'#fafaf5','primaryTextColor':'#1a1a1a','primaryBorderColor':'#3553ff','lineColor':'#3553ff'}}}%%
97117
flowchart LR
98-
M["MOTTO<br/><sub>one-line core idea</sub>"] --> Pr["PROBLEM<br/><sub>concrete pain</sub>"]
99-
Pr --> C["CONCEPT<br/><sub>diagrams &amp; intuition</sub>"]
100-
C --> B["BUILD IT<br/><sub>raw math, no frameworks</sub>"]
101-
B --> U["USE IT<br/><sub>same thing in PyTorch / sklearn</sub>"]
102-
U --> S["SHIP IT<br/><sub>prompt · skill · agent · MCP</sub>"]
118+
M["主旨<br/>一句话核心理念"] --> Pr["问题背景<br/>具体的痛点"]
119+
Pr --> C["核心概念<br/>图解与直觉"]
120+
C --> B["动手构建<br/>纯数学,不用框架"]
121+
B --> U["实际使用<br/>同样的事用 PyTorch / sklearn 跑一遍"]
122+
U --> S["拿去用<br/>提示词 · 技能 · agent · MCP"]
103123
```
104124

105-
## Getting started
125+
## 快速开始
106126

107127
三种入门方式。挑一个。
108128

@@ -149,7 +169,7 @@ ls phases/03-deep-learning-core/05-loss-functions/outputs/
149169
░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒
150170
```
151171

152-
## Every lesson ships something
172+
## 每节课都有产出
153173

154174
别的课程结尾是一句 *"恭喜,你学会了 X。"* 这里每节课的结尾,是一件你能直接装上、
155175
或粘进日常工作流的 **可复用工具**
@@ -170,7 +190,7 @@ ls phases/03-deep-learning-core/05-loss-functions/outputs/
170190
</table>
171191

172192
> `python3 scripts/install_skills.py` 一次性全部安装。是真家伙,不是课后作业。
173-
> 学完整套课程,你会攒下 435 件作品——你是真懂它们,因为它们都是你亲手造的。
193+
> 学完整套课程,你会攒下近 500 件产物——你是真懂它们,因为它们都是你亲手造的。
174194
175195
### FIG_002 · 一个实例
176196

@@ -230,7 +250,7 @@ the agent went wrong and explain why...
230250

231251
<a id="contents"></a>
232252

233-
## Contents
253+
## 课程目录
234254

235255
二十个阶段。点开任意阶段即可展开它的课程列表。
236256

@@ -936,7 +956,7 @@ outputs/
936956

937957
### 把所有课程技能装进你的 agent
938958

939-
仓库在 `phases/**/outputs/` 下交付了 378 个技能和 99 个提示词。
959+
仓库在 `phases/**/outputs/` 下交付了 388 个技能和 99 个提示词。
940960

941961
**推荐:通过 [skills.sh](https://skills.sh) 安装。** 不用 clone,不用 Python,
942962
自动识别你 agent 的技能目录:
@@ -973,7 +993,7 @@ python3 scripts/install_skills.py <target> --force # 覆
973993
`--dry-run` 预览冲突,或用 `--force` 覆盖。每次非 dry-run 的运行都会在目标里
974994
写一份 `manifest.json`,按类型和阶段分组列出完整清单。挑你 agent 读取的那种布局:
975995

976-
| `--layout` | Path written |
996+
| `--layout` | 写入路径 |
977997
|---|---|
978998
| `skills` | `<target>/<name>/SKILL.md`(嵌套约定,Claude / Cursor / Codex / OpenClaw / Hermes 都支持) |
979999
| `by-phase` | `<target>/phase-NN/<name>.md` |
@@ -1040,13 +1060,13 @@ python3 scripts/lesson_run.py --execute # 真正运行,每节课 10 秒
10401060

10411061
## 从哪里开始
10421062

1043-
| Background | Start at | Estimated time |
1063+
| 你的背景 | 从哪开始 | 预计时间 |
10441064
|---|---|---|
1045-
| 编程和 AI 都是新手 | Phase 0 — 配置 | ~306 hours |
1046-
| 会 Python,刚接触 ML | Phase 1 — 数学基础 | ~270 hours |
1047-
| 懂 ML,刚接触深度学习 | Phase 3 — 深度学习核心 | ~200 hours |
1048-
| 懂深度学习,想学 LLM 和 agent | Phase 10 — 从零实现 LLM | ~100 hours |
1049-
| 资深工程师,只想要 agent 工程 | Phase 14 — Agent 工程 | ~60 hours |
1065+
| 编程和 AI 都是新手 | 阶段 0 — 配置与工具链 | ~306 小时 |
1066+
| 会 Python,刚接触 ML | 阶段 1 — 数学基础 | ~270 小时 |
1067+
| 懂 ML,刚接触深度学习 | 阶段 3 — 深度学习核心 | ~200 小时 |
1068+
| 懂深度学习,想学 LLM 和 agent | 阶段 10 — 从零实现 LLM | ~100 小时 |
1069+
| 资深工程师,只想要 agent 工程 | 阶段 14 — Agent 工程 | ~60 小时 |
10501070

10511071
```
10521072
░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒░░░▒▒▒

0 commit comments

Comments
 (0)