首页
产品
解决方案
开发者
合作伙伴
高校
昇腾AI市场
产业资讯
支持与服务
文档HOT
下载
中文
注册
文档首页
我要评分
文档获取效率
文档正确性
内容完整性
文档易理解
提交
在线提单
论坛求助
昇腾小AI

aclnnGroupNormBackward

支持的产品型号

  • Atlas 训练系列产品。
  • Atlas A2训练系列产品/Atlas 800I A2推理产品。

接口原型

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

  • aclnnStatus aclnnGroupNormBackwardGetWorkspaceSize(const aclTensor* gradOut, const aclTensor* input, const aclTensor* mean, const aclTensor* rstd, const aclTensor* gamma, int64_t N, int64_t C, int64_t HxW, int64_t group, const aclBoolArray* outputMask, aclTensor* gradInput, aclTensor* gradGammaOut, aclTensor* gradBetaOut, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnGroupNormBackward(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

aclnnGroupNormBackwardGetWorkspaceSize

  • 参数说明：

    • gradOut(aclTensor*, 计算输入)：反向计算的梯度tensor，Device侧的aclTensor。shape支持0-8维，元素个数需要等于N*C*HxW，数据类型与input相同，数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • input(aclTensor*, 计算输入)：正向计算的首个输入，Device侧的aclTensor。shape支持0-8维，元素个数需要等于N*C*HxW，数据类型与gradOut相同，数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • mean(aclTensor*, 计算输入)：正向计算的第二个输出，表示input分组后每个组的均值，Device侧的aclTensor。shape支持0-8维，元素个数需要等于N*group，数据类型与gradOut相同，数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • rstd(aclTensor*, 计算输入): 正向计算的第三个输出，表示input分组后每个组的标准差倒数，Device侧的aclTensor。shape支持0-8维，元素个数需要等于N*group，数据类型与gradOut相同，数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • gamma(aclTensor*, 计算输入): 表示每个channel的缩放系数，Device侧的aclTensor。shape支持0-8维，元素个数需要等于C，数据类型与gradOut相同，数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • N(int64_t, 计算输入): INT64常量，表示输入gradOut在N维度上的空间大小。

    • C(int64_t, 计算输入): INT64常量，表示输入gradOut在C维度上的空间大小。

    • HxW(int64_t, 计算输入): INT64常量，表示输入gradOut在除N、C维度外的空间大小。

    • group(int64_t, 计算输入): INT64常量，表示将输入gradOut的C维度分为group组，group需大于0，且C必须可以被group整除。

    • outputMask(aclBoolArray*, 计算输入): 数据类型支持BOOL，size大小为3。分别表示是否输出gradInput, gradGammaOut, gradBetaOut，若为true则输出，否则输出对应位置返回空。

    • gradInput(aclTensor*, 计算输出): 输出张量，数据类型与gradOut相同，shape与input相同，Device侧的aclTensor。数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • gradGammaOut(aclTensor*, 计算输出): 输出张量，数据类型与gradOut相同，shape与gamma相同，Device侧的aclTensor。数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • gradBetaOut(aclTensor*, 计算输出): 输出张量，数据类型与gradOut相同，shape与gamma相同，Device侧的aclTensor。数据格式支持ND，支持非连续的Tensor。

      • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、BFLOAT16。

    • workspaceSize(uint64_t*, 出参): 返回用户需要在npu device侧申请的workspace大小。

    • executor(aclOpExecutor**, 出参): 返回op执行器，包含了算子计算流程。

  • 返回值：

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

    第一段接口完成入参校验，出现以下场景时报错：
返回161001（ACLNN_ERR_PARAM_NULLPTR）：  1. 传入的 gradOut、input、mean、rstd是空指针时。
                                        2. 当outputMasked[0]为true, 传入的 gradInput是空指针时。
                                        3. 当outputMasked[1]为true, 传入的 gradGammaOut是空指针时。
                                        4. 当outputMasked[2]为true, 传入的 gradBetaOut是空指针时。
返回161002（ACLNN_ERR_PARAM_INVALID）：  1. gradOut数据类型不在支持的范围之内。
                                        2. input、mean、out、rstd的数据类型与gradOut不同。
                                        3. 当outputMasked[0]为true, gradInput的shape与input的shape不相同。
                                        4. 当outputMasked[1]为true, gradGammaOut的shape与gamma的shape不相同。
                                        5. 当outputMasked[2]为true, gradBetaOut的shape与gamma的shape不相同。
                                        6. group不大于0。
                                        7. C不能被group整除。
                                        8. input的元素个数不等于 N * C * HxW。
                                        9. mean的元素个数不等于 N * group。
                                        10. rstd的元素个数不等于 N * group。
                                        11. gamma不为空指针且gamma的元素数量不为C。

aclnnGroupNormBackward

  • 参数说明：

    • workspace(void*, 入参)：在Device侧申请的workspace内存地址。
    • workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnGroupNormBackwardGetWorkspaceSize获取。
    • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。
    • stream(aclrtStream, 入参)：执行任务的AscendCL Stream流。

  • 返回值：

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

约束与限制

  • Atlas A2训练系列产品/Atlas 800I A2推理产品：在训练场景下C / group 的结果不支持超过 8000

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_group_norm_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 shape_size = 1;
for (auto i : shape) {
  shape_size *= i;
}
return shape_size;
}

int Init(int32_t deviceId, aclrtStream* stream) {
  // 固定写法，acl初始化
  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> gradOutShape = {2, 3, 4};
  std::vector<int64_t> inputShape = {2, 3, 4};
  std::vector<int64_t> meanShape = {2, 1};
  std::vector<int64_t> rstdShape = {2, 1};
  std::vector<int64_t> gammaShape = {3};
  std::vector<int64_t> outShape = {2, 3, 4};
  std::vector<int64_t> gradInputShape = {2, 3, 4};
  std::vector<int64_t> gradGammaOutShape = {3};
  std::vector<int64_t> gradBetaOutShape = {3};
  void* gradOutDeviceAddr = nullptr;
  void* inputDeviceAddr = nullptr;
  void* meanDeviceAddr = nullptr;
  void* rstdDeviceAddr = nullptr;
  void* gammaDeviceAddr = nullptr;
  void* outDeviceAddr = nullptr;
  void* gradInputDeviceAddr = nullptr;
  void* gradGammaOutDeviceAddr = nullptr;
  void* gradBetaOutDeviceAddr = nullptr;
  aclTensor* gradOut = nullptr;
  aclTensor* input = nullptr;
  aclTensor* mean = nullptr;
  aclTensor* rstd = nullptr;
  aclTensor* gamma = nullptr;
  aclTensor* gradInput = nullptr;
  aclTensor* gradGammaOut = nullptr;
  aclTensor* gradBetaOut = nullptr;
  std::vector<float> gradOutHostData = {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> inputHostData = {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> meanHostData = {6.5, 18.5};
  std::vector<float> rstdHostData = {0.2896827, 0.2896827};
  std::vector<float> gammaHostData = {1.0, 1.0, 1.0};
  std::vector<float> gradInputHostData = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0,
                                          0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0};
  std::vector<float> gradGammaOutHostData = {0.0, 0.0, 0.0};
  std::vector<float> gradBetaOutHostData = {0.0, 0.0, 0.0};
  int64_t N = 2;
  int64_t C = 3;
  int64_t HxW = 4;
  int64_t group = 1;
  std::array<bool, 3> outputMaskData = {true, true, true};
  // 创建gradOut aclTensor
  ret = CreateAclTensor(gradOutHostData, gradOutShape, &gradOutDeviceAddr, aclDataType::ACL_FLOAT, &gradOut);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建input aclTensor
  ret = CreateAclTensor(inputHostData, inputShape, &inputDeviceAddr, aclDataType::ACL_FLOAT, &input);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建mean aclTensor
  ret = CreateAclTensor(meanHostData, meanShape, &meanDeviceAddr, aclDataType::ACL_FLOAT, &mean);
  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);
  // 创建gamma aclTensor
  ret = CreateAclTensor(gammaHostData, gammaShape, &gammaDeviceAddr, aclDataType::ACL_FLOAT, &gamma);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  auto outputMask = aclCreateBoolArray(outputMaskData.data(), outputMaskData.size());
  CHECK_RET(outputMask != nullptr, return ACL_ERROR_INTERNAL_ERROR);
  // 创建gradInput aclTensor
  ret = CreateAclTensor(gradInputHostData, gradInputShape, &gradInputDeviceAddr, aclDataType::ACL_FLOAT, &gradInput);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建gradGammaOut aclTensor
  ret = CreateAclTensor(gradGammaOutHostData, gradGammaOutShape, &gradGammaOutDeviceAddr, aclDataType::ACL_FLOAT, &gradGammaOut);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建gradBetaOut aclTensor
  ret = CreateAclTensor(gradBetaOutHostData, gradBetaOutShape, &gradBetaOutDeviceAddr, aclDataType::ACL_FLOAT, &gradBetaOut);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  // 3. 调用CANN算子库API，需要修改为具体的HostApi
  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;
  // 调用aclnnGroupNormBackward第一段接口
  ret = aclnnGroupNormBackwardGetWorkspaceSize(gradOut, input, mean, rstd, gamma, N, C, HxW, group, outputMask, gradInput, gradGammaOut, gradBetaOut, &workspaceSize, &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGroupNormBackwardGetWorkspaceSize 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;);
  }
  // 调用aclnnGroupNormBackward第二段接口
  ret = aclnnGroupNormBackward(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGroupNormBackward 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> gradInputResultData(size, 0);
  ret = aclrtMemcpy(gradInputResultData.data(), gradInputResultData.size() * sizeof(gradInputResultData[0]), gradInputDeviceAddr, 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("gradInputResultData[%ld] is: %f\n", i, gradInputResultData[i]);
  }

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

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

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(gradOut);
  aclDestroyTensor(input);
  aclDestroyTensor(mean);
  aclDestroyTensor(rstd);
  aclDestroyTensor(gamma);
  aclDestroyTensor(gradInput);
  aclDestroyTensor(gradGammaOut);
  aclDestroyTensor(gradBetaOut);

  // 7. 释放device资源，需要根据具体API的接口定义修改
  aclrtFree(gradOutDeviceAddr);
  aclrtFree(inputDeviceAddr);
  aclrtFree(meanDeviceAddr);
  aclrtFree(rstdDeviceAddr);
  aclrtFree(gammaDeviceAddr);
  aclrtFree(gradInputDeviceAddr);
  aclrtFree(gradGammaOutDeviceAddr);
  aclrtFree(gradBetaOutDeviceAddr);

  if (workspaceSize > 0) {
    aclrtFree(workspaceAddr);
  }
  aclrtDestroyStream(stream);
  aclrtResetDevice(deviceId);
  aclFinalize();
  return 0;
}
搜索结果
找到“0”个结果

当前产品无相关内容

未找到相关内容，请尝试其他搜索词