文件最后提交记录最后更新时间
[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力,文档以原始 Markdown 形式放在仓库中,阅读体验差、导航结构不清晰,在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施,支持通过 ReadTheDocs 在线发布中文文档,同时修复文档链接、适配 pre-commit 检查、优化代码块渲染,为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件,基于 MkDocs Material 主题,配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置,使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置,覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook,将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法(支持 >- 列表嵌套语法) 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook,将 HTML <img> 标签(含 width 属性)转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式:定义 announcement、important、code、console 四种 Admonition 类型样式,Tabbed 组件样式,代码块系统等宽字体(不换行 + tab-size: 8) 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md):添加居中大标题和副标题、导航栏(昇腾社区 / 文档中心 / 代码仓库 / 社区会议),所有文档链接替换为 ReadTheDocs 在线地址,修复原有 2 个断链(install/README.mduser_manual/README.md) 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page,包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效:nofification 拼写错误、FAQ 路径 faq/faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致:multi_loRA.mdmulti_lora.mdsplitFuse.mdsplit_fuse.md,同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md(保留 installation_in_containerized.md) ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$,跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施,重构中文文档首页和项目 README,修复多处文档链接失效,新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过,站点可正常访问,页面渲染正确 - 导航链接已逐一确认,所有页面可正常跳转 - 明暗主题切换正常,Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过,> [!NOTE]> [!WARNING]> [!TIP]> [!CAUTION]> [!IMPORTANT] 均可正确转换(含 >- 列表嵌套语法) - 代码块系统等宽字体渲染正常,box-drawing 字符对齐正确(Mac / Windows / ReadTheDocs 已验证) - 搜索功能正常,支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过(mkdocs.yml 已排除 check-yaml) # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!7241 个月前
[Doc]Fix markdown indentation and trailing whitespace issues (part 1) Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !1017 merge A00254_1 into dev [Doc]Fix markdown indentation and trailing whitespace issues (part 1) Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 全量扫描仓库200个Markdown文件,修复缩进格式问题,消除git diff噪音。 Fixes #585 # 修改内容 1. 扫描全部 Markdown 文件的缩进格式——heading、blockquote、list 缩进均合规,无需修改 2. 清理48个Markdown文件的尾随空格(trailing whitespace),共217行 3. 新增 scripts/fix_markdown_trailing_whitespace.py 脚本,支持 --check 模式用于后续CI检查 # 资料变更 涉及。清理了 docs/ 和 examples/ 下共48个Markdown文件的尾随空格,纯格式清理,无内容变更。 # 接口变更 不涉及 # 测试结果 纯文档格式清理,不涉及功能/性能/精度变更。 验证方式:全量扫描确认尾随空格清零,git diff 确认仅空格变更,无内容改动。 # CheckList > PR提交人对以下CheckList自检项进行全量自检,自检通过或不涉及,均修改 [ ] 为 [x]。 - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-coding-style-guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-secure-coding-guide.md) See merge request: Ascend/MindIE-LLM!10174 天前
[Doc]Fix markdown indentation and trailing whitespace issues (part 1) Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !1017 merge A00254_1 into dev [Doc]Fix markdown indentation and trailing whitespace issues (part 1) Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 全量扫描仓库200个Markdown文件,修复缩进格式问题,消除git diff噪音。 Fixes #585 # 修改内容 1. 扫描全部 Markdown 文件的缩进格式——heading、blockquote、list 缩进均合规,无需修改 2. 清理48个Markdown文件的尾随空格(trailing whitespace),共217行 3. 新增 scripts/fix_markdown_trailing_whitespace.py 脚本,支持 --check 模式用于后续CI检查 # 资料变更 涉及。清理了 docs/ 和 examples/ 下共48个Markdown文件的尾随空格,纯格式清理,无内容变更。 # 接口变更 不涉及 # 测试结果 纯文档格式清理,不涉及功能/性能/精度变更。 验证方式:全量扫描确认尾随空格清零,git diff 确认仅空格变更,无内容改动。 # CheckList > PR提交人对以下CheckList自检项进行全量自检,自检通过或不涉及,均修改 [ ] 为 [x]。 - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-coding-style-guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-secure-coding-guide.md) See merge request: Ascend/MindIE-LLM!10174 天前
[doc] 2.3.0资料刷新返合代码仓 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !579 merge dev into dev [doc] 2.3.0资料刷新返合代码仓 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: Fixes [#296](https://gitcode.com/Ascend/MindIE-LLM/issues/296) 2.3.0社区资料刷新返合代码仓,包括如下: 1、删除LLM组件的老环境变量,同时增加同时增加“PYTHON_LOG_MAXSIZE”环境变量的下线和兼容说明。 2、Prefix Cache和SplitFuse特性,暂不支持和beamsearch叠加。---根据评审意见,两个特性支持beamsearch。这条资料不做修改 3、KV Cache池化特性增加限制约束:底层使用HCCL单边通信的池化后端的相关说明。 4、KV Cache池化特性中,增加池化异步参数“asyncWrite” 5、增加负载均衡表的采集场景说明,建议在短序列下采集,长序列场景下可能会出现OOM 6、为HOST_IP环境变量,补充使用用途。 7、增加Function Call报文的层数限制。 8、修改部分书写不规范和格式等问题。 See merge request: Ascend/MindIE-LLM!5792 个月前
[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力,文档以原始 Markdown 形式放在仓库中,阅读体验差、导航结构不清晰,在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施,支持通过 ReadTheDocs 在线发布中文文档,同时修复文档链接、适配 pre-commit 检查、优化代码块渲染,为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件,基于 MkDocs Material 主题,配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置,使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置,覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook,将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法(支持 >- 列表嵌套语法) 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook,将 HTML <img> 标签(含 width 属性)转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式:定义 announcement、important、code、console 四种 Admonition 类型样式,Tabbed 组件样式,代码块系统等宽字体(不换行 + tab-size: 8) 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md):添加居中大标题和副标题、导航栏(昇腾社区 / 文档中心 / 代码仓库 / 社区会议),所有文档链接替换为 ReadTheDocs 在线地址,修复原有 2 个断链(install/README.mduser_manual/README.md) 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page,包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效:nofification 拼写错误、FAQ 路径 faq/faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致:multi_loRA.mdmulti_lora.mdsplitFuse.mdsplit_fuse.md,同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md(保留 installation_in_containerized.md) ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$,跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施,重构中文文档首页和项目 README,修复多处文档链接失效,新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过,站点可正常访问,页面渲染正确 - 导航链接已逐一确认,所有页面可正常跳转 - 明暗主题切换正常,Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过,> [!NOTE]> [!WARNING]> [!TIP]> [!CAUTION]> [!IMPORTANT] 均可正确转换(含 >- 列表嵌套语法) - 代码块系统等宽字体渲染正常,box-drawing 字符对齐正确(Mac / Windows / ReadTheDocs 已验证) - 搜索功能正常,支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过(mkdocs.yml 已排除 check-yaml) # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!7241 个月前
fix(doc): 修复 quick_start.md 文档及 mkdocs 渲染问题 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !1019 merge A00252 into dev fix(doc): 修复 quick_start.md 文档及 mkdocs 渲染问题 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes https://gitcode.com/Ascend/MindIE-LLM/issues/591 根据 issue #591 的用户反馈,修复 quick_start.md 在 mkdocs 渲染、命令可用性、格式规范性等方面的问题,同时补充 whl 包安装方式的差异化说明,提升文档的可用性和准确性。 本次 PR 还同步了 upstream/dev 的最新代码,并解决了 merge 冲突。 # 修改内容 本次 PR 涉及对 quick_start.md 文档、mkdocs 渲染 hook 以及 mkdocs 配置的修改: ### 1. 修复 quick_start.md 格式、命令及 mkdocs 渲染问题 **命令修复:** - --shm-size1g 改为 500g,避免大模型推理时共享内存不足 - 镜像名称从硬编码的 mindie:3.0.0-800I-A2-py311-openeuler24.03-lts 替换为 {IMAGE_ID} 占位符,用户根据实际下载的镜像替换 - 数据集名称 demo_gsm8k_*gsm8k_*,修正为正确的数据集名 - 精度测试命令 --models vllm_api_general_chatvllm_api_stream_chat,与配置文件一致 - 精度测试回显中 demo_gsm8kgsm8kvllm_api_general_chatvllm_api_stream_chat - 环境变量步骤锚点 ID 从 step3 改为 setup_env,语义更清晰 **内容增补:** - 表 2(容器内各组件安装路径)后新增 NOTE 说明,补充 whl 包 vs run 包安装方式的路径差异 - CAUTION 后新增 NOTE 说明,补充 whl 包安装时使用 mindie-llm-server 命令拉起服务 - AISBench 路径说明整合:新增 {ais_bench_path} 占位符,统一说明镜像集成版和 git 安装版的路径差异 - 步骤 3.d:编辑 config.json 后设置权限为 640(chmod 640 config.json) - 性能测试"准备数据集"路径统一使用 {ais_bench_path} - 性能测试"安装 AISBench 工具"增加跳转链接至精度测试章节 - 图片补 alt text(MD045) **内容删除:** - 删除文件权限检查步骤(chmod 命令集),因默认路径权限已正确,且 whl 包安装方式不需要 - 删除重复的 "Daemon start success!" 回显提示 - 删除 docker exec 后的 NOTE(外部链接,信息量少) **格式修复:** - 列表内代码块缩进从 5 空格修正为 4 空格,修复 mkdocs 渲染时列表断裂问题 - 表格添加列对齐标记空格,确保在 GitHub 和 mkdocs 上均正确渲染 - json 代码块格式修正(删除多余缩进) - NOTE/CAUTION 标记规范化:> [!NOTE]说明> [!NOTE] 说明 - 参数名、路径等使用反引号包裹,增加可读性 **排版规范化:** - 全篇应用"盘古之白"规范:中英文之间、中文与数字之间加空格 ### 2. 修复 pre-commit 检测问题 - 修复 github_admonition.py 中的 trailing whitespace 和 unused import ### 3. 新增 mkdocs hook 修复列表内 admonition 渲染 - github_admonition.py:修复正则表达式,排除嵌套 [! 模式的误匹配;当 admonition 在列表项内时,在其后插入 <!-- --> 注释强制列表闭合 - 新增 list_break.py hook:检测被 <!-- --> 标记的列表内 admonition,在其后的 ## 标题前再插入一列 <!-- -->,解决 Python-Markdown 在列表项内 admonition 后遇到标题时不闭合 <li> 的渲染问题 ### 4. 注册新 hook - mkdocs.yml:注册 list_break.py hook ### 5. 同步 upstream/dev 并解决 merge 冲突 - Merge branch dev of gitcode.com:Ascend/MindIE-LLM 到 A00252,同步上游最新代码 - 解决 4 个冲突:产品表格、参数表格、chmod 步骤删除、发送请求链接 # 资料变更 涉及。修改 docs/zh/user_guide/quick_start/quick_start.md 文档。 # 接口变更 不涉及。 # 测试结果 本次为文档和 mkdocs 渲染工具修复,已在本地验证: - 修改后的 hook 对现有其他 admonition 无影响,渲染正确 - 修复的代码块缩进和表格格式在 mkdocs serve 预览下渲染正常 - 命令修改基于实际使用场景验证(--shm-size、数据集名、模型配置名) - 确认 vllm_api_stream_chat 配置可用于精度测试(AISBench 查询验证) - markdownlint 全线通过,零报错 # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-coding-style-guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-secure-coding-guide.md) See merge request: Ascend/MindIE-LLM!10193 天前
fix(doc): 修复 quick_start.md 文档及 mkdocs 渲染问题 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !1019 merge A00252 into dev fix(doc): 修复 quick_start.md 文档及 mkdocs 渲染问题 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes https://gitcode.com/Ascend/MindIE-LLM/issues/591 根据 issue #591 的用户反馈,修复 quick_start.md 在 mkdocs 渲染、命令可用性、格式规范性等方面的问题,同时补充 whl 包安装方式的差异化说明,提升文档的可用性和准确性。 本次 PR 还同步了 upstream/dev 的最新代码,并解决了 merge 冲突。 # 修改内容 本次 PR 涉及对 quick_start.md 文档、mkdocs 渲染 hook 以及 mkdocs 配置的修改: ### 1. 修复 quick_start.md 格式、命令及 mkdocs 渲染问题 **命令修复:** - --shm-size1g 改为 500g,避免大模型推理时共享内存不足 - 镜像名称从硬编码的 mindie:3.0.0-800I-A2-py311-openeuler24.03-lts 替换为 {IMAGE_ID} 占位符,用户根据实际下载的镜像替换 - 数据集名称 demo_gsm8k_*gsm8k_*,修正为正确的数据集名 - 精度测试命令 --models vllm_api_general_chatvllm_api_stream_chat,与配置文件一致 - 精度测试回显中 demo_gsm8kgsm8kvllm_api_general_chatvllm_api_stream_chat - 环境变量步骤锚点 ID 从 step3 改为 setup_env,语义更清晰 **内容增补:** - 表 2(容器内各组件安装路径)后新增 NOTE 说明,补充 whl 包 vs run 包安装方式的路径差异 - CAUTION 后新增 NOTE 说明,补充 whl 包安装时使用 mindie-llm-server 命令拉起服务 - AISBench 路径说明整合:新增 {ais_bench_path} 占位符,统一说明镜像集成版和 git 安装版的路径差异 - 步骤 3.d:编辑 config.json 后设置权限为 640(chmod 640 config.json) - 性能测试"准备数据集"路径统一使用 {ais_bench_path} - 性能测试"安装 AISBench 工具"增加跳转链接至精度测试章节 - 图片补 alt text(MD045) **内容删除:** - 删除文件权限检查步骤(chmod 命令集),因默认路径权限已正确,且 whl 包安装方式不需要 - 删除重复的 "Daemon start success!" 回显提示 - 删除 docker exec 后的 NOTE(外部链接,信息量少) **格式修复:** - 列表内代码块缩进从 5 空格修正为 4 空格,修复 mkdocs 渲染时列表断裂问题 - 表格添加列对齐标记空格,确保在 GitHub 和 mkdocs 上均正确渲染 - json 代码块格式修正(删除多余缩进) - NOTE/CAUTION 标记规范化:> [!NOTE]说明> [!NOTE] 说明 - 参数名、路径等使用反引号包裹,增加可读性 **排版规范化:** - 全篇应用"盘古之白"规范:中英文之间、中文与数字之间加空格 ### 2. 修复 pre-commit 检测问题 - 修复 github_admonition.py 中的 trailing whitespace 和 unused import ### 3. 新增 mkdocs hook 修复列表内 admonition 渲染 - github_admonition.py:修复正则表达式,排除嵌套 [! 模式的误匹配;当 admonition 在列表项内时,在其后插入 <!-- --> 注释强制列表闭合 - 新增 list_break.py hook:检测被 <!-- --> 标记的列表内 admonition,在其后的 ## 标题前再插入一列 <!-- -->,解决 Python-Markdown 在列表项内 admonition 后遇到标题时不闭合 <li> 的渲染问题 ### 4. 注册新 hook - mkdocs.yml:注册 list_break.py hook ### 5. 同步 upstream/dev 并解决 merge 冲突 - Merge branch dev of gitcode.com:Ascend/MindIE-LLM 到 A00252,同步上游最新代码 - 解决 4 个冲突:产品表格、参数表格、chmod 步骤删除、发送请求链接 # 资料变更 涉及。修改 docs/zh/user_guide/quick_start/quick_start.md 文档。 # 接口变更 不涉及。 # 测试结果 本次为文档和 mkdocs 渲染工具修复,已在本地验证: - 修改后的 hook 对现有其他 admonition 无影响,渲染正确 - 修复的代码块缩进和表格格式在 mkdocs serve 预览下渲染正常 - 命令修改基于实际使用场景验证(--shm-size、数据集名、模型配置名) - 确认 vllm_api_stream_chat 配置可用于精度测试(AISBench 查询验证) - markdownlint 全线通过,零报错 # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-coding-style-guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-cpp-secure-coding-guide.md) See merge request: Ascend/MindIE-LLM!10193 天前
[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力,文档以原始 Markdown 形式放在仓库中,阅读体验差、导航结构不清晰,在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施,支持通过 ReadTheDocs 在线发布中文文档,同时修复文档链接、适配 pre-commit 检查、优化代码块渲染,为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件,基于 MkDocs Material 主题,配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置,使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置,覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook,将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法(支持 >- 列表嵌套语法) 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook,将 HTML <img> 标签(含 width 属性)转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式:定义 announcement、important、code、console 四种 Admonition 类型样式,Tabbed 组件样式,代码块系统等宽字体(不换行 + tab-size: 8) 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md):添加居中大标题和副标题、导航栏(昇腾社区 / 文档中心 / 代码仓库 / 社区会议),所有文档链接替换为 ReadTheDocs 在线地址,修复原有 2 个断链(install/README.mduser_manual/README.md) 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page,包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效:nofification 拼写错误、FAQ 路径 faq/faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致:multi_loRA.mdmulti_lora.mdsplitFuse.mdsplit_fuse.md,同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md(保留 installation_in_containerized.md) ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$,跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施,重构中文文档首页和项目 README,修复多处文档链接失效,新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过,站点可正常访问,页面渲染正确 - 导航链接已逐一确认,所有页面可正常跳转 - 明暗主题切换正常,Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过,> [!NOTE]> [!WARNING]> [!TIP]> [!CAUTION]> [!IMPORTANT] 均可正确转换(含 >- 列表嵌套语法) - 代码块系统等宽字体渲染正常,box-drawing 字符对齐正确(Mac / Windows / ReadTheDocs 已验证) - 搜索功能正常,支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过(mkdocs.yml 已排除 check-yaml) # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!7241 个月前
[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力,文档以原始 Markdown 形式放在仓库中,阅读体验差、导航结构不清晰,在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施,支持通过 ReadTheDocs 在线发布中文文档,同时修复文档链接、适配 pre-commit 检查、优化代码块渲染,为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件,基于 MkDocs Material 主题,配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置,使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置,覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook,将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法(支持 >- 列表嵌套语法) 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook,将 HTML <img> 标签(含 width 属性)转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式:定义 announcement、important、code、console 四种 Admonition 类型样式,Tabbed 组件样式,代码块系统等宽字体(不换行 + tab-size: 8) 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md):添加居中大标题和副标题、导航栏(昇腾社区 / 文档中心 / 代码仓库 / 社区会议),所有文档链接替换为 ReadTheDocs 在线地址,修复原有 2 个断链(install/README.mduser_manual/README.md) 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page,包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效:nofification 拼写错误、FAQ 路径 faq/faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致:multi_loRA.mdmulti_lora.mdsplitFuse.mdsplit_fuse.md,同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md(保留 installation_in_containerized.md) ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$,跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施,重构中文文档首页和项目 README,修复多处文档链接失效,新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过,站点可正常访问,页面渲染正确 - 导航链接已逐一确认,所有页面可正常跳转 - 明暗主题切换正常,Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过,> [!NOTE]> [!WARNING]> [!TIP]> [!CAUTION]> [!IMPORTANT] 均可正确转换(含 >- 列表嵌套语法) - 代码块系统等宽字体渲染正常,box-drawing 字符对齐正确(Mac / Windows / ReadTheDocs 已验证) - 搜索功能正常,支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过(mkdocs.yml 已排除 check-yaml) # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!7241 个月前
[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期:20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力,文档以原始 Markdown 形式放在仓库中,阅读体验差、导航结构不清晰,在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施,支持通过 ReadTheDocs 在线发布中文文档,同时修复文档链接、适配 pre-commit 检查、优化代码块渲染,为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件,基于 MkDocs Material 主题,配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置,使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置,覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook,将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法(支持 >- 列表嵌套语法) 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook,将 HTML <img> 标签(含 width 属性)转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式:定义 announcement、important、code、console 四种 Admonition 类型样式,Tabbed 组件样式,代码块系统等宽字体(不换行 + tab-size: 8) 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md):添加居中大标题和副标题、导航栏(昇腾社区 / 文档中心 / 代码仓库 / 社区会议),所有文档链接替换为 ReadTheDocs 在线地址,修复原有 2 个断链(install/README.mduser_manual/README.md) 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page,包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效:nofification 拼写错误、FAQ 路径 faq/faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致:multi_loRA.mdmulti_lora.mdsplitFuse.mdsplit_fuse.md,同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md(保留 installation_in_containerized.md) ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$,跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施,重构中文文档首页和项目 README,修复多处文档链接失效,新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过,站点可正常访问,页面渲染正确 - 导航链接已逐一确认,所有页面可正常跳转 - 明暗主题切换正常,Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过,> [!NOTE]> [!WARNING]> [!TIP]> [!CAUTION]> [!IMPORTANT] 均可正确转换(含 >- 列表嵌套语法) - 代码块系统等宽字体渲染正常,box-drawing 字符对齐正确(Mac / Windows / ReadTheDocs 已验证) - 搜索功能正常,支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过(mkdocs.yml 已排除 check-yaml) # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值;考虑接口的异常场景;调用底层组件接口时,需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请,使用后资源被正确的释放了 - [x] 若涉及多线程场景,考虑了并发场景,不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format),使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!7241 个月前
[Doc]代码仓增加日志参考和LLM通信矩阵 Co-authored-by: x60087760<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !994 merge newly_added into dev [Doc]代码仓增加日志参考和LLM通信矩阵 Created-by: ella07 Commit-by: x60087760 Merged-by: ascend-robot Description: [#569](https://gitcode.com/Ascend/MindIE-LLM/issues/569) 1、LLM代码仓增加日志参考和LLM通信矩阵。 2、修改版本说明书,去除配套的B版本,增加软件兼容说明 See merge request: Ascend/MindIE-LLM!99420 天前
README.md

hide:

  • navigation
  • toc

欢迎使用 MindIE-LLM

MindIE-LLM

MindIE LLM(Mind Inference Engine Large Language Model)是 MindIE 下的大语言模型推理组件,基于昇腾硬件提供业界通用大模型推理能力,同时提供多并发请求的调度功能。

根据你的使用场景选择入口:

核心能力

MindIE LLM 具备高性能推理能力:

  • 高吞吐服务化推理,支持 Continuous Batching 和 PagedAttention
  • 高效的注意力 KV Cache 显存管理
  • 多种量化支持:W8A8、W8A16、W4A8 混合精度、FA3 量化、KV Cache INT8 等
  • 多维并行策略:张量并行、数据并行、专家并行、上下文并行、序列并行
  • Prefill/Decode 混合部署与 KV Cache 池化
  • SplitFuse 分块调度、异步调度、并行解码降低时延

MindIE LLM 灵活易用:

  • Docker 镜像一键部署,开箱即用
  • 支持主流开源大语言模型
  • 兼容 OpenAI / Triton / TGI / vLLM 等推理框架请求接口
  • MoE、MLA、MTP、Function Call、Multi-LoRA 等丰富模型特性
  • 完善的参数配置和环境变量体系

架构概览

MindIE LLM 总体架构分为四层:

  • Server:推理服务端,提供 RESTful 接口,支持 Triton/OpenAI/TGI/vLLM 主流推理框架请求接口
  • LLM Manager:负责状态管理及任务调度,基于调度策略实现请求组 batch,统一内存池管理 KV Cache
  • Text Generator:负责模型配置、初始化、加载、自回归推理流程、后处理
  • Modeling:提供性能调优后的模块和内置模型,支持 ATB Models

详见 架构概览

相关链接