| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
fix docs error Co-authored-by: bellatan<tanmei2@huawei.com> # message auto-generated for no-merge-commit merge: !5466 merge 0706_docs_v26.1.0 into 26.1.0 fix docs error Created-by: bellatan Commit-by: bellatan Merged-by: ascend-robot Description: <!-- PR描述模板更新日期：20260203 --> # 【合入来源】 > <font color="red">**如有社区issue，请关联issue链接**</font>\ > <font color="red">**请勿携带内部流程信息（需求链接、问题单、内部issue等）**</font> https://gitcode.com/Ascend/op-plugin/issues/266 - [ ] 需求 - [x] 问题单 - [ ] issue/工单 - [ ] 重构优化 - [x] 资料更新 # 【修改方案】 | api名字 | 文档 | 问题 | 修改处 | |---|---|---|---| | at_npu::native::get_npu_format | （beta）at_npu-native-get_npu_format.md | 定义文件路径使用了 Windows 反斜杠；功能说明中“获取NPU tensor格式信息，返回值类型int64_t”表述不顺，需明确为获取格式信息且返回值为 int64_t 类型。 | torch_npu\csrc\core\npu\NPUFormat.h 改为 torch_npu/csrc/core/npu/NPUFormat.h；功能说明改为“获取NPU tensor的格式信息，返回值为int64_t类型。” | | torch_npu.contrib.function.fuse_add_softmax_dropout | （beta）torch_npu-contrib-function-fuse_add_softmax_dropout.md | 示例代码把第五个入参写成 alpha，与接口含义不匹配；应改为 attn_head_size，并补齐 p=0.1。 | 示例中 alpha = 0.125 改为 attn_head_size = 64；调用参数 alpha 改为 attn_head_size, p=0.1。 | | torch_npu.contrib.function.npu_bbox_coder_decode_xywh2xyxy | （beta）torch_npu-contrib-function-npu_bbox_coder_decode_xywh2xyxy.md | 功能描述用语不准确；示例中 torch.randint(...).npu() 生成整型 bboxes，不符合 bbox 坐标应使用浮点张量的示例需求。 | 功能说明改为“将格式从xywh转换为xyxy”；torch.randint(0, max_shape, size=(A, 4)).npu() 改为 (torch.rand(A, 4) * max_shape).npu()。 | | torch_npu.contrib.function.npu_ciou | （beta）torch_npu-contrib-function-npu_ciou.md<br>torch_npu-contrib_list.md | 功能说明存在英文混杂和语义不顺的问题，如 penalty term、propose CIoU，需要改成中文描述。 | penalty term 改为“惩罚项”；propose CIoU 改为“提出CIoU”。 | | torch_npu.contrib.module.ROIAlign | （beta）torch_npu-contrib-module-ROIAlign.md | 示例代码对 roi 设置 requires_grad = True，但 ROIAlign 对 rois 入参不支持求导，示例会误导用户。 | 删除示例中的 roi.requires_grad = True。 | | torch_npu.npu.obfuscation_calculate | （beta）torch_npu-npu-obfuscation_calculate.md<br>_op_plugin_docs.py | x 参数 shape 写成 ( , *, ... , hiddenSize)，格式异常；应表达为 (*, ..., hiddenSize)。 | ( , *, ... , hiddenSize) 改为 (*, ..., hiddenSize)。 | | torch_npu.npu.set_compile_mode | （beta）torch_npu-npu-set_compile_mode.md<br>torch_npu-npu_list.md | 文档把 jit_compile 解释为“二进制/非二进制模式”，语义不直观；应按开启或关闭 JIT 编译描述，并同步产品默认值说明。 | “设置是否开启二进制编译”改为“设置是否开启JIT编译”；True/False 说明改为开启或关闭 JIT 编译。 | | torch_npu.npu_incre_flash_attention | torch_npu-npu_incre_flash_attention.md<br>_op_plugin_docs.py | page attention 性能说明中“带来性能上的下降”表述笼统；示例把环境变量写成裸赋值，放在 Python 代码块中不可执行。 | “会带来性能上的下降”改为“可能会增加延迟”；TORCHDYNAMO_VERBOSE=1 和 TORCH_LOGS="+dynamo" 改为 os.environ[...] 写法。 | | torch_npu.npu_swiglu_quant | torch_npu-npu_swiglu_quant.md | group_index 说明只写成“每个 group 分组的 tokens 数”，没有体现其含义会随 group_list_type 模式变化。 | group_index 说明改为“用于定义分组边界或每组tokens数（具体取决于group_list_type模式）”。 | | torch.npu.set_device_limit | torch_npu-set_device_limit.md | device 参数类型写成 Device，与接口原型和实际用法不一致，应为 int 卡号。 | device 参数类型由 Device 改为 int。 | | torch.npu.set_stream_limit | torch_npu-set_stream_limit.md | 功能说明误写为依赖 torch.npu.set_device_limit；参数默认值说明使用“分核”不准确；示例缺少先设置 device 的调用。 | torch.npu.set_device_limit 改为 torch.npu.set_device；“默认为-1不设置分核”改为“默认为-1不设置控核”；示例增加 torch.npu.set_device(0)。 | | torch_npu.npu_ciou | （beta）torch_npu-npu_ciou.md<br>torch_npu_list.md<br>_op_plugin_docs.py | 功能说明英文混杂；函数原型使用 self, gtboxes 与参数说明 boxes1, boxes2 不一致；is_cross 描述和返回值说明也沿用了错误对象或“mask操作”表述。 | self, gtboxes 改为 boxes1, boxes2；box1和box2 改为 boxes1和boxes2；“mask操作的结果”改为“CIoU计算结果”。 | | torch_npu.npu_dropout_with_add_softmax | （beta）torch_npu-npu_dropout_with_add_softmax.md<br>_op_plugin_docs.py | 产品支持表残留 <term> 标签；公式说明把输入写成 x，与函数原型中的 self 不一致；mask 说明把丢弃概率写成 p，应对应参数 prob。 | 删除产品支持表中的 <term> 标签；x 改为 self；丢弃概率p 改为 丢弃概率prob。 | 其中 torch.npu.set_stream_limit的修改主要参考CANN资料手册说明，https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/910beta3/API/runtimeapi/aclcppdevg_03_1947.html # 【资料变更】 修改内容如【修改方案】展示 # 【接口变更】 不涉及 # 【功能验证】 ci pass # 【CheckList】 > PR提交人对以下CheckList自检项进行全量自检，自检通过或不涉及，均修改 [ ] 为 [x] - [x] 代码注释完备，正确记录错误日志 - [x] 代码实现进行了返回值、空指针等校验 - [x] PR标题正确使用类型标签，如：feat、fix、refactor、docs、test等 - [x] PR持续集成流水线（CI）执行通过，代码检查无异常 See merge request: Ascend/op-plugin!5466 | 21 天前 |