Star784
1574
代码
代码
Issues178
Pull Requests262
Actions
讨论
Wiki
分析
Star784
1574
cann-robotcann-robotmodified md files(for readability improvement)
ec40a927创建于 3月31日历史提交

aclnnGroupNorm

📄 查看源码

产品支持情况

产品 是否支持
Ascend 950PR/Ascend 950DT √
Atlas A3 训练系列产品/Atlas A3 推理系列产品 √
Atlas A2 训练系列产品/Atlas A2 推理系列产品 √
Atlas 200I/500 A2 推理产品 ×
Atlas 推理系列产品 √
Atlas 训练系列产品 √

功能说明

  • 接口功能：计算输入self的组归一化结果out，均值meanOut，标准差的倒数rstdOut。

  • 计算公式：

    记 x=selfx=self，E[x]=xˉE[x] = \bar{x}代表xx的均值，Var[x]=1n−1∗∑i=1n(xi−E[x])2Var[x] = \frac{1}{n - 1} * \sum_{i=1}^n(x_i - E[x])^2代表xx的样本方差，则

    out=x−E[x]Var[x]+eps∗γ+βout = \frac{x - E[x]}{\sqrt{Var[x] + eps}} * \gamma + \beta

    meanOut=E[x]meanOut = E[x]

    rstdOut=1Var[x]+epsrstdOut = \frac{1}{\sqrt{Var[x] + eps}}

函数原型

每个算子分为两段式接口，必须先调用aclnnGroupNormGetWorkspaceSize接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用aclnnGroupNorm接口执行计算。

aclnnStatus aclnnGroupNormGetWorkspaceSize(
  const aclTensor *self,
  const aclTensor *gamma,
  const aclTensor *beta,
  int64_t          N,
  int64_t          C,
  int64_t          HxW,
  int64_t          group,
  double           eps,
  aclTensor       *out,
  aclTensor       *meanOut,
  aclTensor       *rstdOut,
  uint64_t        *workspaceSize,
  aclOpExecutor  **executor)

aclnnStatus aclnnGroupNorm(
  void          *workspace,
  uint64_t       workspaceSize,
  aclOpExecutor *executor,
  aclrtStream    stream)

aclnnGroupNormGetWorkspaceSize

  • 参数说明

    参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor
    self（aclTensor*） 输入 表示进行归一化计算的输入，对应公式中的`x`。
    • 支持空Tensor。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 2-8 √
    gamma（aclTensor*） 输入 表示进行归一化计算的缩放因子（权重），对应公式中的`γ`。
    • 支持空Tensor。
    • 数据类型与self相同。
    • 元素数量需与C相同。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 1 √
    beta（aclTensor*） 输入 表示进行归一化计算的偏移量，对应公式中的`β`。
    • 支持空Tensor。
    • 数据类型与self相同。
    • 元素数量需与C相同。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 1 √
    N（int64_t） 输入 表示输入self在N维度上的空间大小。 - - - - -
    C（int64_t） 输入 表示输入self在C维度上的空间大小。 - - - - -
    HxW（int64_t） 输入 表示输入self在除N、C维度外的空间大小。
    • 若无其他维度则为1。
    		 - - - -
    group（int64_t） 输入 表示将输入self的C维度分为group组。
    • group需大于0。
    		 - - - -
    eps（double） 输入 out和rstdOut计算公式中的`eps`值，为数值稳定性而加到分母上的值。
    • 需大于0，若保持精度，则eps需大于等于1e-5。
    		 - - - -
    out（aclTensor*） 输出 表示进行归一化计算的结果，对应公式中的`out`。
    • 支持空Tensor。
    • 数据类型和shape与self相同。
    • 数据格式和self相同。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 2-8 √
    meanOut（aclTensor*） 输出 表示进行归一化后的均值，对应公式中的`meanOut`。
    • 支持空Tensor。
    • 数据类型与self相同。
    • shape为(N, group)。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 2 √
    rstdOut（aclTensor*） 输出 表示进行归一化后标准差的倒数，对应公式中的`rstdOut`。
    • 支持空Tensor。
    • 数据类型与self相同。
    • shape为(N, group)。
    		 FLOAT32、FLOAT16、BFLOAT16 ND 2 √
    workspaceSize（uint64_t*） 输出 返回用户需要在Device侧申请的workspace大小。 - - - - -
    executor（aclOpExecutor**） 输出 返回op执行器，包含了算子计算流程。 - - - - -

    • Atlas 训练系列产品、Atlas 推理系列产品：

      参数self、gamma、beta、out、meanOut、rstdOut的数据类型不支持BFLOAT16。

  • 返回值

    aclnnStatus: 返回状态码，具体参见aclnn返回码。

    第一段接口完成入参校验，出现以下场景时报错：

    返回码 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 如果传入参数是必选输入，输出或者必选属性，且是空指针。
    ACLNN_ERR_PARAM_INVALID 161002 self、gamma、beta、out、meanOut、rstdOut数据类型不在支持的范围之内。
    gamma、beta、out、meanOut、rstdOut的数据类型与self不同。
    self的维度小于2维，或者大于8维。
    group不大于0。
    C不能被group整除。
    eps不大于0。
    out的shape与x不同。
    meanOut与rstdOut的shape不为(N, group)。
    self在N维度上的空间大小不等于N。
    self在C维度上的空间大小不等于C。
    self第三维度及之后维度的size乘积不等于HxW(self为二维时，HxW需要为1)。
    self的元素数量不等于N*C*HxW。
    gamma不为1维且元素数量不等于C。
    beta不为1维且元素数量不等于C。
    self和out的格式不同时。

