v3.0.0

ascend-robot[Docs]Fix release note formatting and dependency version description

6a5565aa创建于 5月12日历史提交

文件	最后提交记录	最后更新时间
_static	[Docs] Optimize document Chinese and English switching experience Co-authored-by: blian6<bin.lian@outlook.com> Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !267 merge dev into dev [Docs] Optimize document Chinese and English switching experience Created-by: blian Commit-by: blian6;blian Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 1. 优化文档内容，并提供网页的中英文切换能力 2. 添加关键融合算子和关键API的说明文档 3. 后续优化点： a. 图片的路径需要移到公有路径(docs/figures)，否则，会产生无法找到的问题，但是这个修改涉及面较多，后续提交PR。 b. 中文界面的切换按钮最好是英文。 # Purpose # Test Plan 本地生成 HTML 文档可使用以下命令： bash python -m pip install -r docs/requirements-docs.txt # 构建中英文 python docs/build_docs.py # 仅构建中文 SPHINX_LANGUAGE=zh sphinx-build -b html -c docs docs/zh docs/_build/zh/html # 仅构建英文 SPHINX_LANGUAGE=en sphinx-build -b html -c docs docs/en docs/_build/en/html 本地预览方法： python -m http.server 8080 --directory docs/_build - http://localhost:8080 → 自动跳转中文版 - http://localhost:8080/zh/html/index.html → 中文 - http://localhost:8080/en/html/index.html → 英文 # Test Report   See merge request: Ascend/MindIE-SD!267	1 个月前
appendix	[Docs][features] 重构特性文档结构，丰富文档信息内容 Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !277 merge dev into dev [Docs][features] 重构特性文档结构，丰富文档信息内容 Created-by: blian Commit-by: blian Merged-by: ascend-robot Description: ## Which issue(s) this PR fixes or accomplishes 无关联 Issue，为文档质量优化。 ## Purpose 对 docs/zh/features/ 下全部 10 个特性文档进行结构审计和内容补全，同时清理附录中的孤立文件。核心变更如下： ### 1. 文档结构统一 所有特性文档统一为 **通用原理 → 技术特点 → 接口和使用** 三段式模板： - sparse.md：全文重写，新增 RainFusion2.0 论文技术内容，三段式结构 - cpu_offload.md：全文重写，补齐 enable_offload 接口说明和代码示例 - DyEPLB.md：重构为三段式，精简适配流程，类说明表格化，删除与 apis.md 重复的参数表 - parallelism.md：4 个子章节统一为「原理 → 通信方式 → 适用场景 → 使用示例」结构，新增 TP/RSP/CFG 代码示例及 CFG 融合补充内容 - quantization.md：Linear 量化按三段式重构，基于最新代码更新算法支持表（15 种算法） - share_memory.md：补充 init_share_memory、share_memory 接口说明和主从实例代码示例 - compilation.md：补齐缺失的 fusion pattern 配置项和 ACLGraph 配置项 ### 2. 推荐方案新增 多子策略文档增加推荐方案段落，帮助用户快速选择： - parallelism.md：总览后新增 4 条推荐（TP/USP/RSP/CFG） - cache.md：总览后新增 3 条推荐（DiTCache/AttentionCache/时间步优化） - sparse.md：技术特点后新增推荐方案（rf_v2 优先 / ada_bsa 备选） ### 3. 总览段落补齐 多子话题文档增加总览段落： - parallelism.md：4 种并行策略总览 - cache.md：3 种缓存方式总览 - quantization.md：Linear 量化和 FA 量化覆盖说明 ### 4. API 参考去重与重构 - **删除** docs/zh/appendix/api_reference.md（552 行，孤立文件，不在导航中索引，内容与 core_layers.md 重叠） - 将其中仅有的未覆盖 API Linear 迁移至 core_layers.md - **重写** docs/zh/appendix/apis.md：删除量化系列（移至 quant 特性自包含），新增编译系列/CPU 卸载系列/显存共享系列/EPLB 系列 - 各 feature 文档中的 API 参数表统一引用至 apis.md 或 core_layers.md，消除重复维护 ### 5. 死链修复与词汇一致性 - architecture.md：3 处指向英文侧文件的死链替换为中文侧文件 - architecture.md：补全 EPLB 引用，修复 Cache-DiT 拼写 - index.md：首页描述与 architecture.md 词汇统一 - installation.md：格式修复 ### 6. 审计修复 - core_layers.md：cu_seqlens_q/k 类型标注修正、sparse_type 新增 rf_v3、layernorm_scale_shift 约束放宽 - compilation.md：补齐 Python 示例中 5 个 pattern 配置项、ACLGraph 配置表新增 3 项 ## Test Plan 文档站点编译验证：执行 python docs/build_docs.py 构建中英文文档，无编译错误。 ## Test Report text Chinese: docs/_build/zh/html/index.html English: docs/_build/en/html/index.html Default: docs/_build/index.html Build: Succeeded, no errors. See merge request: Ascend/MindIE-SD!277	1 个月前
community	docs: 更新社区治理和文档 Co-authored-by: weixin_44144262<lijinxi2@huawei.com> # message auto-generated for no-merge-commit merge: !232 merge dev into dev docs: 更新社区治理和文档 Created-by: weixin_44144262 Commit-by: weixin_44144262 Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 更新社区治理和文档 # Purpose 更新相关文档要求 # Test Plan 文档更新 # Test Report See merge request: Ascend/MindIE-SD!232	2 个月前
developer_guide	[Docs] Optimize document Chinese and English switching experience Co-authored-by: blian6<bin.lian@outlook.com> Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !267 merge dev into dev [Docs] Optimize document Chinese and English switching experience Created-by: blian Commit-by: blian6;blian Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 1. 优化文档内容，并提供网页的中英文切换能力 2. 添加关键融合算子和关键API的说明文档 3. 后续优化点： a. 图片的路径需要移到公有路径(docs/figures)，否则，会产生无法找到的问题，但是这个修改涉及面较多，后续提交PR。 b. 中文界面的切换按钮最好是英文。 # Purpose # Test Plan 本地生成 HTML 文档可使用以下命令： bash python -m pip install -r docs/requirements-docs.txt # 构建中英文 python docs/build_docs.py # 仅构建中文 SPHINX_LANGUAGE=zh sphinx-build -b html -c docs docs/zh docs/_build/zh/html # 仅构建英文 SPHINX_LANGUAGE=en sphinx-build -b html -c docs docs/en docs/_build/en/html 本地预览方法： python -m http.server 8080 --directory docs/_build - http://localhost:8080 → 自动跳转中文版 - http://localhost:8080/zh/html/index.html → 中文 - http://localhost:8080/en/html/index.html → 英文 # Test Report   See merge request: Ascend/MindIE-SD!267	1 个月前
features	[Docs]统一图片资源命名规范并迁移至公共目录 Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !282 merge pic_rename into dev [Docs]统一图片资源命名规范并迁移至公共目录 Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: ## 变更摘要 规范化 docs/ 目录下全部图片资源的命名方式，并将其从语言专属目录迁移到公共目录，便于中英文文档共享引用。 ## 具体变更 - **重命名 34 个图片文件**：将 docs/zh/figures 下的中文/混合命名统一改为英文 snake_case 格式。 - 示例：CFG并行.png → cfg_parallel.png - 示例：单卡base + 高性能FA算子.gif → single_card_base_fa.gif - **迁移图片目录**：从 docs/zh/figures/ 移动到 docs/figures/，消除语言路径耦合。 - **更新 15 篇文档引用**：覆盖 docs/zh/、docs/en/ 及 README.md 中的图片路径与文件名，同时修复了 Markdown 中 URL 编码的中文文件名引用。 ## 涉及的文件 - README.md - docs/zh/*.md、docs/zh/features/*.md - docs/en/*.md、docs/en/features/*.md ## 验证结果 - 已确认所有 Markdown 图片引用中不再包含中文字符。 - 已确认仓库中不存在残留的 zh/figures 旧路径引用。 See merge request: Ascend/MindIE-SD!282	1 个月前
architecture.md	[Docs]统一图片资源命名规范并迁移至公共目录 Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !282 merge pic_rename into dev [Docs]统一图片资源命名规范并迁移至公共目录 Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: ## 变更摘要 规范化 docs/ 目录下全部图片资源的命名方式，并将其从语言专属目录迁移到公共目录，便于中英文文档共享引用。 ## 具体变更 - **重命名 34 个图片文件**：将 docs/zh/figures 下的中文/混合命名统一改为英文 snake_case 格式。 - 示例：CFG并行.png → cfg_parallel.png - 示例：单卡base + 高性能FA算子.gif → single_card_base_fa.gif - **迁移图片目录**：从 docs/zh/figures/ 移动到 docs/figures/，消除语言路径耦合。 - **更新 15 篇文档引用**：覆盖 docs/zh/、docs/en/ 及 README.md 中的图片路径与文件名，同时修复了 Markdown 中 URL 编码的中文文件名引用。 ## 涉及的文件 - README.md - docs/zh/*.md、docs/zh/features/*.md - docs/en/*.md、docs/en/features/*.md ## 验证结果 - 已确认所有 Markdown 图片引用中不再包含中文字符。 - 已确认仓库中不存在残留的 zh/figures 旧路径引用。 See merge request: Ascend/MindIE-SD!282	1 个月前
index.md	[Docs][features] 重构特性文档结构，丰富文档信息内容 Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !277 merge dev into dev [Docs][features] 重构特性文档结构，丰富文档信息内容 Created-by: blian Commit-by: blian Merged-by: ascend-robot Description: ## Which issue(s) this PR fixes or accomplishes 无关联 Issue，为文档质量优化。 ## Purpose 对 docs/zh/features/ 下全部 10 个特性文档进行结构审计和内容补全，同时清理附录中的孤立文件。核心变更如下： ### 1. 文档结构统一 所有特性文档统一为 **通用原理 → 技术特点 → 接口和使用** 三段式模板： - sparse.md：全文重写，新增 RainFusion2.0 论文技术内容，三段式结构 - cpu_offload.md：全文重写，补齐 enable_offload 接口说明和代码示例 - DyEPLB.md：重构为三段式，精简适配流程，类说明表格化，删除与 apis.md 重复的参数表 - parallelism.md：4 个子章节统一为「原理 → 通信方式 → 适用场景 → 使用示例」结构，新增 TP/RSP/CFG 代码示例及 CFG 融合补充内容 - quantization.md：Linear 量化按三段式重构，基于最新代码更新算法支持表（15 种算法） - share_memory.md：补充 init_share_memory、share_memory 接口说明和主从实例代码示例 - compilation.md：补齐缺失的 fusion pattern 配置项和 ACLGraph 配置项 ### 2. 推荐方案新增 多子策略文档增加推荐方案段落，帮助用户快速选择： - parallelism.md：总览后新增 4 条推荐（TP/USP/RSP/CFG） - cache.md：总览后新增 3 条推荐（DiTCache/AttentionCache/时间步优化） - sparse.md：技术特点后新增推荐方案（rf_v2 优先 / ada_bsa 备选） ### 3. 总览段落补齐 多子话题文档增加总览段落： - parallelism.md：4 种并行策略总览 - cache.md：3 种缓存方式总览 - quantization.md：Linear 量化和 FA 量化覆盖说明 ### 4. API 参考去重与重构 - **删除** docs/zh/appendix/api_reference.md（552 行，孤立文件，不在导航中索引，内容与 core_layers.md 重叠） - 将其中仅有的未覆盖 API Linear 迁移至 core_layers.md - **重写** docs/zh/appendix/apis.md：删除量化系列（移至 quant 特性自包含），新增编译系列/CPU 卸载系列/显存共享系列/EPLB 系列 - 各 feature 文档中的 API 参数表统一引用至 apis.md 或 core_layers.md，消除重复维护 ### 5. 死链修复与词汇一致性 - architecture.md：3 处指向英文侧文件的死链替换为中文侧文件 - architecture.md：补全 EPLB 引用，修复 Cache-DiT 拼写 - index.md：首页描述与 architecture.md 词汇统一 - installation.md：格式修复 ### 6. 审计修复 - core_layers.md：cu_seqlens_q/k 类型标注修正、sparse_type 新增 rf_v3、layernorm_scale_shift 约束放宽 - compilation.md：补齐 Python 示例中 5 个 pattern 配置项、ACLGraph 配置表新增 3 项 ## Test Plan 文档站点编译验证：执行 python docs/build_docs.py 构建中英文文档，无编译错误。 ## Test Report text Chinese: docs/_build/zh/html/index.html English: docs/_build/en/html/index.html Default: docs/_build/index.html Build: Succeeded, no errors. See merge request: Ascend/MindIE-SD!277	1 个月前
installation.md	[openlibing.ci] auto fixes by pre-commit	1 个月前
quick_start.md	[Docs]统一图片资源命名规范并迁移至公共目录 Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !282 merge pic_rename into dev [Docs]统一图片资源命名规范并迁移至公共目录 Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: ## 变更摘要 规范化 docs/ 目录下全部图片资源的命名方式，并将其从语言专属目录迁移到公共目录，便于中英文文档共享引用。 ## 具体变更 - **重命名 34 个图片文件**：将 docs/zh/figures 下的中文/混合命名统一改为英文 snake_case 格式。 - 示例：CFG并行.png → cfg_parallel.png - 示例：单卡base + 高性能FA算子.gif → single_card_base_fa.gif - **迁移图片目录**：从 docs/zh/figures/ 移动到 docs/figures/，消除语言路径耦合。 - **更新 15 篇文档引用**：覆盖 docs/zh/、docs/en/ 及 README.md 中的图片路径与文件名，同时修复了 Markdown 中 URL 编码的中文文件名引用。 ## 涉及的文件 - README.md - docs/zh/*.md、docs/zh/features/*.md - docs/en/*.md、docs/en/features/*.md ## 验证结果 - 已确认所有 Markdown 图片引用中不再包含中文字符。 - 已确认仓库中不存在残留的 zh/figures 旧路径引用。 See merge request: Ascend/MindIE-SD!282	1 个月前
release_note.md	[Docs]Fix release note formatting and dependency version description Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !291 merge releasenote-0512 into dev [Docs]Fix release note formatting and dependency version description Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 无关issue，仅修正release note # Purpose 修正 docs/zh/release_note.md 中的以下问题： 1. 将 Ascend HDK 和 Torch 的具体版本号删除，改为引用 CANN 版本配套说明链接，避免版本信息维护不一致。 2. 删除兼容性表格中多余的 Torch 列，精简版本配套表。 3. 修正新增特性第 6 条前的全角竖线 ｜6 为半角 | 6，修复 Markdown 表格格式。 4. 删除文档末尾多余的空标题 # 3.0.0版本配套文档。 # Test Plan - 本地预览 docs/zh/release_note.md Markdown 渲染效果，确认表格格式正确。 - （建议）执行文档站点编译验证： ```bash python -m pip install -r docs/requirements-docs.txt python -m sphinx -b html docs docs/_build/html See merge request: Ascend/MindIE-SD!291	1 个月前