Star478
259
代码
代码
Issues16
Pull Requests18
流水线
讨论
Wiki
分析
Star478
259
cann-robotcann-robotmodified md files(for readability improvement)
0b529e6a创建于 20 小时前历史提交

aclnnCIoU

📄 查看源码

产品支持情况

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

功能说明

  • 接口功能：用于边界框回归的损失函数，在IoU的基础上同时考虑了中心点距离、宽高比和重叠面积，以更全面地衡量预测框与真实框之间的差异。
  • 计算公式：

CIoU=IoU−ρ2(bp,bg)c2−αvv=4π2(arctan(wghg)−arctan(wphp))2α=v1−IoU+vCIoU = IoU - \frac{\rho^2(b^p, b^g)}{c^2} - \alpha v \\ v = \frac{4}{\pi^2}(arctan(\frac{w^g}{h^g}) - arctan(\frac{w^p}{h^p}))^2 \\ \alpha = \frac{v}{1 - IoU + v} \\

函数原型

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

aclnnStatus aclnnCIoUGetWorkspaceSize(
  const aclTensor   *bBoxes,
  const aclTensor   *gtBoxes,
  bool               trans,
  bool               isCross,
  const char        *mode,
  aclTensor         *overlap,
  aclTensor         *atanSub,
  uint64_t          *workspaceSize,
  aclOpExecutor     **executor);

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

aclnnCIoUGetWorkspaceSize

  • 参数说明

    参数名 输入/输出 描述 使用说明 数据类型 格式类型 维度（shape） 非连续Tensor
    bBoxes 输入 预测矩形框。 形状为[4, M]的二维Tensor。 FLOAT、FLOAT16 ND 2 √
    gtBoxes 输入 真值矩形框。 形状为[4, N]的二维Tensor。 FLOAT、FLOAT16 ND 2 √
    trans 输入 用于指定矩形框的格式。 true：指定输入的格式为[x, y, w, h]。
    false：指定输入的格式为[x0, y0, x1, y1]。    		 BOOL - - -
    isCross 输入 用于指定bBoxes与gtBoxes之间是否进行交叉运算。 true：输出的shape为[M, N]。
    false：输出的shape为[1, N]。    		 BOOL - - -
    mode 输入 用于选择计算方式"iou"或"iof"。 - CHAR* ND - -
    overlap 输出 根据两个输入计算得到的交并比或前景交叉比。 - FLOAT、FLOAT16 ND 2 √
    atanSub 输出 计算过程中两个arctan的差值。 - FLOAT、FLOAT16 ND 2 √
    workspaceSize 输出 返回需要在Device侧申请的workspace大小。 - - - - -
    executor 输出 返回op执行器，包含了算子计算流程。 - - - - -

  • 返回值

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

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

    返回值 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 bBoxes、gtBoxes、overlap或atanSub是空指针。
    ACLNN_ERR_PARAM_INVALID 161002 bBoxes、gtBoxes、overlap、atanSub不是二维。
    bBoxes、gtBoxes、overlap、atanSub的数据类型不一致。
    bBoxes、gtBoxes、overlap、atanSub的数据类型和数据格式不在支持的范围内。
    bBoxes或gtBoxes的第一维不是4。
    bBoxes或gtBoxes的第二维不是1024的倍数。
    overlap或atanSub的第一维不是1。
    bBoxes、gtBoxes、overlap、atanSub的第二维不相等。
    isCross不是false。
    mode不是"iou"或"iof"。

aclnnCIoU

  • 参数说明

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

  • 返回值

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

