リポジトリの規約
autodiff のマニュアルには、Luna Flow のドキュメント標準に加えて次の規則が適用されます。
ページ名
- ルートパッケージ
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ブロックで示します。
範囲
- 将来作業は明確に将来作業として示す。