# aclnnBinaryCrossEntropyBackward ## 支持的产品型号 - Atlas 推理系列产品。 - Atlas 训练系列产品。 - Atlas A2训练系列产品/Atlas 800I A2推理产品。 ## 接口原型每个算子分为[两段式接口](common/两段式接口.md)，必须先调用“aclnnBinaryCrossEntropyBackwardGetWorkspaceSize”接口获取入参并根据流程计算所需workspace大小，再调用“aclnnBinaryCrossEntropyBackward”接口执行计算。 * `aclnnStatus aclnnBinaryCrossEntropyBackwardGetWorkspaceSize(const aclTensor *gradOutput, const aclTensor *self, const aclTensor *target, const aclTensor *weightOptional, int64_t reduction, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)` * `aclnnStatus aclnnBinaryCrossEntropyBackward(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)` ## 功能描述 - 算子功能：求二元交叉熵反向传播的梯度值。 - 计算公式：已知二元交叉熵的计算公式如下： $$ y_i = -weight_i \cdot (target_i \cdot ln(x_i) + (1-target_i) \cdot ln(1-x_i)) $$ 其中$x$表示网络前一层的输出，即正向的预测值；$target$表示样本的标签值，求二元交叉熵对$x$的偏导： $$ \begin{aligned} \frac {\partial y}{\partial x} &= -weight \cdot \frac {\partial ((target_i \cdot ln(x_i) + (1-target_i) \cdot ln(1-x_i))}{\partial x} \\ &= -weight \cdot (\frac {\partial (target \cdot ln(x))}{\partial x} + \frac {\partial ((1-target) \cdot ln(1-x))}{\partial x}) \\ &= -weight \cdot (\frac {target}{x} - \frac {(1-target)}{1-x}) \\ &= -weight \cdot \frac {target(1-x)-x(1-target)}{x(1-x)} \\ &= -weight \cdot \frac {target-x}{x(1-x)} \\ &= weight \cdot \frac {x-target}{x(1-x)} \end{aligned} $$ $$ out = grad\_output \cdot weight \cdot \frac {x-target}{x(1-x)} \\ out = mean(grad\_input) \ if \ reduction = mean $$ ## aclnnBinaryCrossEntropyBackwardGetWorkspaceSize - **参数说明：** * gradOutput(const aclTensor \*, 计算输入): 网络反向传播前一步的梯度值，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与其它参数一起转换到promotion类型，shape可以broadcast到self的shape。支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND。 * self(const aclTensor \*, 计算输入): 网络正向前一层的计算结果，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与其它参数一起转换到promotion类型，支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND。 * target(const aclTensor \*, 计算输入): 样本的标签值，取值范围为0~1，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与其它参数一起转换到promotion类型，shape可以broadcast到self的shape。支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND。 * weightOptional(const aclTensor \*, 计算输入): 结果的权重，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与其它参数一起转换到promotion类型，shape可以broadcast到self的shape。支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND当weightOptional为空时，需要以self的shape创建一个全1的Tensor。 * reduction(int64_t, 计算输入): 表示对二元交叉熵反向求梯度计算结果做的reduce操作，仅支持0,1,2三个值，0表示不做任何操作；1表示对结果取平均值；2表示对结果求和。 * out(aclTensor \*, 计算输出): 存储梯度计算结果，Device侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）。shape与self相同。支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND，且[数据格式](common/数据格式.md)需要与self一致。 * workspaceSize(uint64_t \*, 出参): 返回需要在Device侧申请的workspace大小。 * executor(aclOpExecutor \*\*, 出参): 返回op执行器，包含了算子计算流程。 - **返回值**： aclnnStatus：返回状态码，具体参见[aclnn返回码](common/aclnn返回码.md)。 ``` 第一段接口完成入参校验，出现以下场景时报错： ACLNN_ERR_PARAM_NULLPTR：1. 传入的gradOutput、self、target、out为空指针。 ACLNN_ERR_PARAM_INVALID：1. gradOutput、self、target、weightOptional的数据类型不在支持的范围内。 2. gradOutput、self、target、weightOptional的数据类型不同。 3. gradOutput、target和weightOptional的shape不能broadcast到self的shape。 4. reduction的值非0,1,2三值之一。 5. gradOutput、self、target、weightOptional的shape维度大于8。 ``` ## aclnnBinaryCrossEntropyBackward - **参数说明：** * workspace(void \*, 入参): 在Device侧申请的workspace内存地址。 * workspaceSize(uint64_t, 入参): 在Device侧申请的workspace大小，由第一段接口aclnnBinaryCrossEntropyBackwardGetWorkspaceSize获取。 * executor(aclOpExecutor \*, 入参): op执行器，包含了算子计算流程。 * stream(aclrtStream, 入参): 指定执行任务的AscendCL Stream流。 - **返回值：** aclnnStatus: 返回状态码，具体参见[aclnn返回码](common/aclnn返回码.md)。 ## 约束与限制无 ## 调用示例示例代码如下，仅供参考，具体编译和执行过程请参考[编译与运行样例](common/编译与运行样例.md)。 ```c++ #include #include #include "acl/acl.h" #include "aclnnop/aclnn_binary_cross_entropy_backward.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::vector& shape) { int64_t shapeSize = 1; for (auto i : shape) { shapeSize *= i; } return shapeSize; } int Init(int32_t deviceId, aclrtStream* stream) { // 固定写法，AscendCL初始化 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; } template int CreateAclTensor(const std::vector& hostData, const std::vector& shape, void** deviceAddr, aclDataType dataType, aclTensor** tensor) { auto size = GetShapeSize(shape) * sizeof(T); // 调用aclrtMalloc申请Device侧内存 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); // 调用aclrtMemcpy将Host侧数据拷贝到Device侧内存上 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); // 计算连续tensor的strides std::vector strides(shape.size(), 1); for (int64_t i = shape.size() - 2; i >= 0; i--) { strides[i] = shape[i + 1] * strides[i + 1]; } // 调用aclCreateTensor接口创建aclTensor *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初始化，参考AscendCL对外接口列表 // 根据自己的实际device填写deviceId int32_t deviceId = 0; aclrtStream stream; auto ret = Init(deviceId, &stream); // check根据自己的需要处理 CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret); // 2. 构造输入与输出，需要根据API的接口自定义构造 std::vector gradOutputShape = {2, 2}; std::vector selfShape = {2, 2}; std::vector targetShape = {2, 2}; std::vector weightShape = {2, 2}; std::vector outShape = {2, 2}; void* gradOutputDeviceAddr = nullptr; void* selfDeviceAddr = nullptr; void* targetDeviceAddr = nullptr; void* weightDeviceAddr = nullptr; void* outDeviceAddr = nullptr; aclTensor* gradOutput = nullptr; aclTensor* self = nullptr; aclTensor* target = nullptr; aclTensor* weight = nullptr; aclTensor* out = nullptr; std::vector gradOutputHostData = {0.1, 0.1, 0.1, 0.1}; std::vector selfHostData = {0.3, 0.3, 0.3, 0.3}; std::vector targetHostData = {0.5, 0.5, 0.5, 0.5}; std::vector weightHostData = {1, 1, 1, 1}; std::vector outHostData = {0, 0, 0, 0}; int64_t reduction = 0; // 创建gradOutputaclTensor ret = CreateAclTensor(gradOutputHostData, gradOutputShape, &gradOutputDeviceAddr, aclDataType::ACL_FLOAT, &gradOutput); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建target aclTensor ret = CreateAclTensor(targetHostData, targetShape, &targetDeviceAddr, aclDataType::ACL_FLOAT, &target); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建weight aclTensor ret = CreateAclTensor(weightHostData, weightShape, &weightDeviceAddr, aclDataType::ACL_FLOAT, &weight); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建out aclTensor ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out); CHECK_RET(ret == ACL_SUCCESS, return ret); uint64_t workspaceSize = 0; aclOpExecutor* executor; // aclnnBinaryCrossEntropyBackward接口调用示例 // 3. 调用CANN算子库API，需要修改为具体的API名称 // 调用aclnnBinaryCrossEntropyBackward第一段接口 ret = aclnnBinaryCrossEntropyBackwardGetWorkspaceSize(gradOutput, self, target, weight, reduction, out, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBinaryCrossEntropyBackwardGetWorkspaceSize 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); } // 调用aclnnBinaryCrossEntropyBackward第二段接口 ret = aclnnBinaryCrossEntropyBackward(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnBinaryCrossEntropyBackward 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侧，需要根据具体API的接口定义修改 auto size = GetShapeSize(outShape); std::vector resultData(size, 0); ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr, size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret); for (int64_t i = 0; i < size; i++) { LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]); } // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改 aclDestroyTensor(gradOutput); aclDestroyTensor(self); aclDestroyTensor(target); aclDestroyTensor(weight); aclDestroyTensor(out); // 7. 释放device资源，需要根据具体API的接口定义修改 aclrtFree(gradOutputDeviceAddr); aclrtFree(selfDeviceAddr); aclrtFree(targetDeviceAddr); aclrtFree(weightDeviceAddr); aclrtFree(outDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```