aclnnDeepNorm
支持的产品型号
- Atlas 推理系列产品(Ascend 310P处理器)。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
每个算子分为两段式接口,必须先调用“aclnnDeepNormGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnDeepNorm”接口执行计算。
aclnnStatus aclnnDeepNormGetWorkspaceSize(const aclTensor *x, const aclTensor *gx, const aclTensor *beta, const aclTensor *gamma, double alphaOptional, double epsilonOptional, const aclTensor *meanOut, const aclTensor *rstdOut, const aclTensor *yOut, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnDeepNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
功能描述
- 算子功能:实现DeepNorm算子功能。
- 计算公式:
aclnnDeepNormGetWorkspaceSize
参数说明:
- x(aclTensor*,计算输入):Device侧的aclTensor, 公式中的输入x,shape支持2-8维度,数据格式支持ND。
- Atlas 推理系列产品(Ascend 310P处理器):数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- gx (aclTensor*,计算输入):Device侧的aclTensor, 公式中的输入gx,shape支持2-8维度, shape维度和输入x的维度相同,数据格式支持ND。
- Atlas 推理系列产品(Ascend 310P处理器):数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- beta (aclTensor*,计算输入):Device侧的aclTensor, 公式中的输入beta,shape支持1-7维度,shape维度和输入x后几维的维度相同,数据格式支持ND。
- Atlas 推理系列产品(Ascend 310P处理器):数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- gamma(aclTensor*,计算输入):Device侧的aclTensor, 公式中的输入gamma,shape支持1-7维度,shape维度和输入x后几维的维度相同,数据格式支持ND。
- Atlas 推理系列产品(Ascend 310P处理器):数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- alphaOptional(double,计算输入):Host侧的double,公式中的输入alpha,是输入x的权重。
- epsilonOptional(double,计算输入):Host侧的double,公式中的输入eps,用于防止除0错误。
- meanOut(aclTensor*,计算输出):Device侧的aclTensor, 公式中的输出mean,数据类型支持FLOAT32、shape支持2-8维度,shape与输入x满足broadcast关系(前几维的维度和输入x前几维的维度相同),其余维度大小为1,数据格式支持ND。
- rstdOut(aclTensor*,计算输出):Device侧的aclTensor, 公式中的输出rstd,数据类型支持FLOAT32、shape支持2-8维度, shape与输入x满足broadcast关系(前几维的维度和输入x前几维的维度相同),其余维度大小为1,数据格式支持ND。
- yOut(aclTensor*,计算输出):Device侧的aclTensor, 公式中的输出y,shape支持2-8维度, shape维度和输入x的维度相同,数据格式支持ND。
- Atlas 推理系列产品(Ascend 310P处理器):数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- workspaceSize(uint64_t*,出参):返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**,出参):返回op执行器,包含了算子计算流程。
返回值
返回aclnnStatus状态码,具体参见aclnn返回码。
aclnnDeepNorm
参数说明:
- workspace(void*,入参):在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t,入参):在Device侧申请的workspace大小,由第一段接口aclnnDeepNormGetWorkspaceSize获取。
- executor(aclOpExecutor*,入参):op执行器,包含了算子计算流程。
- stream(aclrtStream,入参):指定执行任务的AscendCL stream流。
返回值:
返回aclnnStatus状态码,具体参见aclnn返回码。
约束与限制
功能维度:
数据类型支持:
- Atlas 推理系列产品(Ascend 310P处理器):x、gx、beta、gamma、y支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:x、gx、beta、gamma、y支持FLOAT32、FLOAT16、BFLOAT16。
- rstd、mean支持:FLOAT32。
数据格式支持:ND
未支持类型说明:
- DOUBLE:指令不支持DOUBLE。
- 是否支持空tensor:不支持空进空出。
- 是否非连续tensor:不支持输入非连续,不支持数据非连续。
边界值场景说明:
- 当输入是inf时,输出为inf。
- 当输入是nan时,输出为nan。
调用示例
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_deep_norm.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根据自己的需要处理
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. 构造输入与输出,需要根据API的接口自定义构造
float alpha = 0.3;
float eps = 1e-6;
std::vector<int64_t> xShape = {3, 1, 4};
std::vector<int64_t> gxShape = {3, 1, 4};
std::vector<int64_t> betaShape = {4};
std::vector<int64_t> gammaShape = {4};
std::vector<int64_t> outputMeanShape = {3, 1, 1};
std::vector<int64_t> outputRstdShape = {3, 1, 1};
std::vector<int64_t> outputYShape = {3, 1, 4};
void *xDeviceAddr = nullptr;
void *gxDeviceAddr = nullptr;
void *betaDeviceAddr = nullptr;
void *gammaDeviceAddr = nullptr;
void *outputMeanDeviceAddr = nullptr;
void *outputRstdDeviceAddr = nullptr;
void *outputYDeviceAddr = nullptr;
aclTensor *x = nullptr;
aclTensor *gx = nullptr;
aclTensor *beta = nullptr;
aclTensor *gamma = nullptr;
aclTensor *outputMean = nullptr;
aclTensor *outputRstd = nullptr;
aclTensor *outputY = nullptr;
std::vector<float> xHostData = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12};
std::vector<float> gxHostData = {2, 2, 2, 4, 4, 4, 6, 6, 6, 8, 8, 8};
std::vector<float> betaHostData = {0, 1, 2, 3};
std::vector<float> gammaHostData = {0, 1, 2, 3};
std::vector<float> outputMeanHostData = {0, 1, 2};
std::vector<float> outputRstdHostData = {0, 1, 2};
std::vector<float> outputYHostData = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12};
// 创建self aclTensor
ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT, &x);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(gxHostData, gxShape, &gxDeviceAddr, aclDataType::ACL_FLOAT, &gx);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(betaHostData, betaShape, & betaDeviceAddr, aclDataType::ACL_FLOAT, & beta);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(gammaHostData, gammaShape, &gammaDeviceAddr, aclDataType::ACL_FLOAT, &gamma);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(outputMeanHostData, outputMeanShape, &outputMeanDeviceAddr, aclDataType::ACL_FLOAT, &outputMean);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(outputRstdHostData, outputRstdShape, &outputRstdDeviceAddr, aclDataType::ACL_FLOAT, &outputRstd);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(outputYHostData, outputYShape, &outputYDeviceAddr, aclDataType::ACL_FLOAT, &outputY);
CHECK_RET(ret == ACL_SUCCESS, return ret);
uint64_t workspaceSize = 0;
aclOpExecutor *executor;
// aclnnDeepNorm接口调用示例
// 3. 调用CANN算子库API,需要修改为具体的Api名称
// 调用aclnnDeepNorm第一段接口
LOG_PRINT("\nUse aclnnDeepNorm Port.");
ret = aclnnDeepNormGetWorkspaceSize(x, gx, beta, gamma, alpha, eps,
outputMean, outputRstd, outputY,
&workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDeepNormGetWorkspaceSize 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;);
}
// 调用aclnnDeepNorm第二段接口
ret = aclnnDeepNorm(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDeepNorm 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 outputMeanSize = GetShapeSize(outputMeanShape);
std::vector<float> resultDataMean(outputMeanSize, 0);
ret = aclrtMemcpy(resultDataMean.data(), resultDataMean.size() * sizeof(resultDataMean[0]), outputMeanDeviceAddr,
outputMeanSize * sizeof(resultDataMean[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);
LOG_PRINT("== pdx output");
for (int64_t i = 0; i < outputMeanSize; i++) {
LOG_PRINT("result[%ld] is: %f\n", i, resultDataMean[i]);
}
auto outputRstdSize = GetShapeSize(outputRstdShape);
std::vector<float> resultDataRstd(outputRstdSize, 0);
ret = aclrtMemcpy(resultDataRstd.data(), resultDataRstd.size() * sizeof(resultDataRstd[0]), outputRstdDeviceAddr,
outputRstdSize * sizeof(resultDataRstd[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);
LOG_PRINT("== pdx output");
for (int64_t i = 0; i < outputRstdSize; i++) {
LOG_PRINT("result[%ld] is: %f\n", i, resultDataRstd[i]);
}
auto outputYSize = GetShapeSize(outputYShape);
std::vector<float> resultDataY(outputYSize, 0);
ret = aclrtMemcpy(resultDataY.data(), resultDataY.size() * sizeof(resultDataY[0]), outputYDeviceAddr,
outputYSize * sizeof(resultDataY[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);
LOG_PRINT("== pdx output");
for (int64_t i = 0; i < outputYSize; i++) {
LOG_PRINT("result[%ld] is: %f\n", i, resultDataY[i]);
}
// 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
aclDestroyTensor(x);
aclDestroyTensor(gx);
aclDestroyTensor(beta);
aclDestroyTensor(gamma);
aclDestroyTensor(outputMean);
aclDestroyTensor(outputRstd);
aclDestroyTensor(outputY);
// 7. 释放device资源,需要根据具体API的接口定义修改
aclrtFree(xDeviceAddr);
aclrtFree(gxDeviceAddr);
aclrtFree(gammaDeviceAddr);
aclrtFree(outputMeanDeviceAddr);
aclrtFree(outputRstdDeviceAddr);
aclrtFree(outputYDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}