aclnnInstanceNorm

支持的产品型号

Atlas 推理系列产品

接口原型

每个算子分为两段式接口，必须先调用aclnnInstanceNormGetWorkspaceSize接口获取入参并根据计算流程所需workspace大小，再调用aclnnInstanceNorm接口执行计算。

aclnnStatus aclnnInstanceNormGetWorkspaceSize(const aclTensor *x, const aclTensor *gamma, const aclTensor *beta, const char *dataFormat, double eps, aclTensor *y, aclTensor *mean, aclTensor *variance, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnInstanceNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能：计算InstanceNorm功能。
计算公式：

y = {{x-E(x)}\over\sqrt {Var(x)+e}} * \gamma + \beta

aclnnInstanceNormGetWorkspaceSize

参数说明：
- x（aclTensor *，计算输入）：公式中的x。Device 侧的aclTensor，tensor维度为4维。数据类型支持FLOAT、FLOAT16。支持非连续的Tensor，数据格式支持ND，实际数据格式由参数 dataFormat 决定。
- gamma（aclTensor *，计算输入）：公式中的gamma。Device 侧的aclTensor，tensor维度为1维, 且 shape 和输入 x 的C轴一致。数据类型支持FLOAT、FLOAT16，和输入 x 保持一致。支持非连续的Tensor，数据格式支持ND。
- beta（aclTensor *，计算输入）：公式中的beta。Device 侧的aclTensor，tensor维度为1维, 且 shape 和输入 x 的C轴一致。数据类型支持FLOAT、FLOAT16，和输入 x 保持一致。支持非连续的Tensor，数据格式支持ND。
- dataFormat（char *，计算输入）：算子输入Tensor的实际数据排布，可以是"NHCW"或"NCHW"。
- eps（double *，计算输入）：对应InstanceNorm 计算公式中的 epsilon，添加到分母中的值，以确保数值稳定。
- y（aclTensor *，计算输出）：表示 InstanceNorm 的结果输出y。Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16，且数据类型与x一致。 shape需要与 x一致，数据格式支持ND。
- mean（aclTensor *，计算输出）：公式中E(x)的计算结果。tensor维度为4维，shape 为 x 输入的N，C轴保持不变，HW轴reduce为1。数据类型支持FLOAT、FLOAT16，且和输入 x 保持一致。数据格式支持ND。
- variance（aclTensor *，计算输出）：公式中Var(x)的计算结果。tensor维度为4维，shape 为 x 输入的N，C轴保持不变，HW轴reduce为1。数据类型支持FLOAT、FLOAT16，且和输入 x 保持一致。数据格式支持ND。
- workspaceSize（uint64_t *，出参）：返回用户需要在Device 侧申请的workspace大小。
- executor（aclOpExecutor **，出参）：返回op执行器，包含了算子计算流程。

返回值：

aclnnStatus：返回状态码。（参见aclnn返回码）

第一段接口完成入参校验，出现以下场景时报错：
161001 (ACLNN_ERR_PARAM_NULLPTR)：1. 传入的 x, gamma, beta, y, mean, variance 是空指针。
161002 (ACLNN_ERR_PARAM_INVALID)：1. 传入的 x, gamma, beta, y, mean, variance 的数据类型不在支持范围内。
                                  2. x的维度不为 4 或 gamma/beta的维度非 1。
                                  3. gamma，beta的 shape 和 x 的 C 轴不一致。
                                  4. 产品非Atlas 推理系列产品。
                                  5. dataFormat 没有设置为 'NCHW' 或 'NHWC'。
561103 (ACLNN_ERR_INNER_NULLPTR): 1. aclnn 接口中间计算结果出现 nullptr。
                                  2. C轴 或 H*W 长度小于32B
561101 (ACLNN_ERR_INNER_CREATE_EXECUTOR): 1.  API内部创建aclOpExecutor失败。

aclnnInstanceNorm

参数说明：
- workspace（void *，入参）：在Device侧申请的workspace内存地址。
- workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnInstanceNormGetWorkspaceSize获取。
- executor（aclOpExecutor *，入参）：op执行器，包含了算子计算流程。
- stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。
返回值：

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

约束与限制

功能维度
- 数据类型支持
  - x, gamma, beta, y, mean, variance 支持：FLOAT32、FLOAT16。
- 数据格式支持：ND。
- x，y的shape要求4维，gamma/beta的维度要求1维，且和x，y的C轴一致。
- x，y的 H*W 大小需要大于 32Bytes， C轴需要大于 32Bytes
- 参数 dataFormat 仅支持 "NHWC" 和 "NCHW"
边界值场景说明
- 当输入是inf时，输出为inf。
- 当输入是nan时，输出为nan。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_instance_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);

  int64_t N = 1;
  int64_t C = 8;
  int64_t H = 4;
  int64_t W = 4;

  // 2. 构造输入与输出，需要根据API的接口自定义构造，本示例中将各调用一次不带bias可选输入的和带bias输入的用例
  std::vector<int64_t> xShape = {N, C, H, W};
  std::vector<int64_t> weightShape = {C};
  std::vector<int64_t> yShape = {N, C, H, W};
  std::vector<int64_t> reduceShape = {N, C, 1, 1};

  void *xDeviceAddr = nullptr;
  void *gammaDeviceAddr = nullptr;
  void *betaDeviceAddr = nullptr;
  void *yDeviceAddr = nullptr;
  void *meanDeviceAddr = nullptr;
  void *varianceDeviceAddr = nullptr;

  aclTensor *x = nullptr;
  aclTensor *gamma = nullptr;
  aclTensor *beta = nullptr;
  aclTensor *y = nullptr;
  aclTensor *mean = nullptr;
  aclTensor *variance = nullptr;

  std::vector<float> xHostData(N * C * H * W, 0.77);
  std::vector<float> gammaHostData(C, 1.5);
  std::vector<float> betaHostData(C, 0.5);
  std::vector<float> yHostData(N * C * H * W, 0.0);
  std::vector<float> meanHostData(N * C, 0.0);
  std::vector<float> varianceHostData(N * C, 0.0);
  const char* dataFormat = "NCHW";
  double eps = 1e-5;

  // 创建self aclTensor
  ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT, &x);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(gammaHostData, weightShape, &gammaDeviceAddr, aclDataType::ACL_FLOAT, &gamma);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(betaHostData,  weightShape, &betaDeviceAddr, aclDataType::ACL_FLOAT, &beta);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(yHostData, yShape, &yDeviceAddr, aclDataType::ACL_FLOAT, &y);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(meanHostData, reduceShape, &meanDeviceAddr, aclDataType::ACL_FLOAT, &mean);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(varianceHostData,  reduceShape, &varianceDeviceAddr, aclDataType::ACL_FLOAT, &variance);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  // aclnnInstanceNorm接口调用示例
  // 调用aclnnInstanceNorm第一段接口
  uint64_t workspaceSize = 0;
  aclOpExecutor *executor;
  LOG_PRINT("\nUse aclnnInstanceNorm Non-Bias Port.");
  ret = aclnnInstanceNormGetWorkspaceSize(x, gamma, beta, dataFormat, eps, y, mean, variance, &workspaceSize, &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInstanceNormGetWorkspaceSize 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;);
  }

  // 调用aclnnInstanceNorm第二段接口
  ret = aclnnInstanceNorm(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInstanceNorm 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的接口定义修改

  // 5.1 考出不带bias的输出
  auto size = GetShapeSize(yShape);
  std::vector<float> resultData(size, 0);
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), yDeviceAddr,
                    size * sizeof(resultData[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("==== InstanceNorm non-bias: y output");
  for (int64_t i = 0; i < size; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
  }

  auto outputMeanSize = GetShapeSize(reduceShape);
  std::vector<float> resultDataMean(outputMeanSize, 0);
  ret = aclrtMemcpy(resultDataMean.data(), resultDataMean.size() * sizeof(resultDataMean[0]), meanDeviceAddr,
                    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("==== InstanceNorm non-bias: mean output");
  for (int64_t i = 0; i < outputMeanSize; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultDataMean[i]);
  }

  auto outputVarSize = GetShapeSize(reduceShape);
  std::vector<float> resultDataVar(outputVarSize, 0);
  ret = aclrtMemcpy(resultDataVar.data(), resultDataVar.size() * sizeof(resultDataVar[0]), varianceDeviceAddr,
                    outputVarSize * sizeof(resultDataVar[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("==== InstanceNorm non-bias: rstd output");
  for (int64_t i = 0; i < outputVarSize; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultDataVar[i]);
  }

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(x);
  aclDestroyTensor(gamma);
  aclDestroyTensor(beta);
  aclDestroyTensor(y);
  aclDestroyTensor(mean);
  aclDestroyTensor(variance);

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

  aclrtFree(yDeviceAddr);
  aclrtFree(meanDeviceAddr);
  aclrtFree(varianceDeviceAddr);

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