本文档描述了存储库中使用的文档生成和管理系统。该系统将注释过的源代码转换为全面的、多语言的文档，并提供并排的代码和解释。如果您正在寻找有关机器学习算法实际实现的信息，请参阅相应的算法文档页面。
labml_nn 文档系统将注释过的 Python 源代码转换为一个可读、可导航的网站（https://nn.labml.ai），并提供代码和解释的并排视图。这种方法允许开发人员维护一个单一的事实来源，同时生成详细的文档，帮助读者理解复杂的机器学习算法实现。
来源：docs/sitemap.xml1-1467 labml_nn/__init__.py1-153 docs/index.html1-221
文档遵循一致的格式，将代码与解释一起呈现，以帮助读者理解实现细节。
文档显示左侧为解释，右侧为相应的代码，允许读者在阅读解释的同时跟进代码实现。
来源：docs/index.html45-175 docs/transformers/index.html44-125
文档按主题分层组织，每个实现都有自己的部分。这种结构便于导航和查找特定实现。
来源：docs/sitemap.xml1-1467 docs/index.html72-169 docs/transformers/index.html73-116
文档是使用经过特殊格式化、带有详细文档字符串的 Python 源代码生成的，这些文档字符串使用了 markdown 格式。这使得代码和文档可以一起维护。
源代码包含作为文档基础的文档字符串。这些文档字符串使用 markdown 格式实现富文本功能。
示例注释模式
"""
# Title
This is a description of what the module/class/function does.
## Subtitle
More detailed explanation with:
- Bullet points
- Mathematical formulas
- Links to papers
"""
来源：labml_nn/transformers/__init__.py1-110 labml_nn/__init__.py1-153
文档是使用自定义工具生成的，该工具提取文档字符串和代码，进行格式化，并生成 HTML 文件。
来源：utils/papers_list.py1-93 docs/index.html1-221
文档系统支持多种语言，方便用户阅读所需语言的文档。
文档通过自动翻译和人工审校相结合的方式翻译成多种语言（目前包括中文和日文）。
来源：translate_cache/__init__.zh.json1-52 docs/zh/sitemap.xml1-558 docs/zh/index.html1-221 docs/zh/lora/index.html1-384
网站提供了不同语言版本页面之间的便捷导航，允许用户根据需要切换语言。
来源：labml_nn/__init__.py17-22 docs/index.html72-79 docs/zh/index.html77-79
文档系统包含一个将实现与其来源的原始研究论文链接的机制。
一个实用脚本从源代码注释中提取论文引用（arXiv ID），并生成一个 JSON 文件，将这些引用映射到相关的文档页面。
来源：utils/papers_list.py1-93 docs/papers.json1-192
源代码中的论文引用遵循一致的格式，便于提取和链接到原始论文。
# Implementation of [Paper Title](https://arxiv.org/abs/XXXX.XXXXX)
来源：utils/papers_list.py11-16 labml_nn/transformers/__init__.py46-109
文档被构建并发布为静态网站，使其快速可靠。
文档系统会生成一系列按主题组织的 HTML 文件，并包含特殊的索引文件用于导航。
来源： docs/sitemap.xml1-1467 readme.md1-150 docs/index.html1-221
文档系统为每种语言生成站点地图文件，帮助搜索引擎正确索引内容。
来源： docs/sitemap.xml1-1467 docs/zh/sitemap.xml1-558
文档系统已集成到开发工作流程中，确保代码和文档保持同步。
来源： readme.md1-150 utils/papers_list.py73-92
文档包含多项功能，可提升阅读体验。
文档支持使用 KaTeX 的 LaTeX 风格数学符号，可正确显示复杂的数学公式。
来源： docs/index.html26-27 docs/zh/lora/index.html27
文档对代码片段包含语法高亮，使其更易于阅读和理解。
来源： docs/index.html173-174 docs/transformers/index.html120-123
文档包含一些交互式元素，例如图片缩放和导航增强。
来源： docs/index.html180-218 docs/transformers/index.html130-168
文档系统提供了一种全面、易于维护且易于访问的方式来记录机器学习算法实现。通过将代码和文档放在一起，可以确保它们保持同步，而并排展示则有助于读者更轻松地理解实现细节。