--- title: aclnnLogSumExp description: "[? 查看源码](https://gitcode.com/cann/ops-math/tree/master/math/reduce_log_sum_exp)" url: https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/API/aolapi/context/ops-math/aclnnLogSumExp.md sourcePath: /source/zh/CANNCommunityEdition/920beta1/API/aolapi/context/ops-math/aclnnLogSumExp.md indexId: 96d22f96d5d01246afef1d1d70317ffce438c9675f86106980465015ffba579a86 --- # aclnnLogSumExp [? 查看源码](https://gitcode.com/cann/ops-math/tree/master/math/reduce_log_sum_exp) ## 产品支持情况 - Ascend 950PR/Ascend 950DT：支持 - Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持 - Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持 - Atlas 200I/500 A2 推理产品：不支持 - Atlas 推理系列产品：支持 - Atlas 训练系列产品：支持 ## 功能说明 - 接口功能：返回输入tensor指定维度上的指数之和的对数。 - 计算公式： 公式中i为dim指定的维度，j为输入在指定维度上的元素索引。 $$ logsumexp(x)_i = log\sum_{j} exp(x_{ij} ) $$ - 示例 ```text 例1： self: [2, 3, 4] # self_shape=[2, 3, 4]; dim: [2] # 指定维度dim_shape=[2], dim_data = {1, 2}; keepDim: false out: [2] # out_shape=[2]; 例2： self: [2, 3, 4] # self_shape=[2, 3, 4]; dim: [2] # 指定维度dim_shape=[2], dim_data = {1, 2}; keepDim: true out: [2, 1, 1] # out_shape=[2, 1, 1]; ``` ## 函数原型 每个算子分为两段式接口，必须先调用“aclnnLogSumExpGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnLogSumExp”接口执行计算。 ```Cpp aclnnStatus aclnnLogSumExpGetWorkspaceSize( const aclTensor* self, const aclIntArray* dim, bool keepDim, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor) ``` ```Cpp aclnnStatus aclnnLogSumExp( void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream) ``` ## aclnnLogSumExpGetWorkspaceSize - **参数说明：** | 参数名 | 输入/输出 | 描述 | 使用说明 | 数据类型 | 数据格式 | 维度(shape) | 非连续Tensor | | --- | --- | --- | --- | --- | --- | --- | --- | | self（aclTensor*） | 输入 | 公式中的x。 | 数据类型需要可转换成out的数据类型（参见互转换关系）。 | FLOAT、FLOAT16、BFLOAT16、INT32、INT64、INT16、INT8、UINT8、BOOL | ND | 0-8 | √ | | dim（aclIntArray*） | 输入 | 参与计算的维度，公式中的i。 | 取值范围为[-self.dim(), self.dim()-1] | INT64 | - | - | - | | keepDim | 输入 | 决定reduce轴的维度是否保留。 | - | BOOL | - | - | - | | out（aclTensor*） | 输出 | 公式中的logsumexp(x)。 | 若keepDim为true，除dim指定维度上的size为1以外，其余维度的shape需要与self保持一致；若keepDim为false，reduce轴的维度不保留，其余维度shape需要与self一致。 数据类型需要可转换成self的数据类型（参见互转换关系）。 | FLOAT、FLOAT16、BFLOAT16 | ND | 0-8 | √ | | workspaceSize（uint64_t*） | 输出 | 返回需要在Device侧申请的workspace大小。 | - | - | - | - | - | | executor（aclOpExecutor**） | 输出 | 返回op执行器，包含了算子计算流程。 | - | - | - | - | - | - Atlas 推理系列产品、Atlas 训练系列产品：不支持BFLOAT16数据类型。 - **返回值：** aclnnStatus：返回状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现以下场景时报错： | 返回值 | 错误码 | 描述 | | --- | --- | --- | | ACLNN_ERR_PARAM_NULLPTR | 161001 | 传入的self、out和dim是空指针。 | | ACLNN_ERR_PARAM_INVALID | 161002 | self、out和dim的数据类型不在支持的范围内。 | | dim数组中的维度超出输入Tensor的维度范围。 | - | - | | dim数组中元素重复。 | - | - | | self或out维度超过8维。 | - | - | | self的数据类型不能转换为out的数据类型。 | - | - | | out的shape不等于由self，dim，keepDim推导得到的shape。 | - | - | ## aclnnLogSumExp - **参数说明：** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | workspace | 输入 | 在Device侧申请的workspace内存地址。 | | workspaceSize | 输入 | 在Device侧申请的workspace大小，由第一段接口aclnnLogSumExpGetWorkspaceSize获取。 | | executor | 输入 | op执行器，包含了算子计算流程。 | | stream | 输入 | 指定执行任务的Stream。 | - **返回值：** - aclnnStatus：返回状态码，具体参见aclnn返回码 ## 约束说明 - 确定性计算： - aclnnLogSumExp默认确定性实现。 ## 调用示例 示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。 ```Cpp #include #include #include "acl/acl.h" #include "aclnnop/aclnn_logsumexp.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 shape_size = 1; for (auto i : shape) { shape_size *= i; } return shape_size; } 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; } 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; } template int CreateAclIntArray(const std::vector& hostData, aclIntArray** intArray) { auto size = GetShapeSize(hostData) * sizeof(T); // 调用aclCreateIntArray接口创建aclIntArray *intArray = aclCreateIntArray(hostData.data(), hostData.size()); return 0; } int main() { // 1.（固定写法）device/stream初始化，参考acl API手册 // 根据自己的实际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的接口自定义构造 std::vector selfShape = {2, 2, 2}; std::vector outShape = {2}; void* selfDeviceAddr = nullptr; void* outDeviceAddr = nullptr; aclTensor* self = nullptr; aclIntArray* dim = nullptr; aclTensor* out = nullptr; std::vector selfHostData = {2, 3, 5, 8, 4, 12, 6, 7}; std::vector outHostData = {2, 3}; std::vector dimData = {1, 2}; bool keepdim = false; // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建dim aclIntArray ret = CreateAclIntArray(dimData, &dim); 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); // 3.调用CANN算子库API uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnLogSumExp第一段接口 ret = aclnnLogSumExpGetWorkspaceSize(self, dim, keepdim, out, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnLogSumExpGetWorkspaceSize 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;); } // 调用aclnnLogSumExp第二段接口 ret = aclnnLogSumExp(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnLogSumExp 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侧 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 resultData 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 aclDestroyTensor(self); aclDestroyIntArray(dim); aclDestroyTensor(out); // 7.释放device资源，需要根据具体API的接口定义修改 aclrtFree(selfDeviceAddr); aclrtFree(outDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```