已合并
[modify docs]修改文档中不规范用语 #5618
zangyan创建于 9月22日
[modify docs]修改文档中不规范用语 #5618
已合并
共 9 个文件变更+20-17
| @@ -17,7 +17,7 @@ Value 2147483648 for environment variable HCCL_EXEC_TIMEOUT is invalid. Expected | |||
| 17 | <!-- npu="950" id1 --> | 17 | <!-- npu="950" id1 --> |
| 18 | ## Locating the fault in plog | 18 | ## Locating the fault in plog |
| 19 | 19 | ||
| 20 | -The error format above is used for ERROR MESSAGE reporting. For Ascend 950PR&950DT series products, the corresponding plog contains the environment variable name, configured value, and reason, with the following search keywords: | 20 | +The error format above is used for ERROR MESSAGE reporting. For Ascend 950PR&950DT products, the corresponding plog contains the environment variable name, configured value, and reason, with the following search keywords: |
 | |||
| 21 | 21 | ||
| 22 | | Error code | Error title | Stage keyword | Scenario keyword | Engine keyword | | 22 | | Error code | Error title | Stage keyword | Scenario keyword | Engine keyword | |
| 23 | | --- | --- | --- | --- | --- | | 23 | | --- | --- | --- | --- | --- | |
| @@ -20,7 +20,7 @@ An error CQE occurred during operator execution. Local information: server az0-r | |||
| 20 | 20 | ||
| 21 | 2. The peer process exits unexpectedly in advance. As a result, the local end cannot receive the response from the peer end. | 21 | 2. The peer process exits unexpectedly in advance. As a result, the local end cannot receive the response from the peer end. |
| 22 | 22 | ||
| 23 | -3. The hardware of the HBM or UB chip processing module of either device is abnormal. | 23 | +3. The hardware of the On-chip memory or UB chip processing module of either device is abnormal. |
| 24 | 24 | ||
| 25 | ## Solution | 25 | ## Solution |
| 26 | 26 | ||
| @@ -28,4 +28,4 @@ An error CQE occurred during operator execution. Local information: server az0-r | |||
| 28 | 28 | ||
| 29 | 2. Check whether the peer process exits first. If yes, check the reason why the process exit. | 29 | 2. Check whether the peer process exits first. If yes, check the reason why the process exit. |
| 30 | 30 | ||
| 31 | -3. Use the RAS fault check mechanism to check whether the hardware of the HBM or UB chip processing module of either device is abnormal. If the hardware is abnormal, contact Huawei technical support. | 31 | +3. Use the RAS fault check mechanism to check whether the hardware of the On-chip memory or UB chip processing module of either device is abnormal. If the hardware is abnormal, contact Huawei technical support. |
| @@ -104,16 +104,17 @@ typedef struct HcclCommConfigDef { | |||
| 104 | - 该配置仅支持对称组网、推理特性。 | 104 | - 该配置仅支持对称组网、推理特性。 |
| 105 | - 该配置项支持的算子及约束限制参见配置“3”。 | 105 | - 该配置项支持的算子及约束限制参见配置“3”。 |
| 106 | 106 | ||
| 107 | - - 5：通信算子在CCU（Collective Communication Unit，集合通信加速单元）展开，使用MS（Memory Slice）模式。Ascend 950PR不支持此配置。 | 107 | + - 5：通信算子在CCU（Collective Communication Unit，集合通信加速单元）展开，使用CcuBuffer进行内存转写。Ascend 950PR不支持此配置。 |
[MEDIUM] 同一 PR 内对 CCU_MS 模式的描述用词不一致：“内存转写” vs “内存读写” 本 PR 在 HcclCommConfig.md:107 将模式5描述为“使用CcuBuffer进行内存转写”，但在同一 PR 修改的 HcclOpExpansionMode.md:16 中描述为“使用CcuBuffer进行内存读写”，且本文件 109 行也写作“内存读写带宽”。“内存转写”非规范用语，且与同 PR 其他两处表述冲突。建议统一为“使用CcuBuffer进行内存读写。”，与 HcclOpExpansionMode.md 保持一致。   | |||
| 108 | 108 | ||
| 109 | - MS模式为与多个远端通信时，使用CCU片上Memory Slice作为中转，用于节省内存读写带宽，Memory Slice的特点是大小较小，但速度较快。当CCU资源不足时，系统会自动切换为“2：AI CPU模式”。 | 109 | + 此模式下，当CCU与多个远端通信时，使用CcuBuffer作为中转，用于节省内存读写带宽，CcuBuffer的特点是大小较小，但速度较快。当CCU资源不足时，系统会自动切换为“2：AI CPU模式”。 |
| 110 | - - 该配置项仅支持Broadcast、Reduce、AllReduce、ReduceScatter、AllGather、AllGatherV、ReduceScatterV算子，当前仅支持单机场景。 | 110 | + |
| 111 | - - 针对Broadcast、AllGather、AllGatherV算子，数据类型支持int8、uint8、int16、uint16、int32、uint32、int64、uint64、float16、float32、float64、bfp16。 | 111 | + 该配置项仅支持Broadcast、Reduce、AllReduce、ReduceScatter、AllGather、AllGatherV、ReduceScatterV算子，当前仅支持单机场景。 |
| 112 | - - 针对Reduce、AllReduce、ReduceScatter、ReduceScatterV算子，数据类型支持int16、int32、float16、float32、bfp16。 | 112 | + - 针对Broadcast、AllGather、AllGatherV算子，数据类型支持int8、uint8、int16、uint16、int32、uint32、int64、uint64、float16、float32、float64、bfp16。 |
| 113 | + - 针对Reduce、AllReduce、ReduceScatter、ReduceScatterV算子，数据类型支持int16、int32、float16、float32、bfp16。 | ||
| 113 | 114 | ||
| 114 | - 6：通信算子在CCU展开，使用调度模式。 | 115 | - 6：通信算子在CCU展开，使用调度模式。 |
| 115 | 116 | ||
| 116 | - 调度模式指使用CCU作为调度器，向UB引擎调度UB WQE任务。调度模式下不使用CCU的片上MS，直接在两个rank间进行HBM到HBM的数据传输。 | 117 | + 调度模式指使用CCU作为调度器，向UB引擎调度UB WQE任务。调度模式下不使用CcuBuffer，直接在两个rank间进行片上内存到片上内存的数据传输。 |
| 117 | 118 | ||
| 118 | 针对单机通信场景的AllReduce、ReduceScatter、Reduce算子，当数据量超过一定值时，为防止性能下降，系统会自动切换为“2：AI_CPU模式”（该阈值并非固定，会根据算子运行模式及网络规模等因素有所调整）。 | 119 | 针对单机通信场景的AllReduce、ReduceScatter、Reduce算子，当数据量超过一定值时，为防止性能下降，系统会自动切换为“2：AI_CPU模式”（该阈值并非固定，会根据算子运行模式及网络规模等因素有所调整）。 |
| 119 | 120 | ||
| @@ -13,7 +13,7 @@ typedef enum { | |||
| 13 | HCCL_OP_EXPANSION_MODE_AIV = 1, /* 在Device侧Vector Core (AIV) 上展开。 */ | 13 | HCCL_OP_EXPANSION_MODE_AIV = 1, /* 在Device侧Vector Core (AIV) 上展开。 */ |
| 14 | HCCL_OP_EXPANSION_MODE_HOST = 2, /* 在Host侧CPU上展开，Device侧根据硬件型号自动选择调度器。 */ | 14 | HCCL_OP_EXPANSION_MODE_HOST = 2, /* 在Host侧CPU上展开，Device侧根据硬件型号自动选择调度器。 */ |
| 15 | HCCL_OP_EXPANSION_MODE_HOST_TS = 3, /* 在Host侧CPU上展开，由Host向Device Task Scheduler下发任务，Device侧进行调度执行。 */ | 15 | HCCL_OP_EXPANSION_MODE_HOST_TS = 3, /* 在Host侧CPU上展开，由Host向Device Task Scheduler下发任务，Device侧进行调度执行。 */ |
| 16 | - HCCL_OP_EXPANSION_MODE_CCU_MS = 4, /* 在Device侧CCU（集合通信加速单元）上展开，使用MS（Memory Slice）模式。 */ | 16 | + HCCL_OP_EXPANSION_MODE_CCU_MS = 4, /* 在Device侧CCU（集合通信加速单元）上展开，使用CcuBuffer进行内存读写。 */ |
| 17 | HCCL_OP_EXPANSION_MODE_CCU_SCHED = 5, /* 在Device侧CCU上展开，使用调度模式（CCU作为调度器向UB引擎调度任务）。 */ | 17 | HCCL_OP_EXPANSION_MODE_CCU_SCHED = 5, /* 在Device侧CCU上展开，使用调度模式（CCU作为调度器向UB引擎调度任务）。 */ |
| 18 | HCCL_OP_EXPANSION_AIV_ONLY = 6, /* 仅在Device侧Vector Core (AIV) 上展开，不随数据量变化进行模式切换。 */ | 18 | HCCL_OP_EXPANSION_AIV_ONLY = 6, /* 仅在Device侧Vector Core (AIV) 上展开，不随数据量变化进行模式切换。 */ |
| 19 | } HcclOpExpansionMode; | 19 | } HcclOpExpansionMode; |
| @@ -53,7 +53,9 @@ HcclResult HcclCommQueryCcuIns(HcclComm comm, CcuInsHandle *insHandles, uint32_t | |||
| 53 | - 当通信域的自有CCU实例句柄为`0`、且算子扩展模式未使能CCU时，返回HCCL_E_UNAVAIL，不创建实例。 | 53 | - 当通信域的自有CCU实例句柄为`0`、且算子扩展模式未使能CCU时，返回HCCL_E_UNAVAIL，不创建实例。 |
| 54 | - 当创建CCU实例失败时，返回创建接口的原始错误码（透传CcuResult，如CCU_E_DRV_BUSY、CCU_E_UNAVAIL等）。 | 54 | - 当创建CCU实例失败时，返回创建接口的原始错误码（透传CcuResult，如CCU_E_DRV_BUSY、CCU_E_UNAVAIL等）。 |
| 55 | 55 | ||
| 56 | -> [!NOTE]资源不足处理 | 56 | +> [!NOTE]说明 |
| 57 | +> 资源不足时，进行以下处理： | ||
| 58 | +> | ||
| 57 | > - 当算子扩展模式为CCU_MS且CCU资源不足以创建CCU_MS实例时，本接口会自动降级到CCU_SCHED重试创建一次。 | 59 | > - 当算子扩展模式为CCU_MS且CCU资源不足以创建CCU_MS实例时，本接口会自动降级到CCU_SCHED重试创建一次。 |
| 58 | > - 当CCU_SCHED实例也无法创建（资源仍不足）时，返回HCCL_E_UNAVAIL。**本接口不会自动降级到AICPU_TS**，调用方需在收到HCCL_E_UNAVAIL后自行决定是否降级。 | 60 | > - 当CCU_SCHED实例也无法创建（资源仍不足）时，返回HCCL_E_UNAVAIL。**本接口不会自动降级到AICPU_TS**，调用方需在收到HCCL_E_UNAVAIL后自行决定是否降级。 |
| 59 | 61 | ||
| @@ -64,7 +66,7 @@ HcclResult HcclCommQueryCcuIns(HcclComm comm, CcuInsHandle *insHandles, uint32_t | |||
| 64 | 3. 本接口查询的CCU实例与通过`HcclCommAssignCcuIns`绑定的CCU实例相互独立，二者不会相互覆盖或影响。 | 66 | 3. 本接口查询的CCU实例与通过`HcclCommAssignCcuIns`绑定的CCU实例相互独立，二者不会相互覆盖或影响。 |
| 65 | 4. 返回的CCU实例句柄仅供借用，所有权仍归通信域所有，由通信域负责释放。调用者不可销毁该实例，否则会造成对同一实例的重复释放，破坏通信域的资源管理。 | 67 | 4. 返回的CCU实例句柄仅供借用，所有权仍归通信域所有，由通信域负责释放。调用者不可销毁该实例，否则会造成对同一实例的重复释放，破坏通信域的资源管理。 |
| 66 | 5. 本接口仅保证多次`HcclCommQueryCcuIns`调用之间的幂等性（已创建则直接返回，不重复创建）。调用方须保证本接口不与`HcclCommAssignCcuIns`或`HcclCommDestroy`并发执行。 | 68 | 5. 本接口仅保证多次`HcclCommQueryCcuIns`调用之间的幂等性（已创建则直接返回，不重复创建）。调用方须保证本接口不与`HcclCommAssignCcuIns`或`HcclCommDestroy`并发执行。 |
| 67 | -6. CCU资源不足时本接口仅在CCU_MS→CCU_SCHED之间自动降级一次，不会自动降级到AICPU_TS。调用方收到HCCL_E_UNAVAIL后需自行处理是否降级到AICPU_TS模式。 | 69 | +6. CCU资源不足时本接口仅在CCU_MS → CCU_SCHED之间自动降级一次，不会自动降级到AICPU_TS。调用方收到HCCL_E_UNAVAIL后需自行处理是否降级到AICPU_TS模式。 |
| 68 | 7. comm必须为有效的通信域句柄（由通信域创建接口获得，调用期间保持有效）。禁止传入空指针、野指针或已销毁的句柄。 | 70 | 7. comm必须为有效的通信域句柄（由通信域创建接口获得，调用期间保持有效）。禁止传入空指针、野指针或已销毁的句柄。 |
| 69 | 71 | ||
| 70 | ## 调用示例 | 72 | ## 调用示例 |
| @@ -79,7 +79,7 @@ RankGraph 使用图（Graph）对通信域内不同 Rank 间的连接关系进 | |||
| 79 | |------|-----------|---------| | 79 | |------|-----------|---------| |
| 80 | | **通信设备(Endpoint)** | 网络通信的逻辑接口，包含协议与地址 | NPU 网口 / Host NIC | | 80 | | **通信设备(Endpoint)** | 网络通信的逻辑接口，包含协议与地址 | NPU 网口 / Host NIC | |
| 81 | | **通信通道(Channel)** | 两端通信设备间的数据通道（含同步 Notify） | RoCE QP / UB Jetty 连接 | | 81 | | **通信通道(Channel)** | 两端通信设备间的数据通道（含同步 Notify） | RoCE QP / UB Jetty 连接 | |
| 82 | -| **通信内存(CommMem)** | 注册到通信域、可被通信设备(Endpoint)访问的内存段 | NPU HBM / Host 内存 | | 82 | +| **通信内存(CommMem)** | 注册到通信域、可被通信设备(Endpoint)访问的内存段 | NPU片上内存 / Host内存 | |
| 83 | | **通信引擎(CommEngine)** | 执行通信任务的模块，含 Thread 与线程调度器，驱动通信硬件搬移数据 | AICPU_TS、CCU、AIV | | 83 | | **通信引擎(CommEngine)** | 执行通信任务的模块，含 Thread 与线程调度器，驱动通信硬件搬移数据 | AICPU_TS、CCU、AIV | |
| 84 | 84 | ||
| 85 | > **组合关系**: Channel = 两端通信设备 + 通信协议 + N Notifys | 85 | > **组合关系**: Channel = 两端通信设备 + 通信协议 + N Notifys |
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | ## 选择策略 | 3 | ## 选择策略 |
| 4 | 4 | ||
| 5 | -使用CCU引擎可以节省HBM带宽，相比AI CPU模式可以减少通信展开时间，并且不占用计算硬件（例如AIV）。但同时，CCU的硬件资源是有限的，因此推荐在有极致性能要求的关键场景中使用，例如TP、EP并行。 | 5 | +使用CCU引擎可以节省片上内存带宽，相比AI CPU模式可以减少通信展开时间，并且不占用计算硬件（例如AIV）。但同时，CCU的硬件资源是有限的，因此推荐在有极致性能要求的关键场景中使用，例如TP、EP并行。 |
| 6 | 6 | ||
| 7 | **图1** 通信算法选择示意图 | 7 | **图1** 通信算法选择示意图 |
| 8 |  | 8 |  |
| @@ -23,7 +23,7 @@ Value 2147483648 for environment variable HCCL_EXEC_TIMEOUT is invalid. Expected | |||
| 23 | | --- | --- | --- | --- | --- | | 23 | | --- | --- | --- | --- | --- | |
| 24 | | EI0001 | Config_Error_Invalid_Environment_Variable环境变量配置异常 | InitGroupStage | EnvConfig | - | | 24 | | EI0001 | Config_Error_Invalid_Environment_Variable环境变量配置异常 | InitGroupStage | EnvConfig | - | |
| 25 | 25 | ||
| 26 | -可使用`grep -F '[InitGroupStage][EnvConfig]'`检索plog。例如，设置`HCCL_ENTRY_LOG_ENABLE=-1`时，日志正文包含以下信息，表示该环境变量仅支持0或1： | 26 | +可使用`grep -F '[InitGroupStage][EnvConfig]'`检索plog日志。例如，设置`HCCL_ENTRY_LOG_ENABLE=-1`时，日志正文包含以下信息，表示该环境变量仅支持0或1： |
| 27 | 27 | ||
| 28 | ```text | 28 | ```text |
| 29 | [InitGroupStage][EnvConfig] ... Env config "HCCL_ENTRY_LOG_ENABLE" value "-1" is invalid. ... Should be 0 or 1 | 29 | [InitGroupStage][EnvConfig] ... Env config "HCCL_ENTRY_LOG_ENABLE" value "-1" is invalid. ... Should be 0 or 1 |
| @@ -20,7 +20,7 @@ An error CQE occurred during operator execution. Local information: server az0-r | |||
| 20 | 20 | ||
| 21 | 2. 对端进程提前异常退出，导致本端无法接收到对端的响应。 | 21 | 2. 对端进程提前异常退出，导致本端无法接收到对端的响应。 |
| 22 | 22 | ||
| 23 | -3. 两个设备中的任意一个设备的HBM或UB芯片处理模块发生了硬件异常。 | 23 | +3. 两个设备中的任意一个设备的片上内存或UB芯片处理模块发生了硬件异常。 |
| 24 | 24 | ||
| 25 | ## 解决方法 | 25 | ## 解决方法 |
| 26 | 26 | ||
| @@ -28,4 +28,4 @@ An error CQE occurred during operator execution. Local information: server az0-r | |||
| 28 | 28 | ||
| 29 | 2. 检查对端进程是否先退出。如果是，检查进程退出的原因。 | 29 | 2. 检查对端进程是否先退出。如果是，检查进程退出的原因。 |
| 30 | 30 | ||
| 31 | -3. 通过RAS故障检查两台设备中任一设备的HBM或UB芯片处理模块是否发生硬件异常, 硬件错误请联系华为工程师处理。 | 31 | +3. 通过RAS故障检查两台设备中任一设备的片上内存或UB芯片处理模块是否发生硬件异常, 硬件错误请联系华为工程师处理。 |
[MEDIUM] en 删除“series”后与中文文档不一致（950PR&950DT系列产品）
本行将“For Ascend 950PR&950DT series products”改为“For Ascend 950PR&950DT products”，但对应的中文文档 docs/zh/error_codes/EI0001-Config_Error_Invalid_Environment_Variable.md:20 仍保留“针对Ascend 950PR&950DT系列产品”，且仓内中文 API 文档（如 HcclCommQueryCcuIns.md:6、HcommChannelCreateWithConfig.md:6 等）均使用“950PR&950DT系列产品”表述。中英文文档现不一致。建议保持中英文对齐：若认为“series products”不准确，同步将中文的“系列”一并去掉；否则英文保留“series products”。