aclnnRmsNorm
支持的产品型号
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
- Atlas 推理系列产品。
接口原型
每个算子分为两段式接口，必须先调用aclnnRmsNormGetWorkspaceSize接口获取入参并根据计算流程所需workspace大小，再调用aclnnRmsNorm接口执行计算。
aclnnStatus aclnnRmsNormGetWorkspaceSize(const aclTensor *x, const aclTensor *gamma, double epsilon, const aclTensor *yOut, const aclTensor *rstdOut, uint64_t *workspaceSize, aclOpExecutor **executor)aclnnStatus aclnnRmsNorm( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
功能描述
- 算子功能：RmsNorm算子是大模型常用的归一化操作，相比LayerNorm算子，其去掉了减去均值的部分 。
- 计算公式：
aclnnRmsNormGetWorkspaceSize
参数说明：
- x(aclTensor*，计算输入)： shape支持1-8维度，数据格式支持ND。
- Atlas 推理系列产品：数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- gamma(aclTensor*，计算输入)： shape支持1-8维度，数据格式支持ND。shape需要满足gamma_shape = x_shape[n:], n < x_shape.dims()。
- Atlas 推理系列产品：数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- epsilon(double，计算输入)： 公式中的输入eps，用于防止除0错误，数据类型为double，默认值为1e-6。
- yOut(aclTensor*，计算输出)： shape支持1-8维度，数据格式支持ND。shape与x保持一致。
- Atlas 推理系列产品：数据类型支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
- rstdOut(aclTensor*，计算输出)： 数据类型支持FLOAT32、shape支持1-8维度，数据格式支持ND。shape与x前几维保持一致。
- workspaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。
- x(aclTensor*，计算输入)： shape支持1-8维度，数据格式支持ND。
返回值：
aclnnStatus：返回状态码。（参见aclnn返回码）
说明： 第一段接口完成入参校验，出现以下场景时报错：
- 161001 (ACLNN_ERR_PARAM_NULLPTR)：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。
aclnnRmsNorm
参数说明：
- workspace(void*, 入参)：在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnRmsNormGetWorkspaceSize获取。
- executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。
- stream(aclrtStream, 入参)：指定执行任务的AscendCL stream流。
返回值：
aclnnStatus：返回状态码。（具体参见aclnn返回码）
约束与限制
- 功能维度
- 数据类型支持
- Atlas 推理系列产品：x、gamma支持FLOAT32、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：x、gamma支持FLOAT32、FLOAT16、BFLOAT16。
- rstd支持：FLOAT。
- 数据格式支持：ND。
- Atlas 推理系列产品上，x、gamma输入的尾轴长度必须大于等于 32 Bytes。
- 数据类型支持
- 未支持类型说明
- DOUBLE：指令不支持DOUBLE。
- 是否支持空tensor：不支持空进空出。
- 是否非连续tensor：不支持输入非连续，不支持数据非连续。
- 边界值场景说明
- 当输入是inf时，输出为inf。
- 当输入是nan时，输出为nan。
- 各平台支持数据类型说明
- Atlas A2训练系列产品/Atlas 800I A2推理产品
x 数据类型 gamma 数据类型 y 数据类型 rstd 数据类型 float16 float32 float16 float32 bfloat16 float32 bfloat16 float32 float16 float16 float16 float32 bfloat16 bfloat16 bfloat16 float32 float32 float32 float32 float32 - Atlas 推理系列产品
x 数据类型 gamma 数据类型 y 数据类型 rstd 数据类型 float16 float16 float16 float32 float32 float32 float32 float32
- Atlas A2训练系列产品/Atlas 800I A2推理产品
调用示例
示例编译和执行请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_rms_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 shape_size = 1;
for (auto i : shape) {
shape_size *= i;
}
return shape_size;
}
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初始化, 参考acl对外接口列表
// 根据自己的实际device填写deviceId
int32_t deviceId = 0;
aclrtStream stream;
auto ret = Init(deviceId, &stream);
// check根据自己的需要处理
CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. 构造输入与输出，需要根据API的接口自定义构造
std::vector<int64_t> xShape = {2, 16};
std::vector<int64_t> gammaShape = {16};
std::vector<int64_t> yShape = {2, 16};
std::vector<int64_t> rstdShape = {2, 1};
void* xDeviceAddr = nullptr;
void* gammaDeviceAddr = nullptr;
void* yDeviceAddr = nullptr;
void* rstdDeviceAddr = nullptr;
aclTensor* x = nullptr;
aclTensor* gamma = nullptr;
aclTensor* y = nullptr;
aclTensor* rstd = nullptr;
std::vector<float> xHostData = {0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7};
std::vector<float> gammaHostData = {0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7};
std::vector<float> yHostData = {0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7, 0, 1, 2, 3, 4, 5, 6, 7};
std::vector<float> rstdHostData = {1, 2};
float epsilon = 1e-6;
// 创建x aclTensor
ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT, &x);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建gamma aclTensor
ret = CreateAclTensor(gammaHostData, gammaShape, &gammaDeviceAddr, aclDataType::ACL_FLOAT, &gamma);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建y aclTensor
ret = CreateAclTensor(yHostData, yShape, &yDeviceAddr, aclDataType::ACL_FLOAT, &y);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建rstd aclTensor
ret = CreateAclTensor(rstdHostData, rstdShape, &rstdDeviceAddr, aclDataType::ACL_FLOAT, &rstd);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API，需要修改为具体的API
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnRmsNorm第一段接口
ret = aclnnRmsNormGetWorkspaceSize(x, gamma, epsilon, y, rstd, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRmsNormGetWorkspaceSize 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;);
}
// 调用aclnnRmsNorm第二段接口
ret = aclnnRmsNorm(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRmsNorm 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(yShape);
std::vector<float> resultData(size, 0);
ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), yDeviceAddr, size * sizeof(float),
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(x);
aclDestroyTensor(gamma);
aclDestroyTensor(y);
aclDestroyTensor(rstd);
// 7. 释放device资源，需要根据具体API的接口定义修改
aclrtFree(xDeviceAddr);
aclrtFree(gammaDeviceAddr);
aclrtFree(yDeviceAddr);
aclrtFree(rstdDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}