CANN ops-nn 算子解析SoftmaxCrossEntropyWithLogits 原理、aclnn 接口调用与源码实现【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nnSoftmaxCrossEntropyWithLogits 是 CANN ops-nn 神经网络算子库中用于分类任务的核心算子它把 Softmax 归一化与交叉熵损失计算融合为一次计算并同步给出对输入 logits 的反向梯度可直接服务于训练反传链路。本文以 算子 README 为主体结合仓库内的接口文档、op_api / op_host / op_kernel 源码与测试用例完整讲解该算子的支持平台、数学原理、参数规格、两段式 aclnn 接口调用、图模式构图方式以及底层 shape 推导与 tiling 分核实现帮助开发者掌握在 NPU 上正确、高效地使用与二次开发该算子。产品支持情况该算子在 CANN ops-nn 当前仓库版本下的平台支持情况如下来源算子 README 与 aclnn 接口文档产品是否支持Ascend 950PR / Ascend 950DT√Atlas A3 训练系列产品 / Atlas A3 推理系列产品√Atlas A2 训练系列产品 / Atlas A2 推理系列产品√Atlas 200I/500 A2 推理产品×Atlas 推理系列产品√Atlas 训练系列产品√需要注意的是不同平台的数据类型支持范围存在差异。接口文档中明确说明在 Atlas 训练系列产品910与 Atlas 推理系列产品310P上数据类型仅支持 FLOAT、FLOAT16而 910B/910_93Atlas A2 系列与 regbase 平台Ascend 950 系列、Atlas A3 系列额外支持 BFLOAT16。这一点与源码中按SocVersion区分数据类型支持列表的逻辑完全一致详见 aclnn_softmax_cross_entropy_with_logits.cpp。功能说明与数学原理接口功能计算 softmax 和 cross entropy 的交叉熵损失并给出对输入 logits 的反向梯度。计算公式$$ \text{loss} - \sum_i y_i \cdot \log(\text{softmax}(x_i)) $$$$ \text{backprop} \text{softmax}(x_i) - y_i $$其中$x_i$ 对应输入的features模型输出的 logits$y_i$ 对应输入的labels真实标签分布。从公式可以看出该算子一次调用同时完成三件事Softmax 归一化对features逐行沿最后一个维度做 softmax将 logits 转换为概率分布交叉熵损失将归一化概率与labels逐元素相乘后取负求和得到每个样本的 loss反向梯度直接以softmax(x) - y的形式给出对features的梯度这一形式恰好是交叉熵损失对 logits 的导数省去了训练中单独求导的步骤。仓库中的 ATK 测试执行器用 PyTorch 逐步骤实现了等价算法可直观印证该数学过程先减最大值做数值稳定、exp、求和、归一化得到 softmax再计算 log_softmax、乘 labels、取负求和得到 loss最后backprop softmax - labels详见 executor_aclnnSoftmaxCrossEntropyWithLogits.py。参数说明算子IR 定义层面的输入输出规格如下四个 Tensor 参数的数据格式均为ND参数名输入/输出描述数据类型数据格式features输入表示模型的输出 logits公式中 $x_i$FLOAT、FLOAT16、BFLOAT16NDlabels输入表示输入的 labels公式中 $y_i$FLOAT、FLOAT16、BFLOAT16NDloss输出表示 softmax 和 cross entropy 的交叉熵损失公式中 lossFLOAT、FLOAT16、BFLOAT16NDbackprop输出表示输入 logits 的反向梯度公式中 backpropFLOAT、FLOAT16、BFLOAT16ND上述参数声明与算子注册源码保持一致在 softmax_cross_entropy_with_logits_def.cpp 中features、labels两个必选输入与loss、backprop两个必选输出的数据类型均为{ge::DT_FLOAT, ge::DT_FLOAT16, ge::DT_BF16}格式均为FORMAT_ND。约束说明算子 README 中标注“无”额外约束但结合接口文档与源码实际使用时仍应注意以下边界条件features与labels的 shape、数据类型需一致输入输出数据类型需一致loss、backprop的数据类型必须与features一致单算子接口下要求 2 维输入详见下文源码分析确定性计算aclnnSoftmaxCrossEntropyWithLogits为默认确定性实现。两段式 aclnn 接口调用该算子通过 aclnn 单算子接口方式调用遵循 CANN 的两段式接口规范必须先调用第一段aclnnSoftmaxCrossEntropyWithLogitsGetWorkspaceSize获取计算所需 workspace 大小以及包含算子计算流程的执行器再调用第二段aclnnSoftmaxCrossEntropyWithLogits执行计算。函数原型aclnnStatus aclnnSoftmaxCrossEntropyWithLogitsGetWorkspaceSize( const aclTensor* features, aclTensor* labels, aclTensor* loss, aclTensor* backprop, uint64_t* workspaceSize, aclOpExecutor** executor)aclnnStatus aclnnSoftmaxCrossEntropyWithLogits( void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)第一段接口参数说明参数名输入/输出描述使用说明数据类型数据格式维度(shape)非连续 TensorfeaturesaclTensor*输入表示模型的输出 logits公式中 $x_i$支持空 TensorFLOAT、FLOAT16、BFLOAT16ND2√labelsaclTensor*输入表示输入的 labels公式中 $y_i$shape 和数据类型与 features 保持一致支持空 TensorFLOAT、FLOAT16、BFLOAT16ND2√lossaclTensor*输出表示 softmax 和 cross entropy 的交叉熵损失公式中 loss数据类型与 features 一致支持空 TensorFLOAT、FLOAT16、BFLOAT16ND1√backpropaclTensor*输出表示输入 logits 的反向梯度公式中 backprop数据类型与 features 一致支持空 TensorFLOAT、FLOAT16、BFLOAT16ND2√workspaceSizeuint64_t*输出返回需要在 Device 侧申请的 workspace 大小-----executoraclOpExecutor**输出返回 op 执行器包含算子计算流程-----需要说明的是在Atlas 训练系列产品、Atlas 推理系列产品上数据类型仅支持FLOAT、FLOAT16即表中 BFLOAT16 一列在上述平台不生效。第一段接口返回值与错误码aclnnStatus返回状态码具体参见 aclnn 返回码。第一段接口会完成入参校验出现以下场景时报错返回码错误码描述ACLNN_ERR_PARAM_NULLPTR161001传入的 features、labels、loss 或 backprop 是空指针ACLNN_ERR_PARAM_INVALID161002features 和 labels 的数据类型不在支持的范围之内第二段接口参数说明参数名输入/输出描述workspace输入在 Device 侧申请的 workspace 内存地址workspaceSize输入在 Device 侧申请的 workspace 大小由第一段接口aclnnSoftmaxCrossEntropyWithLogitsGetWorkspaceSize获取executor输入op 执行器包含算子计算流程stream输入指定执行任务的 Stream完整调用示例可编译运行仓库在 examples/test_aclnn_softmax_cross_entropy_with_logits.cpp 提供了完整可参考的调用样例具体编译与执行过程请参考 编译与运行样例。核心流程如下共分 7 步#include iostream #include vector #include acl/acl.h #include aclnnop/aclnn_softmax_cross_entropy_with_logits.h #define CHECK_RET(cond, return_expr) \ do { \ if (!(cond)) { \ return_expr; \ } \ } while (0) #define LOG_PRINT(message, ...) \ do { \ printf(message, ##__VA_ARGS__); \ } while (0) int64_t GetShapeSize(const std::vectorint64_t shape) { int64_t shapeSize 1; for (auto i : shape) { shapeSize * i; } return shapeSize; } // 固定写法device/stream 初始化 int Init(int32_t deviceId, aclrtStream* stream) { auto ret aclInit(nullptr); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclInit failed. ERROR: %d\n, ret); return ret); ret aclrtSetDevice(deviceId); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclrtSetDevice failed. ERROR: %d\n, ret); return ret); ret aclrtCreateStream(stream); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclrtCreateStream failed. ERROR: %d\n, ret); return ret); return 0; } // 工具函数申请 device 内存、拷贝 host 数据、创建 aclTensorND、连续 template typename T int CreateAclTensor(const std::vectorT hostData, const std::vectorint64_t shape, void** deviceAddr, aclDataType dataType, aclTensor** tensor) { auto size GetShapeSize(shape) * sizeof(T); auto ret aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclrtMalloc failed. ERROR: %d\n, ret); return ret); ret aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclrtMemcpy failed. ERROR: %d\n, ret); return ret); std::vectorint64_t strides(shape.size(), 1); for (int64_t i shape.size() - 2; i 0; i--) { strides[i] shape[i 1] * strides[i 1]; } *tensor aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND, shape.data(), shape.size(), *deviceAddr); return 0; } int main() { // 1.固定写法device/stream 初始化根据自己的实际 device 填写 deviceId int32_t deviceId 0; aclrtStream stream; auto ret Init(deviceId, stream); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(Init acl failed. ERROR: %d\n, ret); return ret); // 2. 构造输入与输出根据 API 的接口定义自定义构造 // 例batch_size16num_classes4loss 为 1 维 {16}backprop 与 features 同 shape std::vectorint64_t featuresShape {16, 4}; std::vectorint64_t labelsShape {16, 4}; std::vectorfloat featuresHostData(16 * 4, 1); std::vectorfloat labelsHostData(16 * 4, 2); void* featuresDeviceAddr nullptr; void* labelsDeviceAddr nullptr; aclTensor* features nullptr; aclTensor* labels nullptr; ret CreateAclTensor(featuresHostData, featuresShape, featuresDeviceAddr, aclDataType::ACL_FLOAT, features); CHECK_RET(ret ACL_SUCCESS, return ret); ret CreateAclTensor(labelsHostData, labelsShape, labelsDeviceAddr, aclDataType::ACL_FLOAT, labels); CHECK_RET(ret ACL_SUCCESS, return ret); std::vectorint64_t lossShape {16}; std::vectorfloat lossHostData(16, 8); aclTensor* loss nullptr; void* lossDeviceAddr nullptr; std::vectorint64_t backpropShape {16, 4}; std::vectorfloat backpropHostData(16 * 4, 9); aclTensor* backprop nullptr; void* backpropDeviceAddr nullptr; ret CreateAclTensor(lossHostData, lossShape, lossDeviceAddr, aclDataType::ACL_FLOAT, loss); CHECK_RET(ret ACL_SUCCESS, return ret); ret CreateAclTensor(backpropHostData, backpropShape, backpropDeviceAddr, aclDataType::ACL_FLOAT, backprop); CHECK_RET(ret ACL_SUCCESS, return ret); // 3. 调用 CANN 算子库 API两段式 uint64_t workspaceSize 0; aclOpExecutor* executor; // 第一段获取 workspace 大小与执行器 ret aclnnSoftmaxCrossEntropyWithLogitsGetWorkspaceSize(features, labels, loss, backprop, workspaceSize, executor); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(GetWorkspaceSize failed. ERROR: %d\n, ret); return ret); // 根据第一段接口计算出的 workspaceSize 申请 device 内存 void* workspaceAddr nullptr; if (workspaceSize 0) { ret aclrtMalloc(workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(allocate workspace failed. ERROR: %d\n, ret); return ret); } // 第二段执行计算 ret aclnnSoftmaxCrossEntropyWithLogits(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclnnSoftmaxCrossEntropyWithLogits failed. ERROR: %d\n, ret); return ret); // 4.固定写法同步等待任务执行结束 ret aclrtSynchronizeStream(stream); CHECK_RET(ret ACL_SUCCESS, LOG_PRINT(aclrtSynchronizeStream failed. ERROR: %d\n, ret); return ret); // 5. 获取输出的值将 device 侧内存上的结果拷贝至 host 侧示例仅打印 loss // PrintOutResult(lossShape, lossDeviceAddr); // 6. 释放 aclTensor aclDestroyTensor(features); aclDestroyTensor(labels); aclDestroyTensor(loss); aclDestroyTensor(backprop); // 7. 释放 device 资源 aclrtFree(featuresDeviceAddr); aclrtFree(labelsDeviceAddr); aclrtFree(lossDeviceAddr); aclrtFree(backpropDeviceAddr); if (workspaceSize 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; }使用要点示例使用featuresShape {16, 4}、labelsShape {16, 4}即 batch16、类别数4此时loss的 shape 为{16}1 维backprop的 shape 与features一致2 维CreateAclTensor中通过计算连续 strides 并调用aclCreateTensorACL_FORMAT_ND构造输入输出 Tensorworkspace 仅在workspaceSize 0时才需要申请申请方式同样为aclrtMalloc使用后必须aclrtFree释放示例代码注释中标明的PrintOutResult用于将 device 结果拷回 host 打印可按需启用。图模式调用方式除 aclnn 单算子接口外该算子同样支持图模式调用通过 算子 IRproto.h 构图方式调用 SoftmaxCrossEntropyWithLogits 算子。该 IR 文件通过REG_OP宏注册算子原型REG_OP(SoftmaxCrossEntropyWithLogits) .INPUT(features, TensorType({DT_DOUBLE, DT_FLOAT16, DT_BF16, DT_FLOAT})) .INPUT(labels, TensorType({DT_DOUBLE, DT_FLOAT16, DT_BF16, DT_FLOAT})) .OUTPUT(loss, TensorType({DT_DOUBLE, DT_FLOAT16, DT_BF16, DT_FLOAT})) .OUTPUT(backprop, TensorType({DT_DOUBLE, DT_FLOAT16, DT_BF16, DT_FLOAT})) .OP_END_FACTORY_REG(SoftmaxCrossEntropyWithLogits)IR 注释中补充了图模式下的关键语义features模型输出的未归一化分数需为batch_size * num_classes矩阵格式 ND 或 NHWC支持 2D、4D4D 输入时动态 shape 场景支持 bfloat16静态 shape 场景支持 float32labels与features同类型、同格式、同 shape 的真实标签矩阵loss每个样本的损失batch_size向量支持 1D、3D输入非 4D 时 loss 为 1D输入 4D 时 loss 为 3Dbackprop反传梯度矩阵与features同类型、同格式、同 shape第三方框架兼容性与 TensorFlow 算子SoftmaxCrossEntropyWithLogits兼容。此外仓库在 framework/softmax_cross_entropy_with_logits_tf_plugin.cpp 中提供了 TensorFlow 框架插件通过REGISTER_CUSTOM_OP将 TensorFlow 同名的SoftmaxCrossEntropyWithLogits算子直接映射到本算子AutoMappingByOpFn 自动参数映射ImplyType::TVM并在 framework/npu_softmax_cross_entropy_with_logits_onnx_plugin.cpp 提供 ONNX 模型接入支持便于第三方框架模型直接迁移到 NPU 上执行。源码级深入接口实现链路1. aclnn 接口实现op_api 层aclnn_softmax_cross_entropy_with_logits.cpp 完整实现了两段式接口其内部逻辑揭示了接口文档中各个约束的落地方式入参校验CheckParams依次执行空指针检查CheckNotNull对应返回码ACLNN_ERR_PARAM_NULLPTR/161001、数据类型合法性检查CheckDtypeValid对应返回码ACLNN_ERR_PARAM_INVALID/161002、shape 检查CheckShape。其中数据类型检查会同时校验features、labels、loss、backprop四个 Tensor 均在支持列表内并校验loss、backprop与features的数据类型一致shape 校验CheckShape要求features与labels的维度数均为 2即单算子接口固定接收 2 维输入这正是接口文档中“维度(shape)2”的来源空 Tensor 处理若features或labels为空 TensorIsEmpty()直接返回空 workspace 并结束符合“支持空 Tensor”的说明非连续 Tensor 支持通过l0op::Contiguous将非连续输入转为连续计算完成后通过l0op::ViewCopy将结果写回用户传入的非连续输出 Tensor实现接口文档中“非连续 Tensor√”的支持能力执行器封装底层通过l0op::SoftmaxCrossEntropyWithLogits构图返回(loss, backprop)二元组workspaceSize由uniqueExecutor-GetWorkspaceSize()获取最终CommonOpExecutorRun完成实际调度执行。2. 算子定义与 shape 推导op_host 层算子定义见 softmax_cross_entropy_with_logits_def.cppOpAICoreConfig aicoreConfig; aicoreConfig.DynamicCompileStaticFlag(true) .DynamicRankSupportFlag(true) .DynamicShapeSupportFlag(true) .PrecisionReduceFlag(false) .ExtendCfgInfo(opFile.value, softmax_cross_entropy_with_logits_apt); this-AICore().AddConfig(ascend950, aicoreConfig);即算子声明支持动态编译静态化、动态 Rank、动态 Shape并且PrecisionReduce 标志为 false不做精度降低AICore 实现挂载到 ascend950 平台对应 kernel 入口为softmax_cross_entropy_with_logits_apt。shape 推导实现见 softmax_cross_entropy_with_logits_infershape.cpp从中可以看到 IR 注释中“broadcasting is supported支持广播”的具体推导逻辑支持 features/labels 为 2 维如{N, C}、{N, 1}、{1, C}以及 4 维组合对每一维执行广播兼容性检查两个输入对应维度必须相等或其中一方为 1输出loss的 shape 取两个输入各维度的最大值2 维时输出 1 维{dim_0}4 维时输出 3 维{dim_0, dim_2, dim_3}输出backprop的 shape 同样按广播后的最大值推导2 维时为{dim_0, dim_1}4 维时为{dim_0, dim_1, dim_2, dim_3}。3. tiling 分核与 kernel 计算op_host/op_kernel 层在 ascend950arch35平台上tiling 计算见 softmax_cross_entropy_with_logits_tiling.cpp。从 tiling 结构与常量定义可以推断其分核策略将输入组织为A 轴外层/批量方向与R 轴内层/类别方向两维blockFactor/tailBlockFactor表示 A 轴分核后主核与尾核的数据量aLoopTimes/aLoopTimesT表示主核与尾核在 A 方向循环搬移数据的次数rUbNumFactor表示 R 轴切分时一次 UB 可容纳的数据量rLoopTime/rLoopTile表示 R 轴无法全载时反向循环次数与尾块数据量kTimes/kTimesTail表示完全二分累加时的循环次数预分配 workspace 大小为16 * 1024 * 102416 MB常量定义中还包含DOUBLE_BUFFER 2双缓冲、PING_PANG_AR_NUM/TEMP_BUF_AR_NUM等乒乓缓存与临时缓冲的 Buffer 数量配置体现面向流水线并行优化的设计。kernel 侧入口见 softmax_cross_entropy_with_logits_apt.cpp通过模板参数schId选择不同的调度模板schId 1时走SoftmaxCrossEntropyWithLogitsSplitRR 轴切分/不能全载模板见 softmax_cross_entropy_with_logits_split_r.hschId 0 || schId 2时走SoftmaxCrossEntropyWithLogitsFullLoad全载模板见 softmax_cross_entropy_with_logits_full_load.h。tiling 结构体定义见 softmax_cross_entropy_with_logits_tiling_data.h其中的realCoreNum、featuresBrcDim、labelsBrcDim等字段与广播场景、多核并行配置直接对应featuresBrc/labelsBrc模板参数则用于在编译期确定输入是否参与广播。测试与验证该算子在仓库中配有完整的单元测试与 ST 测试可作为实现正确性与使用方式的直接证据UT 测试接口层单测 tests/ut/op_api/test_aclnn_softmax_cross_entropy_with_logits.cpp直接调用两段式 aclnn 接口并校验输出shape 推导单测 tests/ut/op_host/test_softmax_cross_entropy_with_logits_infershape.cpp覆盖各维输入组合与广播场景的输出 shapetiling 单测 tests/ut/op_host/arch35/test_softmax_cross_entropy_with_logits_tiling.cpp验证分核参数计算。ST 测试ATK 用例 atk_aclnnSoftmaxCrossEntropyWithLogits.json 与执行器 executor_aclnnSoftmaxCrossEntropyWithLogits.py 提供了基于 PyTorch 的逐步骤等价实现作为期望结果Golden 参考tests/assets/golden.py 使用 TensorFlow 原生gen_nn_ops.softmax_cross_entropy_with_logits作为 golden 输出bfloat16/float16 输入会先转 float32 计算再转回从侧面印证了该算子与 TensorFlow 同名算子的数值兼容性平台测试矩阵tests/st/arch35/ttk_kernel_softmax_cross_entropy_with_logits.csv 列出了 arch35Ascend 950 系列平台上的 kernel 测试用例矩阵。总结SoftmaxCrossEntropyWithLogits 将 softmax、交叉熵损失与梯度计算融合为单个 NPU 算子前向一次计算即可同时产出loss与backprop两个结果训练场景下可显著减少算子调用次数与中间张量的搬运开销。开发者可按需选择两种接入方式aclnn 单算子接口两段式适合动态 Shape、需要精细控制执行流的场景参考 aclnn 接口文档 与 完整调用示例图模式算子 IR适合通过构图方式组网且天然兼容 TensorFlow 同名算子参考 softmax_cross_entropy_with_logits_proto.h。无论哪种方式使用前都应先对照“产品支持情况”确认目标平台并注意不同平台在数据类型BFLOAT16上的差异以及features/labels的 shape、数据类型一致性的约束。【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nn创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考