已合并
[docs] 分解量化算法文档 #833
wanlongze123创建于 14 天前
[docs] 分解量化算法文档 #833
已合并
Pull Request已成功合入, 合并人@ascend-robot
(感谢 wanlongze123 的贡献)atomgit-bot
14 天前 评论:
14 天前 评论:
变更摘要
本 PR 是一次纯文档变更,主要对量化算法文档进行「词条 - 使用指南」的拆分与规范化重组。原先各算法以单篇 *.md 形式组织,词条说明与使用指南混在一起,且命名与章节结构不符合词条文档规范;本次将文档拆分为 term_*.md(词条)与 usage_*.md(使用指南)两类文件,统一章节编号,并重构量化算法索引 README,使全部文档通过校验 checklist。该变更不涉及接口、输出件或非兼容变更。
主要改动
- 词条与使用指南拆分:将各算法单篇文档拆分为
term_*.md(词条)与usage_*.md(使用指南)两份文件,解决词条说明与使用指南混排的问题。 - 词条章节规范化:将词条章节调整为连续编号,
## 概述改为## 1. 概述,## 背景与动机改为## 2. 词条介绍。 - 使用指南文档生成:在
docs/使用指南下同步拆分生成usage_*.md使用指南文档。 - 索引 README 重构:重构量化算法索引表格(算法名称 / 类别 / 核心思想 / 适用场景 / 词条 / 使用指南),并新增「敏感层分析算法」与「算法选择建议」小节。
- **文档链接更新**:将全部文档链接更新为指向拆分后的新文件,使文档满足校验 checklist 要求并便于索引与检索。


AtlasAccount
14 天前 评论:
14 天前 评论:
atomgit-bot
14 天前 评论:
14 天前 评论:
🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。


14 天前 添加了label:stat/needs-squash
14 天前 添加了label:ascend-cla/yes
此处折叠了136条消息 查看更多
AtlasAccount
13 天前 评论:
13 天前 评论:
流水线 PR-pipeline_msmodelslim#2239 [ commitID:e5749c79 ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_msmodelslim | 🛑 | >>> |
| 恶意代码检查 | Antipoison_MindStudio-ModelSlim | 🛑 | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | 🛑 | >>> |
| md_check | md_check | ✅ | >>> |
| pre-commit | 🛑 | >>> | |
| 开源片段检查 | SCA_MindStudio-ModelSlim | 🛑 | >>> |
| 开发者测试 | UT_msmodelslim | 🛑 | >>> |
| PreSmoke_msmodelslim | 🛑 | >>> | |
| 流水线 | PR-pipeline_msmodelslim | ✅ | >>> |
- compile : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


keith_wa
13 天前 评论:
13 天前 评论:
/lgtm
/approve


13 天前 添加了label:approvedlgtm
13 天前 合入了pull request
PR 提交说明
提交前请阅读
https://gitcode.com/Ascend/msmodelslim/blob/master/docs/zh/contributing/contributing_guide.md,开发者文档:模型接入指南PR 标题前缀:[Doc](与 CONTRIBUTING 一致)
1. 影响面评估
接口变更(按需): 无
输出件变更(按需): 无
非兼容变更(按需): 无
SIG 评审结论(按需): 无
2. 修改描述
修改背景(可选): 量化算法文档原先以单篇
*.md形式组织,词条说明与使用指南混在一起,且词条文件命名、章节结构不符合词条文档规范,无法通过文档校验 checklist,也不便于索引与检索。修改目的: 将量化算法文档按「词条 - 使用指南」拆分重组,统一词条文件命名与章节编号规范,重构算法索引 README,使全部文档通过校验。
修改内容:(按「概念 - 变化」分条)
*_term.md(词条)与*_usage.md(使用指南)两份,并按规范重命名为term_*.md/usage_*.md## 概述→## 1. 概述,## 背景与动机→## 2. 词条介绍usage_*.md使用指南文档概念域参考: core
3. 功能验证
冒烟由 CI 门禁检查,无需填写「冒烟是否通过」。
复现步骤(可选):
# 对照 docs/zh/knowledge_base/ 下校验 checklist 对量化算法文档执行校验4. 自检(请逐项确认,不适用标 N/A)
典型安全编码问题
DT
checklist