约束说明

  • 确定性计算：
    • aclnnCIoU默认确定性实现。
  • 若输入格式为[x0, y0, x1, y1]，(x0, y0)和(x1, y1)分别表示矩形框的左上角和右下角，需满足x1 > x0, y1 > y0。
  • M和N需要一致。
  • isCross目前仅支持false。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_ciou.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初始化，参考AscendCL对外接口列表
  // 根据自己的实际device填写deviceId
  int32_t deviceId = 0;
  aclrtStream stream;
  auto ret = Init(deviceId, &stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret);
            return ret);

  // 2. 构造输入与输出，需要根据API的接口自定义构造
  // input
  std::vector<float> bBoxesHostData(4096, 1);
  std::vector<float> gtBoxesHostData(4096, 2);
  std::vector<float> overlapHostData(1024, 0);
  std::vector<float> atanSubHostData(1024, 0);
  std::vector<int64_t> bBoxesShape = {4, 1024};
  std::vector<int64_t> gtBoxesShape = {4, 1024};
  std::vector<int64_t> overlapShape = {1, 1024};
  std::vector<int64_t> atanSubShape = {1, 1024};
  void* bBoxesDeviceAddr = nullptr;
  void* gtBoxesDeviceAddr = nullptr;
  void* overlapDeviceAddr = nullptr;
  void* atanSubDeviceAddr = nullptr;
  aclTensor* bBoxes = nullptr;
  aclTensor* gtBoxes = nullptr;
  aclTensor* overlap = nullptr;
  aclTensor* atanSub = nullptr;

  ret = CreateAclTensor(bBoxesHostData, bBoxesShape, &bBoxesDeviceAddr, aclDataType::ACL_FLOAT, &bBoxes);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(gtBoxesHostData, gtBoxesShape, &gtBoxesDeviceAddr, aclDataType::ACL_FLOAT, &gtBoxes);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(overlapHostData, overlapShape, &overlapDeviceAddr, aclDataType::ACL_FLOAT, &overlap);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  ret = CreateAclTensor(atanSubHostData, atanSubShape, &atanSubDeviceAddr, aclDataType::ACL_FLOAT, &atanSub);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  // attr
  bool trans = false;
  bool isCross = false;
  const char* mode = "iou";

  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;

  // 3. 调用CANN算子库API，需要修改为具体的Api名称
  ret = aclnnCIoUGetWorkspaceSize(bBoxes, gtBoxes, trans, isCross, mode, overlap, atanSub, &workspaceSize, &executor);
  CHECK_RET(
      ret == ACL_SUCCESS,
      LOG_PRINT("aclnnCIoUGetWorkspaceSize 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);
  }

  // aclnnCIoU
  ret = aclnnCIoU(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS,
            LOG_PRINT("aclnnCIoU 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 overlapSize = GetShapeSize(overlapShape);
  std::vector<float> overlapData(overlapSize, 0);
  ret = aclrtMemcpy(overlapData.data(), overlapData.size() * sizeof(overlapData[0]), overlapDeviceAddr,
                    overlapSize * sizeof(overlapData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS,
            LOG_PRINT("copy overlapData from device to host failed. ERROR: %d\n", ret);
            return ret);
  for (int64_t i = 0; i < overlapSize; i++) {
    LOG_PRINT("overlap[%ld] is: %f\n", i, overlapData[i]);
  }

  auto atanSubsize = GetShapeSize(atanSubShape);
  std::vector<float> atanSubData(atanSubsize, 0);
  ret = aclrtMemcpy(atanSubData.data(), atanSubData.size() * sizeof(atanSubData[0]), atanSubDeviceAddr,
                    atanSubsize * sizeof(atanSubData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS,
            LOG_PRINT("copy atanSubData from device to host failed. ERROR: %d\n", ret);
            return ret);
  for (int64_t i = 0; i < atanSubsize; i++) {
    LOG_PRINT("atanSub[%ld] is: %f\n", i, atanSubData[i]);
  }

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(bBoxes);
  aclDestroyTensor(gtBoxes);
  aclDestroyTensor(overlap);
  aclDestroyTensor(atanSub);

  // 7. 释放device资源
  aclrtFree(bBoxesDeviceAddr);
  aclrtFree(gtBoxesDeviceAddr);
  aclrtFree(overlapDeviceAddr);
  aclrtFree(atanSubDeviceAddr);

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

  return 0;
}