已合并
【PR】: 修改资料中的斜体展示问题 #4131
Sophia1213创建于 7月24日
【PR】: 修改资料中的斜体展示问题 #4131
已合并
Sophia1213创建于 7月24日
Sophia1213
Sophia1213成员
7月24日

Pull Request

描述

1、修改斜体以及加粗展示问题
2、接口参考删除多余的字段
3、部分接口补充跳转链接

变更类型

请选择本次引入的变更类型:

关联的Issue

不涉及

如何测试

根据最新资料测试

核对清单

其他信息

在此添加任何其他关于本次 PR 的说明。

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 Sophia1213 的贡献)
Sophia1213Sophia1213成员
7月24日 添加了label:enhancement
Sophia1213Sophia1213成员
7月24日 创建了 pull request,commit d1382216
atomgit-bot
atomgit-bot
7月24日 评论:

变更摘要

本次 PR 主要针对文档资料进行批量修正与完善,涉及约 110 个文件的调整。核心改动包括:修复文档中斜体与加粗文本的渲染显示问题;清理接口参考文档中多余的冗余字段;以及为部分接口补充缺失的跳转链接。变更类型为文档内容更新,整体以删除(648 行)为主,新增(307 行)为辅,属于对现有文档的质量优化。

主要改动

  • 修复斜体与加粗展示问题:调整文档中 Markdown 或富文本的斜体(italic)与加粗(bold)标记,使其在最终渲染时正确显示,避免样式失效。
  • 清理接口参考多余字段:删除接口参考文档中已废弃或不再使用的字段定义,使接口描述更加精简准确。
  • 补充接口跳转链接:为部分接口文档页面补充缺失的超链接,方便读者在文档之间导航跳转。
likedislike
atomgit-bot
atomgit-bot
7月24日 评论:

代码审查

Closing Summary

经过对全部 110 个变更文件的逐一审查,发现 4 个问题,按优先级分布如下:

优先级 数量 说明
P2 1 Markdown 子列表缩进错误导致文档层级结构丢失
P3 3 子列表缩进退步、npu 标签与内容不一致、文件末尾缺换行符

关于 ProfilingAicoreMetrics.md 的 P3 报出(confidence 0.4)需补充说明:二次核实后发现,原文件中 kAicoreL2Cache 的产品列表本就只有 310b/910b/A3/950 四项,新增的 npu="950,A3,910b,310b" 标签与内容完全吻合。该报出为误报,请忽略或关闭。

各文件审查结果汇总

