仓库约定
除 Luna Flow 文档规范外,autodiff 手册还遵循以下规则。
页面命名
- 根包
Luna-Flow/autodiff以autodiff为名编写文档(api/autodiff.md、tutorial/autodiff.md、design/autodiff.md),因为core这个名字属于src/core包。 - 其他每个包的页面都以它在
src/下的目录命名。 examples和tests包没有单独的页面;概览 对它们作了介绍。
术语
- 包的术语应与
luna-generic和arithmetic中的 Luna Flow 命名保持一致。 - 与代码一致,将对偶数的两个分量称为 值(value)和 切向分量(tangent)。
- 不得把
Dual[T]描述为域或有序标量。
示例
- 示例使用别名
@autodiff、@dual、@forward、@linalg、@poly、@checked、@elementary、@ad_core(对应Luna-Flow/autodiff/core)、@la(对应Luna-Flow/linear-algebra/immut)、@dense和@sparse。 - 含有
fn main的程序后面紧跟一个text代码块,给出其确切输出。
范围
- 未来工作必须明确标注为未来工作。