多彩编程 多彩编程MZPH · CODE BLOG
ARTICLE DETAIL

文章详情

深耕前端与后端开发技术的一线实战笔记与踩坑复盘。

AISystem 课程文档入口 sphinx_index.md 全解:AI 系统全栈知识体系与 Sphinx 建站实践

AISystem 课程文档入口 sphinx_index.md 全解:AI 系统全栈知识体系与 Sphinx 建站实践 文档教程人工智能【免费下载链接】AISystemAISystem 主要是指AI系统包括AI芯片、AI编译器、AI推理和训练框架等AI全栈底层技术项目地址https://gitcode.com/GitHub_Trending/ai/AISystem点击查看免费下载build_books/sphinx_index.md是整个 AISystemAI 系统开源课程在 Sphinx 文档体系中的主索引文件master document承担着项目简介 课程大纲 目录导航三位一体的职责也是六大知识模块的权威导览。本文以该文件为主线逐层拆解课程内容大纲、toctree目录结构与仓库目录的映射关系并结合build_books目录下的构建脚本与 Sphinx 配置完整还原一份 Markdown 如何组织成一套 AI 系统全栈课程文档的工程链路帮助你快速定位课程内容并理解其知识体系设计。一、文档定位课程文档的导航中枢在 Sphinx 文档工程中master_doc index见 sphinx_conf.py决定了构建入口文档必须是名为index的文件而sphinx_index.md正是这一入口。它的头部 Front Matter 声明了文档标题--- title: AISystem AIInfra ---正文开头使用 Sphinx Design 扩展提供的grid/grid-item卡片布局展示项目 Logo随后直接给出全项目的定位说明本开源项目主要是跟大家一起探讨和学习 AI、深度学习的系统设计而整个系统是围绕着在 NVIDIA、ASCEND 等芯片厂商构建算力层面所用到的、积累、梳理得到 AI 系统全栈的内容。紧接着插入一张AI 系统全栈架构图作为整门课程的知识地图。这张图在仓库中的实际路径为 01Introduction/images/03Architecture03.png由此可见sphinx_index.md并非普通章节而是整份课程文档的总目录与导航中枢它决定了一本书的骨架读者从这份索引出发即可按模块顺序进入任意章节。二、课程内容大纲六大模块的知识体系sphinx_index.md用 课程内容大纲 一节将课程组织为六大模块依次从基础走向应用、再从应用走向总结。各模块的仓库入口如下表模块主题内容概要仓库入口第一部分AI 系统概述AI 基础知识和 AI 系统的全栈概述以及深度学习系统的系统性设计和方法论整体了解 AI 训练和推理全栈的体系结构01Introduction/README.md第二部分AI 芯片概况硬核篇从芯片基础到 AI 芯片的范围都会涉及芯片设计需要考虑上面 AI 框架的前端、后端编译而不是停留在天天喊着吊打英伟达被现实打趴02Hardware/README.md第三部分AI 编程与计算架构进阶篇站在系统设计的角度思考现代机器学习系统中需要考虑的编译器问题特别是中间表达乃至后端优化03Compiler/README.md第四部分推理系统与引擎实际应用回归业务本质让行业、企业能够真正应用起来并分享推理系统涉及的核心算法与注意事项04Inference/README.md第五部分AI 框架核心技术介绍自动微分、计算图与算子、框架前端优化以及大模型分布式训练在 AI 框架中的关键技术05Framework/README.md第六部分大模型与 AI 系统汇总篇大模型基于 AI 集群的全栈软硬件性能优化涉及集合通信、分布式加速库、AI Agent 等后续独立展开见下文说明第六部分大模型与 AI 系统在文档中作了特别标注由于内容过多已引起整个 AI 产业和周边的网络、存储、通讯、机房建设风火水电等基础设施联动AI 系统上也加入了更多集合通信、分布式加速库、AI Agent 等内容因此将独立成一个大内容后续再详细展开。这也是理解仓库后续演进方向的关键线索。六大模块的细分章节内容可分别在各模块的README.md中继续深入例如 02Hardware/README.md 进一步拆分为 AI 计算体系、AI 芯片基础、GPU、英伟达 GPU 详解、国外/国内 AI 芯片、AI 芯片黄金十年等主题03Compiler/README.md 则覆盖传统编译器、AI 编译器、前端优化、后端优化、多面体与 PyTorch 图模式等方向。三、课程设立目的与先修要求无法成文判定不适用于本文档其课程设立目的一节明确给出了目标受众与培养方向目标人群本科生高年级、硕博研究生、AI 系统从业者培养目标一完整了解 AI 的计算机系统架构并通过实际问题和案例了解 AI 完整生命周期下的系统设计培养目标二介绍前沿系统架构和 AI 相结合的研究工作通过主流框架、平台和工具来了解 AI 系统先修课程C/Python、计算机体系结构、人工智能基础。该定位与 01Introduction/README.md 中的课程前言相互印证课程旨在衔接AI 算法与计算机结构体系两大学科弥补国内外缺乏系统性 AI 系统教材的空白并已被用作高校硕博课程配套教材。四、课程目录toctree 与仓库目录的映射关系sphinx_index.md的核心工程价值在于其toctree指令——它决定了文档站点侧边栏的层级结构与阅读顺序。文档按模块划分了六个toctree块均使用:maxdepth: 1与自定义:caption:生成带分组标题的导航:maxdepth: 1 :caption: 一. AI 系统概述 01Introduction/README需要注意的是toctree中出现的条目名如02Hardware01Foundation/README是书籍构建过程中生成的扁平目录名与仓库原始目录存在一对一的对应关系。下表给出 toctree 条目与仓库实际路径的完整映射各README均指向README.mdtoctree 条目对应仓库目录01Introduction/README01Introduction/README.md02Hardware/README、02Hardware01Foundation/README、02Hardware02ChipBase/README、02Hardware03GPUBase/README、02Hardware04NVIDIA/README、02Hardware05Abroad/README、02Hardware06Domestic/README、02Hardware07Thought/README02Hardware/README.md 及其 01Foundation、02ChipBase、03GPUBase、04NVIDIA、05Abroad、06Domestic、07Thought 各子目录03Compiler/README、03Compiler01Tradition/README、03Compiler02AICompiler/README、03Compiler03Frontend/README、03Compiler04Backend/README03Compiler/README.md 及其 01Tradition、02AICompiler、03Frontend、04Backend 各子目录04Inference/README、04Inference01Inference/README、04Inference02Mobilenet/README、04Inference03Slim/README、04Inference04Converter/README、04Inference05Optimize/README、04Inference06Kernel/README04Inference/README.md 及其 01Inference、02Mobilenet、03Slim、04Converter、05Optimize、06Kernel 各子目录05Framework/README、05Framework01Foundation/README、05Framework02AutoDiff/README、05Framework03DataFlow/README、05Framework04Parallel/README05Framework/README.md 及其 01Foundation、02AutoDiff、03DataFlow、04Parallel 各子目录00Others/README附录内容00Others/README.md从上述对照可以看出仓库原始目录采用模块序号 章节号两级结构如02Hardware/03GPUBase/而 toctree 中的扁平条目如02Hardware03GPUBase是把两级目录名直接拼接后的产物。这种命名惯例正是下一节构建脚本的核心逻辑。值得补充的是仓库中还存在未进入当前版 toctree 的扩展目录例如 03Compiler/06PyTorch、03Compiler/07CANN、05Framework/05AICluster、05Framework/06AIAlgo 等这体现了课程持续扩充、索引同步演进的迭代节奏。五、从仓库目录到文档目录create_dir.py 的自动整理toctree中的扁平命名并非手工编写而是由 build_books/create_dir.py 自动化完成的。该脚本的核心逻辑可对照源码逐行验证包括1. 目录合并命名create_dir遍历五大模块目录下的子目录将父目录名 子目录名拼接为扁平目录源码中new_dir_name .join(file_dist[-2:])这正是02Hardware03GPUBase等名称的由来。2. images 归拢与路径重写脚本把各章节images/目录统一复制到中央images/章节名/下并调用change_iamgepath_markdown将 Markdown 中的图片引用从images/01CPUBase01.png改写为../images/02Hardware02ChipBase/01CPUBase01.png形式的全局路径保证文档迁移后图片仍能正确解析。3. toctree 自动追加get_subfile会扫描目录下所有.md文件跳过README.md本身按文件名生成toctree块并追加写入该目录的README.md实现每个章节目录天然携带子导航的效果同时将.pdf文件一并迁移。4. 构建输入准备脚本最后指定了五大来源目录01Introduction至05Framework与书籍源目录AISystem_BOOK/source/形成仓库 → 书籍源的流水线。同目录下的 convert2tex.py 目前保留了marktex pathxxxx -o ./的转换提示从工具链分工看它用于后续把 Markdown 课程内容转换为 TeX 排版格式watermark.py 则承担图片水印处理。整体上build_books是课程仓库 → 文档书 → 站点生产流程的辅助工具集而sphinx_index.md正是这条流水线最终输出的导航骨架。六、Sphinx 构建配置sphinx_conf.py 的工程化细节要理解sphinx_index.md中各类指令grid、{image}、toctree、:::{...}:::标注块为何可用需要看 build_books/sphinx_conf.py 中的扩展配置。从源码可以确认以下关键工程决策项目信息project AISystem AIInfra (AI 系统原理)language cnmaster_doc index文档格式启用myst_nb解析 Markdown/Notebook并在myst_enable_extensions中开启dollarmathLaTeX 数学、amsmath、deflist定义列表、colon_fence冒号围栏等扩展支持grid卡片、数学公式与自定义标注渲染主题使用sphinx_book_theme图书风格主题html_title AI System并配置了 Logo、favicon 与show_toc_level: 3的三级目录展示交互增强启用sphinx_copybutton代码复制按钮、sphinx_togglebutton、sphinx_tabs、sphinx_thebe在线执行等扩展主题选项中配置了 Binder、Google Colab、Deepnote 的launch_buttons可将含 Notebook 的章节一键投放到在线环境执行交叉引用与排版启用intersphinx、ablog、numpydoc、sphinxcontrib.bibtex参考文献、sphinxext.opengraph社交卡片等并通过numfig True开启公式/图片编号。这些配置与sphinx_index.md中的{toctree}、{grid}语法一一对应构成了完整的可复现建站环境。七、如何阅读与使用本课程对学习者而言推荐两条阅读路径路径一按目录顺序通读从 01Introduction/README.md 开始沿02Hardware → 03Compiler → 04Inference → 05Framework的模块顺序先建立AI 系统全栈的宏观视野再逐层深入芯片、编译器、推理引擎与框架内核。每个章节目录的README.md都带有toctree可自然下沉到小节。路径二按需检索主题通过本仓库根目录 README.md 的课程部分表格或附录 00Others/README.md 中整理的书写规范、安装指南、词汇表03Glossary.md、推理与评判标准等配套文档快速定位所需知识点。获取方式说明仓库体积较大包含全部制作过程与高清原图如需完整拉取可执行git clone https://gitcode.com/GitHub_Trending/ai/AISystem若只需要特定章节的 PDF/PPTX/图片素材建议直接按需下载对应目录。仓库内每一章均同时提供.md、.pdf、.pptx三种形态如 02Hardware/03GPUBase 目录下含01Works.md/01Works.pdf/01Works.pptx与配套代码、字幕便于不同使用场景取用。八、附录与参与贡献附录内容00Others/README.md 汇总了课程书写规范与配套工具包括编辑器说明01Editors.md、环境安装02Install.md、术语表03Glossary.md、推理与评价标准04Inference.md、05Criterion.md等方便读者在阅读正文时随时查证参与方式文档明确欢迎社区共建——使用过程中发现 bug 或勘误可直接向开源社区提交 PR也可以参与字幕补充、内容校对与细化等工作共同维护这套 AI 系统全栈课程的质量引用规范请尊重开源作者的劳动成果引用 PPT 与文字内容时规范转载并标明出处。综上sphinx_index.md表面上看是一份目录文件实际上承载着课程的知识体系设计、导航组织与构建入口三重角色。理解它的结构、toctree命名规则与配套构建脚本你就能以它为索引在数千个文件组成的 AISystem 仓库中快速建立自己的 AI 系统学习地图。赞分享文档教程人工智能【免费下载链接】AISystemAISystem 主要是指AI系统包括AI芯片、AI编译器、AI推理和训练框架等AI全栈底层技术项目地址https://gitcode.com/GitHub_Trending/ai/AISystem点击查看免费下载相关推荐AISystem 开源课程开篇构建 AI 历史、驱动力与全栈架构的系统化认知框架AISystem 开源课程开篇构建 AI 历史、驱动力与全栈架构的系统化认知框架 导读 本文基于开源仓库 AISystem 中 01Introduction文档教程人工智能Gopeed下载管理器在Win7上闪退这份旧系统兼容修复排查清单请收好Gopeed下载管理器在Win7上闪退这份旧系统兼容修复排查清单请收好 朋友的老台式机还停在 Windows 7他想装个下载工具结果双击 Gopeed 后网络CLI后端AI 系统全栈技术图谱从 AI 芯片到推理引擎的体系化学习路线AISystem 开源课程导读AI 系统全栈技术图谱从 AI 芯片到推理引擎的体系化学习路线AISystem 开源课程导读 本篇文章以开源仓库 AISystem 的根 README.m文档教程人工智能上一篇RePKG终极指南如何高效提取和转换Wallpaper Engine资源下一篇RePKG解锁Wallpaper Engine资源宝库的终极工具创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表