cann-robotfix: correct typos, table formatting and mixed content in documentation files

文件	最后提交记录	最后更新时间
en	docs: 补充pyflow与npu_model装饰器实现机制与对比 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !4651 merge docs/dflow-pyflow-npu-model into develop docs: 补充pyflow与npu_model装饰器实现机制与对比 Created-by: lining23666 Commit-by: lining23666 Merged-by: cann-robot Description: # Pull Request ## 描述补充 dflow 设计文档中 Python 两个核心装饰器的实现机制描述。现有文档对 `@df.pyflow` 和 `@df.npu_model` 各只有一行表格提及，缺少机制层面的设计说明。主要变更（`docs/zh/design/modules/dflow/dflow.md` 4.5 节扩展三个小节）： 4.5.1 `@df.pyflow` 通用 Python UDF 装饰器 - 函数/类两种装饰对象的构图方式（`PyFunctionProcessPoint` / `PyActorProcessPoint`） - UDF 工程生成链路（cloudpickle 序列化 + C++ wrapper + `func_.json`，固定 `heavy_load=True`） - 运行时对称的序列化/反序列化数据路径 - 独有扩展能力（stream_input / choice_output / generator 流式输出 / msg_type_register 自定义消息类型） 4.5.2 `@df.npu_model` PyTorch 零拷贝下沉装饰器* - optimize_level 两级优化（1=数据下沉走 UDF 路径；2=dynamo_export 导出 air 后走 GraphPp 模型下沉） - `RuntimeTensorDesc`（1024B 固定布局）零拷贝数据链路时序图 - 结果缓存防释放设计（desc-only 输出须持有 tensor 引用防 device 内存被 GC） - feed/fetch 侧 torch.Tensor↔1023 类型注册机制 - `[RuntimeTensorDesc][data]` 统一线上格式及 C++ 侧两种消费模式（非 proxy 剥头取内联数据 / proxy 直接用 desc.data_addr） - `_npu_sched_model` 属性全链路（构图→编译期图级属性→部署期 `--npu_sched=1` 启动 AICPU 调度） 4.5.3 pyflow 与 npu_model 实现对比 - 共同点（同一基类体系、同一工程生成链路、同一调度执行机制）+ 9 维度对比表 + 选型指引同步修正： - 2.1 节与 4.6.1 节补充 `@df.npu_model` 作为"Python UDF 仅 host"约束的例外说明（npu_sched 模式下潜 device 执行） - 3.3 节 Python 接口表格补交叉引用与 pybind11 C++ 扩展层（`wrapper/`） - 附录关键文件索引更新 - `udf.md` 2.2 节补指向 dflow.md 4.5 节的链接 ## 变更类型 - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新（格式化，局部变量） - [ ] ♻️ 重构（既不修复错误也不增加功能的代码变动） - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue ## 如何测试纯文档变更，无需编译测试： 1. 本地 pre-commit 检查（codespell / end-of-file-fixer / OAT 合规）已全部通过 2. 渲染检查：mermaid 时序图语法、内部锚点链接（4.5.1/4.5.2/4.5.3/4.3.6/4.6.1）均已在本地核对 ## 核对清单 - [x] 我的代码遵循了项目的代码风格 - [x] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [x] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [x] 我已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 ## 其他信息 See merge request: cann/ge!4651	7 天前
zh	fix: correct typos, table formatting and mixed content in documentation files Co-authored-by: tmj1128<tanmengjie2@huawei.com> # message auto-generated for no-merge-commit merge: !4649 merge fix/readme-en-spelling into develop fix: correct typos, table formatting and mixed content in documentation files Created-by: tmj1128 Commit-by: tmj1128 Merged-by: cann-robot Description: ## 问题背景在日常代码审查中发现多个文档文件存在中文错别字、表格格式问题和中英文混用问题，影响文档的专业性和可读性。 ## 问题分析 ### 问题 1：中文错别字 "登陆"与"登录"在中文语义上有明确区分： - 登录：指进入系统、注册、登入的动作（如：登录系统、登录账户） - 登陆：指从水域登上陆地（如：台风登陆、军队登陆）在技术文档中描述"进入容器环境"时，应使用"登录"而非"登陆"。 ### 问题 2：表格格式问题 `deprecated_APIs_replacement_scheme.md` 中6个表格存在两个问题： 1. 每个表格都有多余的空表头行 `\| \| \| \|` 2. 表头格式不统一：第1个表格为 `aclnn组合方案`，其他5个为 `aclnn 组合方案`（多余空格） ### 问题 3：中英文混用问题 `scripts/readme_en.md` 作为英文文档，存在以下问题： 1. 中文标点混用：第139行使用了中文顿号 `、` 而非英文逗号 `,` 2. 中文词汇混入：多处英文句子中混入了中文词汇（如"内"、"集合"、"方式"、"用于"等） 3. 参数名不一致：第145行 `--usr` 与第135行 `--user` 不一致 ## 修复内容 ### 修复项 1：scripts/readme.md 中文错别字修正第38行： - 修改前：`2.执行`ge env`自动下载容器环境，并登陆到环境中` - 修改后：`2.执行`ge env`自动下载容器环境，并登录到环境中` 第117行： - 修改前：`默认：从中央容器仓拉取对应的容器镜像，运行实例并登陆。` - 修改后：`默认：从中央容器仓拉取对应的容器镜像，运行实例并登录。` ### 修复项 2：deprecated_APIs_replacement_scheme.md 表格格式修正 1. 删除6个表格中的空表头行 `\| \| \| \|` 2. 统一表头格式为 `aclnn组合方案`（删除多余空格）修改前： `\| \| \| \| \| --- \| --- \| --- \| \| 新/老接口 \| CBLAS接口 \| aclnn 组合方案 \| \| 接口名称 \| ... \| ... \|` 修改后： `\| 新/老接口 \| CBLAS接口 \| aclnn组合方案 \| \| --- \| --- \| --- \| \| 接口名称 \| ... \| ... \|` ### 修复项 3：scripts/readme_en.md 中英文混用修正修复16处中英文混用问题：标点符号修正： - 第139行：`$、#、!` → `$, #, !`（中文顿号改为英文逗号）中文词汇替换为英文： - 第50行：`container内` → `container` - 第60行：`subcommand集合` → `subcommands` - 第82行：`execution方式` → `execution method` - 第92行：`when不带参数` → `when no parameters are provided` - 第96行：`This command用于` → `This command is used to` - 第117行：`environment前提` → `environment with` - 第124行：`parameters如下` → `parameters are as follows` - 第152行：`parameters如下` → `parameters are as follows` - 第181行：`parameters如下` → `parameters are as follows` - 第228行：`command需要` → `command requires` - 第245行：`need先` → `need to ... first` - 第273行：`ignore部分` → `ignore some` - 第280行：`parameters如下` → `parameters are as follows` - 第306行：`functionality还在` → `functionality is` 参数名统一： - 第145行：`--usr` → `--user`（与第135行保持一致） ## 修改范围 \| 文件 \| 修改行数 \| 修改类型 \| \|------\|---------\|---------\| \| `scripts/readme.md` \| 2处 \| 错别字修正 \| \| `docs/zh/api/graph_engine_api/c/acl/deprecated_APIs_replacement_scheme.md` \| 6个表格 \| 删除空表头 + 格式统一 \| \| `scripts/readme_en.md` \| 16处 \| 中英文混用修正 \| ## 影响评估 - 功能影响：无，仅文档修改 - 兼容性：无影响 - 测试：无需额外测试 See merge request: cann/ge!4649	7 天前
README.md	【PR】:rename user-guides Co-authored-by: sophia1213<sophie.chen@huawei.com> # message auto-generated for no-merge-commit merge: !3814 merge develop into develop 【PR】:rename user-guides Created-by: sophia1213 Commit-by: sophia1213 Merged-by: cann-robot Description: # Pull Request ## 描述重命名docs目录下的user-guides为user_guides。 ## 变更类型请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新（格式化，局部变量） - [ ] ♻️ 重构（既不修复错误也不增加功能的代码变动） - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue 无 ## 如何测试根据最新目录进行测试 ## 核对清单 <!-- [x] 表示选中 --> - [ ] 我的代码遵循了项目的代码风格 - [ ] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [ ] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [ ] 我已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 ## 其他信息在此添加任何其他关于本次 PR 的说明。 See merge request: cann/ge!3814	2 个月前
README_en.md	【PR】:rename user-guides Co-authored-by: sophia1213<sophie.chen@huawei.com> # message auto-generated for no-merge-commit merge: !3814 merge develop into develop 【PR】:rename user-guides Created-by: sophia1213 Commit-by: sophia1213 Merged-by: cann-robot Description: # Pull Request ## 描述重命名docs目录下的user-guides为user_guides。 ## 变更类型请选择本次引入的变更类型： <!-- [x] 表示选中 --> - [ ] 🐛 Bug 修复 - [ ] ✨ 新功能 - [ ] 💄 代码风格更新（格式化，局部变量） - [ ] ♻️ 重构（既不修复错误也不增加功能的代码变动） - [ ] 📦 构建过程或辅助工具的变动 - [x] 📝 文档内容更新 ## 关联的Issue 无 ## 如何测试根据最新目录进行测试 ## 核对清单 <!-- [x] 表示选中 --> - [ ] 我的代码遵循了项目的代码风格 - [ ] 我已对代码进行了自测 - [x] 我已更新了相关的文档 - [ ] 我在标题中使用了合适的类型标签（如：`feat:`, `fix:`） - [ ] 我已经详细阅读了贡献指南（CONTRIBUTING.md），并遵守了其中的所有规定，包括但不限于commit message的格式、无效commit的合并等 ## 其他信息在此添加任何其他关于本次 PR 的说明。 See merge request: cann/ge!3814	2 个月前

项目文档

目录结构

└── zh
    ├── api/                    # API参考文档
    ├── contributions/          # 开发规范与指南
    ├── design/                 # 设计文档
    ├── figures/                # 图片资源
    ├── user_guides/            # 用户指南
    ├── build.md                # 源码构建
    └── quick_install.md        # 环境部署