aclnnSwishBackward
支持的产品型号
Atlas 推理系列产品 。Atlas 训练系列产品 。Atlas A2 训练系列产品/Atlas 800I A2 推理产品 。
接口原型
每个算子分为两段式接口，必须先调用“aclnnSwishBackwardGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnSwishBackward”接口执行计算。
aclnnStatus aclnnSwishBackwardGetWorkspaceSize(const aclTensor* gradOutput, const aclTensor* self, const aclScalar* betaOptional, aclTensor* gradInput, uint64_t* workspaceSize, aclOpExecutor** executor)aclnnStatus aclnnSwishBackward(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
算子功能：aclnnSwishBackward是aclnnSwish激活函数的反向传播，用于计算Swish激活函数的梯度。
计算公式：
- Swish函数公式
- Swish函数公式的导数实现
gradInput = gradOutput * s^\prime(x) $$
其中为sigmoid函数，为swish函数，为swish函数的导数。
aclnnSwishBackwardGetWorkspaceSize
参数说明：
- gradOutput（aclTensor*，计算输入）：表示Swish激活函数正向输出的梯度，公式中的，Device侧的aclTensor。数据格式支持ND，gradOutput、self与gradInput的shape一致，gradOutput、self与gradInput的数据类型一致。支持非连续的Tensor。
Atlas 推理系列产品 、Atlas 训练系列产品 ：数据类型支持FLOAT16、FLOAT。Atlas A2 训练系列产品/Atlas 800I A2 推理产品 ：数据类型支持BFLOAT16、FLOAT16、FLOAT。
- self（aclTensor*，计算输入）：表示用于计算激活函数的张量，公式中的，Device侧的aclTensor。数据格式支持ND，gradOutput、self与gradInput的shape一致，gradOutput、self与gradInput的数据类型一致。支持非连续的Tensor。
Atlas 推理系列产品 、Atlas 训练系列产品 ：数据类型支持FLOAT16、FLOAT。Atlas A2 训练系列产品/Atlas 800I A2 推理产品 ：数据类型支持BFLOAT16、FLOAT16、FLOAT。
- betaOptional（aclScalar*，计算输入）：表示可调节参数，用于控制Swish函数的形状和斜率的标量，公式中的，Host侧的aclScalar。数据类型需要是可转换为FLOAT的数据类型（参见互转换关系）。当betaOptional为空指针时，接口以1.0进行计算。
- gradInput（aclTensor*，计算输出）：backward计算的输出，为Swish正向输入的梯度值，即对输入进行求导后的结果，公式中的，Device侧的aclTensor。数据格式支持ND，gradOutput、self与gradInput的shape一致，gradOutput、self与gradInput的数据类型一致。支持非连续的Tensor。
Atlas 推理系列产品 、Atlas 训练系列产品 ：数据类型支持FLOAT16、FLOAT。Atlas A2 训练系列产品/Atlas 800I A2 推理产品 ：数据类型支持BFLOAT16、FLOAT16、FLOAT。
- workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
- executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。
- gradOutput（aclTensor*，计算输入）：表示Swish激活函数正向输出的梯度，公式中的，Device侧的aclTensor。数据格式支持ND，gradOutput、self与gradInput的shape一致，gradOutput、self与gradInput的数据类型一致。支持非连续的Tensor。
返回值：
aclnnStatus：返回状态码，具体参见aclnn返回码。
第一段接口完成入参校验，出现以下场景时报错： 返回161001（ACLNN_ERR_PARAM_NULLPTR）：1. 传入的gradOutput、self或gradInput是空指针。 返回161002（ACLNN_ERR_PARAM_INVALID）：1. gradOutput、self、betaOptional或gradInput的数据类型不在支持的范围之内。 2. gradOutput、self和gradInput的数据类型不同。 3. gradOutput、self和gradInput的shape不同。
aclnnSwishBackward
参数说明：
- workspace（void*，入参）：在Device侧申请的workspace内存地址。
- workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnSwishBackwardGetWorkspaceSize获取。
- executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
- stream（aclrtStream，入参）：指定执行任务的AscendCL Stream流。
返回值：
aclnnStatus：返回状态码，具体参见aclnn返回码。
约束与限制
无
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_swish_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<int64_t>& 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 <typename T>
int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& 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<int64_t> 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_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. 构造输入与输出，需要根据API的接口自定义构造
std::vector<int64_t> gradOutputShape = {2, 3};
std::vector<int64_t> selfShape = {2, 3};
std::vector<int64_t> gradInputShape = {2, 3};
void* gradOutDeviceAddr = nullptr;
void* selfDeviceAddr = nullptr;
void* gradInputDeviceAddr = nullptr;
aclTensor* gradOut = nullptr;
aclTensor* self = nullptr;
aclScalar* betaOptional = nullptr;
aclTensor* gradInput = nullptr;
std::vector<float> gradOutHostData = {1, 1, 1, 1, 1, 1};
std::vector<float> selfHostData = {1, 2, 3, 4, 5, 6};
std::vector<float> gradInputHostData = {0, 0, 0, 0, 0, 0};
float betaValue = 1.1f;
// 创建gradOut aclTensor
ret = CreateAclTensor(gradOutHostData, gradOutputShape, &gradOutDeviceAddr, aclDataType::ACL_FLOAT, &gradOut);
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);
// 创建betaOptional aclScalar
betaOptional = aclCreateScalar(&betaValue, aclDataType::ACL_FLOAT);
CHECK_RET(betaOptional != nullptr, return ret);
// 创建gradInput aclTensor
ret = CreateAclTensor(gradInputHostData, gradInputShape, &gradInputDeviceAddr, aclDataType::ACL_FLOAT, &gradInput);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API，需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnSwishBackward第一段接口
ret = aclnnSwishBackwardGetWorkspaceSize(gradOut, self, betaOptional, gradInput, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnSwishBackwardGetWorkspaceSize 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);
}
// 调用aclnnSwishBackward第二段接口
ret = aclnnSwishBackward(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnSwishBackward 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(gradInputShape);
std::vector<float> outData(size, 0);
ret = aclrtMemcpy(outData.data(), outData.size() * sizeof(outData[0]), gradInputDeviceAddr,
size * sizeof(outData[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("out result[%ld] is: %f\n", i, outData[i]);
}
// 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
aclDestroyTensor(gradOut);
aclDestroyTensor(self);
aclDestroyScalar(betaOptional);
aclDestroyTensor(gradInput);
// 7. 释放device资源，需要根据具体API的接口定义修改
aclrtFree(gradOutDeviceAddr);
aclrtFree(selfDeviceAddr);
aclrtFree(gradInputDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}