机器学习笔记写作指南 (Writing Guidelines)#
核心原则#
顶级质量标准
- 教科书级的严谨:数学定义必须精确,符号规范统一。
- 小说级的可读性:语言通俗易懂,避免枯燥的教科书式说教。
- 工程师级的实战:每个概念都要回答"在机器学习中有什么用"。
内容结构规范
- 定义 (Definition):严格的数学表达。
- 直觉 (Intuition):用生活案例、几何图像或物理意义解释。
- 数学推导 (Derivation):核心公式必须推导,展示逻辑链条。
- 可视化 (Visualization):文字描述图形,帮助建立心理表征。
- ML应用 (Application):连接到具体的算法或模型。
风格指南
- 避免:口语化表达(如"老铁"、“搞定”)、模糊的描述(“显然”、“容易看出”)。
- 提倡:学术专业术语、清晰的逻辑连接词、第一人称引导(“我们要解决…")。
- 格式:
- 向量用粗体小写 $\mathbf{x}$,矩阵用粗体大写 $\mathbf{A}$。
- 重点内容使用引用块
>或加粗。 - 公式使用 LaTeX 块
$$ ... $$。
章节模板#
# 第XX章:[章节标题]
> **前言**
>
> [一段引人入胜的开场白,阐述本章的核心价值和学习目标。不仅要说学什么,更要说为什么学,以及学完后的思维升级。]
---
## 目录
- [X.1 核心概念一](#...)
- [X.2 核心概念二](#...)
...
---
## X.1 [核心概念一]
### 定义与直觉
[严格数学定义]
> **直觉/几何意义**
>
> [用通俗语言或几何视角解释。例如:投影就是向量在子空间上的"影子"。]
### 数学推导
[核心公式的推导过程]
### 在机器学习中的应用
- **应用场景1**:[解释]
- **应用场景2**:[解释]
...质量检查清单 (Checklist)#
- 完整性:是否覆盖了该主题的所有核心知识点?
- 深度:是否触及了本质(Worldview),而不仅仅是表象?
- 连贯性:章节之间是否流畅过渡,概念引用是否清晰?
- 准确性:公式、符号、定理描述是否百分百正确?
- 实战性:是否给出了具体的例子或数值计算过程?
常用 LaTeX 符号规范#
- 向量:
\mathbf{x}($\mathbf{x}$) - 矩阵:
\mathbf{A}($\mathbf{A}$) - 此集:
\mathbb{R}^n($\mathbb{R}^n$) - 梯度:
\nabla($\nabla$) - 偏导:
\partial($\partial$) - 期望:
\mathbb{E}($\mathbb{E}$) - 损失函数:
\mathcal{L}($\mathcal{L}$)