aclnnGroupNorm

  • 参数说明

    参数名 输入/输出 描述
    workspace 输入 在Device侧申请的workspace内存地址。
    workspaceSize 输入 在Device侧申请的workspace大小，由第一段接口aclnnGroupNormGetWorkspaceSize获取。
    executor 输入 op执行器，包含了算子计算流程。
    stream 输入 指定执行任务的Stream。

  • 返回值

    aclnnStatus：返回状态码，具体参见aclnn返回码。

约束说明

  • 确定性计算：
    • aclnnGroupNorm默认确定性实现。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_group_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)
{
    // 固定写法，资源初始化
    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 API手册
    // 根据自己的实际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> selfShape = {2, 3, 4};
    std::vector<int64_t> gammaShape = {3};
    std::vector<int64_t> betaShape = {3};
    std::vector<int64_t> outShape = {2, 3, 4};
    std::vector<int64_t> meanOutShape = {2, 1};
    std::vector<int64_t> rstdOutShape = {2, 1};
    void* selfDeviceAddr = nullptr;
    void* gammaDeviceAddr = nullptr;
    void* betaDeviceAddr = nullptr;
    void* outDeviceAddr = nullptr;
    void* meanOutDeviceAddr = nullptr;
    void* rstdOutDeviceAddr = nullptr;
    aclTensor* self = nullptr;
    aclTensor* gamma = nullptr;
    aclTensor* beta = nullptr;
    aclTensor* out = nullptr;
    aclTensor* meanOut = nullptr;
    aclTensor* rstdOut = nullptr;
    std::vector<float> selfHostData = {1.0,  2.0,  3.0,  4.0,  5.0,  6.0,  7.0,  8.0,  9.0,  10.0, 11.0, 12.0,
                                       13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0, 23.0, 24.0};
    std::vector<float> gammaHostData = {2.0, 2, 2};
    std::vector<float> betaHostData = {2.0, 2, 2};
    std::vector<float> outHostData = {1.0,  2.0,  3.0,  4.0,  5.0,  6.0,  7.0,  8.0,  9.0,  10.0, 11.0, 12.0,
                                      13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0, 20.0, 21.0, 22.0, 23.0, 24.0};
    std::vector<float> meanOutHostData = {2.0, 2};
    std::vector<float> rstdOutHostData = {2.0, 2};
    int64_t N = 2;
    int64_t C = 3;
    int64_t HxW = 4;
    int64_t group = 1;
    double eps = 1e-5;
    // 创建self aclTensor
    ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
    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);
    // 创建beta aclTensor
    ret = CreateAclTensor(betaHostData, betaShape, &betaDeviceAddr, aclDataType::ACL_FLOAT, &beta);
    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);
    // 创建meanOut aclTensor
    ret = CreateAclTensor(meanOutHostData, meanOutShape, &meanOutDeviceAddr, aclDataType::ACL_FLOAT, &meanOut);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建rstdOut aclTensor
    ret = CreateAclTensor(rstdOutHostData, rstdOutShape, &rstdOutDeviceAddr, aclDataType::ACL_FLOAT, &rstdOut);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3. 调用CANN算子库API，需要修改为具体的API
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    // 调用aclnnGroupNorm第一段接口
    ret = aclnnGroupNormGetWorkspaceSize(
        self, gamma, beta, N, C, HxW, group, eps, out, meanOut, rstdOut, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGroupNormGetWorkspaceSize 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;);
    }
    // 调用aclnnGroupNorm第二段接口
    ret = aclnnGroupNorm(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGroupNorm 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<float> outResultData(size, 0);
    ret = aclrtMemcpy(
        outResultData.data(), outResultData.size() * sizeof(outResultData[0]), outDeviceAddr, 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("outResultData[%ld] is: %f\n", i, outResultData[i]);
    }

    size = GetShapeSize(meanOutShape);
    std::vector<float> meanResultData(size, 0);
    ret = aclrtMemcpy(
        meanResultData.data(), meanResultData.size() * sizeof(meanResultData[0]), meanOutDeviceAddr,
        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("meanResultData[%ld] is: %f\n", i, meanResultData[i]);
    }

    size = GetShapeSize(rstdOutShape);
    std::vector<float> rstdResultData(size, 0);
    ret = aclrtMemcpy(
        rstdResultData.data(), rstdResultData.size() * sizeof(rstdResultData[0]), rstdOutDeviceAddr,
        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("rstdResultData[%ld] is: %f\n", i, rstdResultData[i]);
    }

    // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
    aclDestroyTensor(self);
    aclDestroyTensor(gamma);
    aclDestroyTensor(beta);
    aclDestroyTensor(out);
    aclDestroyTensor(meanOut);
    aclDestroyTensor(rstdOut);

    // 7. 释放device资源，需要根据具体API的接口定义修改
    aclrtFree(selfDeviceAddr);
    aclrtFree(gammaDeviceAddr);
    aclrtFree(betaDeviceAddr);
    aclrtFree(outDeviceAddr);
    aclrtFree(meanOutDeviceAddr);
    aclrtFree(rstdOutDeviceAddr);

    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}