Skip to content

Latest commit

 

History

History
executable file
·
112 lines (76 loc) · 2.98 KB

File metadata and controls

executable file
·
112 lines (76 loc) · 2.98 KB

《AI中的数学》教材 Issue 报告格式规范

Issue title 格式

类型(章节)问题简要描述

Issue 类型:

  • typo: 错别字、拼写或语法错误
  • format: 排版问题,如溢出、对齐等
  • enhance: 内容增补或扩展
  • suggest: 对内容的建议或意见
  • other: 其他问题(如果你的问题不属于上述类型)

示例:

  • typo:(第 1.1 节)拼写错误
  • format:(第 2.2 节)方程溢出页面边距
  • enhance:(第 3.3 节)补充证明
  • suggest:(第 3.4 节)定义 3.2 的陈述难以理解

Issue description 格式

必需信息

  1. checklist:

    • 阅读并遵守了 Issue 规范
    • 确认这是最新版本 PDF 中的错误
    • 搜索过之前的 Issue,确保这个问题没有被提出过
  2. 位置:

    • PDF 页码
    • 节号/节名
    • 在该页的段落数
    • LaTeX 源代码的文件名、行号(如果知道)
  3. 原始内容:

    • 引用相关文本(能够在该页快速定位)
    • 对于数学内容,使用 LaTeX 代码
    • 必要时附上截图(尤其是排版问题)
  4. 问题描述:

    • 清晰说明问题
    • 建议的修改方案
    • 修改理由(如有需要)

示例(除了 checklist 外)

typo 问题示例

typo: (第 1.1 节)拼写错误

位置:第 5 页,第 1.1 节,第 2 段

源文件:plausible-reasoning.tex,第 42 行

原文:

韩素 $f$ 在点 $x = a$ 处是连续的...

问题:

“韩素”应改为“函数”。

format 问题示例

format:(第 2.2 节)方程溢出页面边距

位置:第 15 页,第 2.2 节

源文件:Markov-chain.tex,第 23 行

原文:

$$\sum_{i=1}^n p_{ij} = 1.$$

问题:

方程溢出页面边距,需要调整排版。

enhance 问题示例

enhance:(第 3.3 节)补充证明

位置:第 20 页,第 3.3 节

源文件:probability.tex,第 50 行

原文:

显然,$P(A \cup B)\leq P(A) + P(B)$。

问题:

证明过程不够详细,建议修改为:

根据 union bound 不等式,我们有 $P(A \cup B)\leq P(A) + P(B)$

suggest 问题示例

suggest:(第 3.4 节)定义 3.2 的陈述难以理解

位置:第 30 页,第 3.4 节

源文件:probability.tex,第 70 行

原文:

定义(条件期望)
$(\Omega, \mathcal{F}, \mathbb{P})$ 是一个概率空间,$X$ 是一个可积的随机变量(即 $\mathbb{E}[|X|] < \infty$),且 $\mathcal{G} \subseteq \mathcal{F}$ 是一个子 $\sigma$-代数。则 $X$ 关于 $\mathcal{G}$条件期望,...

问题:

我不能理解“子 $\sigma$-代数”是什么意思。

通用准则

  1. 每个问题单独提交一个 issue
  2. 使用 Markdown 语法
  3. 数学表达式使用 LaTeX 语法(用 $ 符号包围)
  4. 多个相关问题使用项目符号列出
  5. 只有文字无法描述的问题才需要附上截图

注意

遵循此格式有助于维护者快速理解和处理问题,提高教材改进效率。