目录治理规则
一句话定位:说明如何维护、扩展、更新这套因果模型笔记体系,保证长期可扩展性与风格一致性。
前置依赖:了解目录树结构(见 0-因果模型路线图)
一、内容治理原则
1.1 每篇笔记必须独立成文
- 一篇笔记讲一个明确的主题,不搞”这篇也提到一点、那篇也涉及一点”的混杂文章
- 如果某笔记内容膨胀到超过 3000 字,考虑拆成子笔记
- 每个 .md 文件必须有明确边界,不能出现”本篇涵盖 A、B、C 三个方向”的大杂烩
1.2 同一文件夹内的组织规则
允许的模式:
2-因果发现/1-静态因果发现/
├── 1-PC算法.md ← 专门讲 PC 算法
├── 2-GES算法.md ← 专门讲 GES 算法
└── 3-约束式与评分式方法.md ← 两类方法对比 + 历史脉络
不允许的模式:
2-因果发现/1-静态因果发现/
└── 1-因果发现综述.md ← 把 PC、GES、FCI、LiNGAM 全塞进一篇
1.3 命名规范
- 文件名格式:
编号-主题.md或编号-模型名.md - 编号使用连续的阿拉伯数字,从 1 开始
- 主题名用中文,简洁明了
- 不使用”论文精读”、“笔记”、“总结”等通用后缀
- 例如:
3-PC算法.md而不是PC算法笔记.md或PC算法_最终版.md
1.4 层级深度控制
- 建议最多到第三层子文件夹(即
X/Y/Z/),超过三层时优先通过文件名内的编号来区分 - 例如:
6-因果世界模型/2-关键论文/1-Causal World Models by Unsupervised Deconfounding.md - 如果某个方向内容极多(如 CRL 有 20+ 篇),可以在现有层级下继续分子文件夹
二、前置依赖与衔接标注规范
2.1 前置依赖标注
每篇笔记的开头必须标注前置依赖,格式如下:
前置依赖:
- 理解关联、干预与反事实的区别(1-关联、干预与反事实)
- 理解 DAG 与 d-separation(3-因果图DAG)
- 理解 do-calculus 基本规则(1-do算子)
其中 [ ] 内填 “已完成” 或留空表示未完成。
2.2 衔接标注
每篇笔记的结尾必须有”衔接到哪些后续笔记”章节,格式如下:
与前后内容的衔接:
- 继承:2-结构因果模型SCM — SCM 框架是本篇的基础
- 解决:克服了 PC 算法在连续数据上的局限性,引入了连续化优化路径
- 引出:2-DAG约束优化 — NOTEARS 将这一思路进一步泛化
2.3 符号一致性
- 首次引入的符号必须在该笔记内定义清楚
- 符号定义应与 2-术语表 保持一致
- 如果某符号在该笔记内有特殊含义,必须在开头说明”除非特别说明,本文使用…”
三、数学推导规范
3.1 公式写作要求
- 公式必须用 LaTeX 格式(
$...$或$$...$$)写出 - 每一步推导必须写出理由,不能只写”由…可得”
- 如果某一步使用了近似(如 variational lower bound、Monte Carlo 估计),必须:
- 明确标注”这里使用了近似”
- 写出误差项或误差上界
- 说明近似在什么条件下合理
3.2 变量定义规范
每篇笔记在”数学推导”章节的开头,必须先写:
设 ...
- $X \in \mathbb{R}^d$:...
- $Y \in \mathbb{R}$:...
- $Z$:协变量集合,$Z = (Z_1, ..., Z_k)$
- $U$:未观测混杂
3.3 推导连续性
- 关键等式不能断在”由对称性可得”,要写出对称性具体是什么
- 反事实推理步骤必须一步步写清楚,不允许只写”同理可得”
四、论文精读规范
4.1 单篇论文笔记必须包含
- 论文基本信息:标题、作者、年份、顶会/顶刊、链接
- 关键问题:这篇论文试图解决什么问题
- 与前作的改进:它相对已有工作改进了什么
- 模型结构:核心模块、模块之间的关系(用文字或伪图描述)
- 数学推导:核心公式的完整推导,不能只抄结论
- 训练细节:目标函数、优化方法、训练流程
- 实验设置:数据、基准、评测指标
- 贡献与局限:最大贡献、已知局限
- 引出后续:这篇论文如何引出下一篇
4.2 多论文关系的处理
如果 A 论文是 B 论文的改进版,在 A 的笔记中要写:
相对 论文B(…),本文将 X 替换为 Y,主要改进在于…
在 B 的笔记末尾要写:
后续工作 论文A 在本工作的基础上进一步改进…
五、文件更新与版本管理
5.1 更新原则
- 发现错误时直接修正,不需要注明”之前写的是错的”
- 如果某笔记内容需要大规模重写,先在原文件上修改
- 不使用
文件名_旧版.md这类备份文件
5.2 扩展原则
- 新增笔记必须在正确的层级位置插入,使用连续编号
- 如果新增内容是全新子方向,先建子文件夹,再建笔记
- 不允许在已有笔记中”追加”新内容到末尾——应该创建独立新文件
5.3 删除原则
- 如果某笔记内容已完全被新笔记取代,删除旧文件
- 如果某子文件夹下所有笔记都迁移到其他位置,删除空文件夹
六、质量检查清单
每篇笔记提交前必须自查:
- 是否独立成文、主题边界清晰?
- 是否标注了前置依赖?
- 是否在结尾写了衔接关系?
- 公式是否完整、每步有理由、涉及近似时是否说明了误差来源?
- 变量是否在推导前定义?
- 文件命名是否符合
编号-主题.md格式? - 是否没有使用”论文精读”、“笔记”等通用后缀?
- 关键词是否填写(便于检索)?
关键词
目录治理规则 | 笔记维护规范 | 文件命名 | 前置依赖 | 质量检查清单