已合并
fix: improve log usability #4556
fix: improve log usability #4556
已合并
洪跃城创建于 9 天前
洪跃城
洪跃城成员
9 天前

Pull Request

描述

本次修改针对 GE 代码中的日志易用性问题进行整改,主要包括:

  • 修复日志中的英文拼写及语法问题;
  • 优化日志提示语义和表达;
  • 补充部分日志中的单位及上下文信息;
  • 统一部分日志及注释的英文表达;
  • 优化个别不规范的日志输出方式。

本次修改主要涉及日志和提示文本,不改变核心功能逻辑。

变更类型

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

关联的Issue

无关联Issue

如何测试

描述测试此变更的步骤和前提条件:

  1. 使用 git diff 对本次修改内容进行检查,确认修改范围均属于日志易用性整改。

  2. 使用 git diff --check 检查代码格式,确认不存在 trailing whitespace 等格式问题。

  3. 检查日志字符串修改前后的参数及格式化占位符,确认日志参数与原有逻辑保持一致。

  4. 确认本次修改主要涉及日志、提示信息及相关文本,不影响原有核心功能逻辑。

核对清单

其他信息

本次为日志易用性专项整改,修改范围涉及多个模块,主要针对现有日志中的拼写、语法、语义表达、单位信息以及日志输出规范进行优化。

相关修改不涉及对外接口变更,不改变现有业务流程及核心功能逻辑。

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 洪跃城 的贡献)
洪跃城洪跃城成员
9 天前 添加了label:enhancement
洪跃城洪跃城成员
9 天前 创建了 pull request,commit 72d8fbad
atomgit-bot
atomgit-bot
9 天前 评论:

变更摘要

本 PR(#4556,fix: improve log usability)是针对 GE 代码中日志易用性的专项整改,共涉及 54 个文件,改动以文本层面为主,不改变核心功能逻辑。主要工作包括修复日志与提示信息中的英文拼写、语法错误(如 "Dose"→"Does"、"fail"→"failed"、"concent"→"content"、"Uppdate"→"Update"、"can't not"→"cannot" 等),补充日志中的单位与上下文信息,统一并英文化生成代码中的注释与 T_DESC 等标记,以及优化不规范的日志输出方式(如将 printf/std::cerr 输出改为统一日志接口)。改动覆盖 api/aclbase/commonbase/formatscompilergraph_metadefparserruntime 等多个模块,涉及 ACL_LOG_INFOGELOGIGELOGEREPORT_INNER_ERR_MSGGE_ASSERT 等日志/断言宏的调用文本。

主要改动

  • 修复拼写与语法错误:在 base/formats/format_transfers/format_transfer_nc1hwc0_nchw.ccruntime/om2/formats/format_transfers/om2_format_transfer_hwcn_c1hwncoc0.cc 中修正 "Dose not support" 为 "Does not support";在 api/acl/stub/gen_stubapi.pyapi/atc/main_impl.cccompiler/graph/preprocess/hccl_offline_option_builder.ccgraph_metadef/register/op_binary_resource_manager.cccompiler/opcompiler/op_compile_adapter/register/interface_checker/check_interface.pyparser/parser/tensorflow/tensorflow_parser.ccruntime/v1/single_op/task/op_task.cc 等文件修正 "fail"→"failed"、"generate"→"generated"、"concent"→"content"、"resion"→"reason"、"supper"→"super"、"Uppdate"→"Update"、"can't not"→"cannot"、"[Date]"→"[Data]" 等拼写及语法问题。
  • 补充日志单位与上下文信息:在 runtime/v1/graph/load/model_manager/davinci_model.ccruntime/v1/graph/manager/active_memory_allocator.cc 的日志中补充 bytes 单位;在 api/acl/acl_model/model/model_common.cpp 中明确 "is longer than %zu characters";在 graph_metadef/base/common/plugin/plugin_manager.cc 的版本校验告警中补充所需版本范围信息 [%s]
  • 英文化生成代码与注释:在 base/common/om2/codegen/emitter/stable_parts/stable_part_provider.cc 中批量将 OpArgInfoAicoreDispatchInfoAicpuDispatchInfo 等稳定代码生成部分的中文注释译为英文;compiler/graph/eager_style_graph_builder/es_generator/py_generator.hpy_generator_utils.hbase/common/om2/codegen/file_code_generator/resources_file_code_generator.cc 中的代码生成注释同步英文化;api/python/ge/ge/_capi/*.py 的 docstring "C层" 改为 "C-layer",compiler/engines/hccl_engine/hcom_graph_adaptor/ge_plugin/common/hcom_log.hT_DESC 描述改为英文。
  • 统一日志输出方式:在 compiler/opcompiler/op_compile_adapter/source/compile/fusion_manager.cc 中将 PrintProgressHint 中逐点输出的 printf(".") + fflush(stdout) 改为 TE_INFOLOG("Compiling, please wait.");在 graph_metadef/graph/expression/expression_impl.cc 中将 Rational 中的 std::cerr 输出改为 GELOGE 日志;compiler/graph/manager/graph_manager.cc 中将不完整的日志消息 "Update " 补全为完整的 "Failed to update multi-batch context."。
  • 优化错误提示语义:在 compiler/graph/manager/graph_manager.ccbase/common/helper/mobile_model_helper.ccruntime/v2/lowering/graph_converter.ccgraph_metadef/graph/utils/ge_ir_utils.cctuning_utils.cc 等文件的错误与告警文案中,将 "may lost"、"is not support"、"can only held" 等不规范表达改为 "may be lost"、"does not support"、"can only be held" 等语义更准确的说法。
likedislike
atomgit-bot
atomgit-bot
9 天前 评论:

代码审查

✅ 未发现问题

likedislike
CANN-robotCANN-robot成员
9 天前 添加了label:cann-cla/yes
此处折叠了620条消息 查看更多
洪跃城
洪跃城成员
3 天前 评论:

/check-pr

likedislike
CANN-robot
CANN-robot成员
3 天前 评论:

The following label is not ready.

approved: Please wait for committers to review the code.

likedislike
张德鹏成员
3 天前 评论:

/approve

likedislike
CANN-robotCANN-robot成员
3 天前 添加了label:approved
CANN-robotCANN-robot成员
3 天前 合入了pull request