以下按变更文件列表逐一给出审查结论:

  • docs/zh/api/graph_engine_api/README.md — 无问题(路径修正、缩进修正正确)
  • docs/zh/api/graph_engine_api/c/acl/aclRecoverAllHcclTasks.md — 无问题(状态从"预留"改为"试验特性",补全产品支持标签和 @ref)
  • docs/zh/api/graph_engine_api/cpp/ge/AttrValue/AttrValue_constructor_and_destructor.md — 无问题(删除"异常处理"空节)
  • docs/zh/api/graph_engine_api/cpp/ge/AttrValue/CreateFrom.md — 无问题(同上)
  • docs/zh/api/graph_engine_api/cpp/ge/AttrValue/GetAttrValue.md — 无问题(同上)
  • docs/zh/api/graph_engine_api/cpp/ge/AttrValue/GetValue.md — 无问题(同上)
  • docs/zh/api/graph_engine_api/cpp/ge/AttrValue/SetAttrValue.md — 无问题(同上)
  • docs/zh/api/graph_engine_api/cpp/ge/GeSession/GEFinalizeV2.md — 无问题(补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/GeSession/SetGraphFixedFeatureMemoryBaseWithType.md — 无问题(补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/Graph/GetAllOpName.md — 无问题(删除重复 NOTE 块和多余代码围栏)
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/Create.md — 无问题(删除"异常处理"空节)
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/GetInputHandleShapesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/GetMarks.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/GetOutputHandleShapesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/InferenceContext_constructor_and_destructor.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/SetInputHandleShapesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/SetMarks.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/InferenceContext/SetOutputHandleShapesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/LogicalStreamAllocationInfo/ToStringInfo.md — 无问题(分隔符从句号改为句点,空值字段去掉冒号-值格式)
  • docs/zh/api/graph_engine_api/cpp/ge/NamedIoNodeBuilder/NamedIoNodeBuilder_constructor_and_destructor.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/AddControlInput.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/AttrRegister.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/BreakConnect.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/DynamicInputRegister.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/DynamicInputRegisterByIndex.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/DynamicOutputRegister.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetAllAttrNamesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetAllIrAttrNamesAndTypes.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetDynamicInputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetDynamicOutputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetDynamicSubgraph.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetDynamicSubgraphBuilder.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetInferenceContext.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetInputAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetInputConstData.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetInputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetInputsSize.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetName.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetOpType.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetOutputAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetOutputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetSubgraph.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetSubgraphBuilder.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetSubgraphNames.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/GetSubgraphNamesCount.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/InferShapeAndType.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/IsEmpty.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/Operator_constructor_and_destructor.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetInferenceContext.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetInput.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetInputAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetOutputAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetSubgraphBuilder.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SetSubgraphInstanceName.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/SubgraphCountRegister.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/UpdateDynamicInputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/UpdateDynamicOutputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/UpdateOutputDesc.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/Operator/VerifyAllAttr.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/ProfilingAicoreMetrics.md — 误报(见上文说明,标签与内容实际一致)
  • docs/zh/api/graph_engine_api/cpp/ge/Session/GraphDebugJSONPrint.md — 无问题(补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/Session/SetGraphFixedFeatureMemoryBase.md — 无问题(补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/Session/SetGraphFixedFeatureMemoryBaseWithType.md — 无问题(补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/Session/ShardGraphs.md — 无问题(接口已废弃,删除产品支持合理)
  • docs/zh/api/graph_engine_api/cpp/ge/Session/ShardGraphsToFile.mdP3 子列表缩进退步
  • docs/zh/api/graph_engine_api/cpp/ge/ShapeAndType/GetDataType.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/ShapeAndType/GetShape.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/ShapeAndType/SetShape.md — 无问题("返回值"→"返回值说明"统一标题)
  • docs/zh/api/graph_engine_api/cpp/ge/ShapeAndType/SetType.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/ShapeAndType/ShapeAndType_constructor_and_destructor.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/basic_functions.md — 无问题(soc_version 查询统一链接到集中页面)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/deprecated_config_for_future_versions.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/experimental_parameters.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/function_debugging.md — 无问题(代码块缩进修正、补全链接)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/operator_and_graph_compilation.md — 无问题(斜体标记清理、格式修正)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/precision_tuning.md — 无问题(斜体标记清理)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildInitialize_config_params/quantization_compression.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildModel.mdP2 子列表缩进导致层级丢失
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildModel_config_params/AOE.md — 无问题(斜体标记清理)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildModel_config_params/basic_functions.md — 无问题(补全产品标签、清理 @ref)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildModel_config_params/dynamic_shape.md — 无问题(补全链接和产品标签、清理斜体标记)
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBuildModel_config_params/precision_tuning.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/aclgrphBundleSaveModel.md — 无问题(补全内部链接)
  • docs/zh/api/graph_engine_api/cpp/ge/attribute_name_list.md — 无问题(补全产品标签、删除 MC62/BS9SX/IPV350 冗余条目)
  • docs/zh/api/graph_engine_api/cpp/ge/fusion/MatchResult/MatchResult_constructor_and_destructor.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/fusion/PatternMatcher/MatchNext.md — 无问题(mermaidplaintext,ASCII 图正确)
  • docs/zh/api/graph_engine_api/cpp/ge/fusion/SubgraphInput/overview.md — 无问题(同上)
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/AOE.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/basic_functions.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/dynamic_shape.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/memory_management.md — 无问题(路径用反引号包裹、清理斜体标记)
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/operator_and_graph_compilation.md — 无问题(h2dOverlappedWithCompute 节重构、代码围栏缩进修正)
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/precision_comparison.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/options_params/precision_tuning.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/parser_config_parameters.md — 无问题
  • docs/zh/api/graph_engine_api/cpp/ge/prototype_definition_derived_interface.md — 无问题(补全链接、清理加粗标记)
  • docs/zh/api/graph_engine_api/python/ge/pyatc/Pyatc.md — 无问题(soc_version 统一链接)
  • docs/zh/api/graph_engine_api/python/ge/session/Session/overview.mdP3 缺少文件末尾换行符
  • docs/zh/user_guides/atc_tools/CLI_options/--op_debug_config.md — 无问题(代码块缩进修正、consoleplaintext
  • docs/zh/user_guides/atc_tools/CLI_options/--output_type.md — 无问题(合并产品标签、删除冗余 IPV350 行)
  • docs/zh/user_guides/atc_tools/overview/environment_setup.md — 无问题
  • docs/zh/user_guides/env_vars/ASCEND_MAX_OP_CACHE_SIZE.md — 无问题(补全链接)
  • docs/zh/user_guides/env_vars/DUMP_GRAPH_LEVEL.md — 无问题(补全链接)
  • docs/zh/user_guides/env_vars/DUMP_GRAPH_PATH.md — 无问题(路径用反引号包裹)
  • docs/zh/user_guides/env_vars/GE_USE_STATIC_MEMORY.md — 无问题(补全链接)
  • docs/zh/user_guides/env_vars/README.md — 无问题(标题更名为"GE图引擎环境变量")
  • docs/zh/user_guides/graph_dev/overview/GE_definition.md — 无问题(产品名更新)
  • docs/zh/user_guides/graph_dev/overview/environment_setup.md — 无问题

整体风险评估

风险级别:低。 本次变更全部为文档类修改,未涉及任何代码或配置变更。唯一需要关注的是 aclgrphBuildModel.md 的子列表缩进问题(P2),会导致该页面的层级结构在部分 Markdown 渲染器中异常显示,影响用户对"模型保存方式"两个子选项的从属关系理解。其余 2 个有效问题(P3)影响极小。未发现安全风险、数据风险或生产环境风险。

类型 数量
🔴 阻塞 0
🟡 建议 1

💬 仅评论

likedislike
CANN-robotCANN-robot成员
7月24日 添加了label:cann-cla/yes
此处折叠了48条消息 查看更多
王涛成员
29 天前 评论:

/lgtm

likedislike
zhanj
zhanj成员
29 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
29 天前 添加了label:approved
CANN-robotCANN-robot成员
29 天前 解决了最后一个问题
CANN-robotCANN-robot成员
29 天前 合入了pull request