aclnnUpsampleBilinear2d

📄 查看源码

产品支持情况

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

功能说明

• 接口功能：对由多个输入通道组成的输入信号应用2D双线性上采样。

  • 对于输入shape：如果输入shape为(N, C, H, W)，则输出shape为(N, C, outputSize[0], outputSize[1])。
  • 对于中心对齐的选择：一般像素被视为网格。当alignCorners = True时，像素被视为网格左上角的点，输出拐角处的像素与原图像的拐角像素中心对齐，同方向点之间是等间距的；当alignCorners = False时，像素被视为网格的交叉线上的点，输出拐角处的像素依然是原图像的拐角像素，但同方向点之间是不等距的。

• 计算公式：

  • 核心算法逻辑：

    1. 将目标图像的每一个点映射回原图，得到一个带小数点的坐标。
    2. 根据这个浮点数坐标，计算前后相邻的原始图像的点。
    3. 分别计算相邻点到对应目标点的权重，按照权重相乘累加即可得到目标点值。

  • 具体计算逻辑： 缩放方式分为角对齐和边对齐，角对齐（alignCorners为true）表示按照原始图片左上角像素中心点对齐，边对齐（alignCorners为true）表示按照原始图片左上角顶点及两条边对齐，在计算缩放系数和坐标位置时存在差异。对于一个二维插值点$(N,C,H,W)$，则有以下公式：

    $$scaleH=\{\begin{array}{ll}(self.dim[2]-1)/(outputSize[0]-1)& alignCorners=true\\ 1/scalesH& alignCorners=false\&scalesH>0\\ self.dim[2]/outputSize[0]& alignCorners=false\end{array}$$

    $$scaleW=\{\begin{array}{ll}(self.dim[3]-1)/(outputSize[1]-1)& alignCorners=true\\ 1/scalesW& alignCorners=false\&scalesW>0\\ self.dim[3]/outputSize[1]& alignCorners=false\end{array}$$

    因此，对于output的某个方向上的点p(x,y)，映射回原始图像中的点记为q(x',y')，则有关系：

    $$x^{\prime }=\{\begin{array}{ll}x\ast scaleH& alignCorners=true\\ MAX(0,(x+0.5)\ast scaleH-0.5)& alignCorners=false\end{array}$$

    $$y^{\prime }=\{\begin{array}{ll}y\ast scaleW& alignCorners=true\\ MAX(0,(y+0.5)\ast scaleW-0.5)& alignCorners=false\end{array}$$

    • 记：

      $$x_0=int(x^{\prime }),x_1=int(x^{\prime })+1,lambd{a}_0=x_1-x^{\prime },lambd{a}_1=1-lambd{a}_0$$

      $$y_0=int(y^{\prime }),y_1=int(y^{\prime })+1,lambd{b}_0=y_1-y^{\prime },lambd{b}_1=1-lambd{b}_0$$

    • 则有以下公式：

      $$\begin{gathered} V(p_{x,y})=V(p_{x0,y0})\ast lambd{a}_0\ast lambd{b}_0 \\ +V(p_{x0,y1})\ast lambd{a}_0\ast lambd{b}_1 \\ +V(p_{x1,y0})\ast lambd{a}_1\ast lambd{b}_0 \\ +V(p_{x1,y1})\ast lambd{a}_1\ast lambd{b}_1 \end{gathered}$$

函数原型

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

aclnnStatus aclnnUpsampleBilinear2dGetWorkspaceSize(
  const aclTensor   *self,
  const aclIntArray *outputSize,
  const bool         alignCorners,
  const double       scalesH,
  const double       scalesW,
  aclTensor         *out,
  uint64_t          *workspaceSize,
  aclOpExecutor    **executor)

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

aclnnUpsampleBilinear2dGetWorkspaceSize

• 参数说明

  参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
  self（aclTensor*）	输入	表示进行上采样的输入张量，对应公式中的`self`。	不支持空Tensor。 当数据类型为DOUBLE时，仅支持NHWC格式。	FLOAT32、BFLOAT16、FLOAT16、DOUBLE	NCHW、NHWC	4	√
  outputSize（aclIntArray*）	输入	指定输出空间大小，表示指定`out`在H和W维度上的空间大小。对应公式中的`outputSize`。	size为2，且各元素均大于零。	INT64	-	-	-
  alignCorners（bool）	输入	决定是否对齐角像素点，对应公式中的`alignCorners`。	如果设置为True，则输入和输出张量按其角像素的中心点对齐，保留角像素处的值；如果设置为False，则输入和输出张量通过其角像素的角点对齐，并使用边缘值对边界外的值进行填充。	-	-	-	-
  scalesH（double）	输入	指定空间大小的height维度乘数，对应公式中的`scalesH`。	不能传入负值。	-	-	-	-
  scalesW（double）	输入	指定空间大小的width维度乘数，对应公式中的`scalesW`。	不能传入负值。	-	-	-	-
  out（aclTensor*）	输出	表示采样后的输出张量，对应公式中的`out`。	不支持空Tensor。 数据类型和数据格式与入参`self`的数据类型和数据格式保持一致。 当数据类型为DOUBLE时，仅支持NHWC格式。 shape仅支持4维，且N轴和C轴与输入self shape的N轴和C轴保持一致。	FLOAT32、BFLOAT16、FLOAT16、DOUBLE	NCHW、NHWC	4	√
  workspaceSize（uint64_t*）	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
  executor（aclOpExecutor**）	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

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

    参数self、out的数据类型不支持BFLOAT16。

• 返回值

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

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

  返回码	错误码	描述
  ACLNN_ERR_PARAM_NULLPTR	161001	API内部校验错误，通常由于输入数据或属性的规格不在支持的范围之内导致。
  ACLNN_ERR_PARAM_INVALID	161002	self的数据类型不在支持的范围之内。
  		self和out的N/C轴的维度大小不相等。
  		self和out的数据格式不在支持的范围之内。
  		scalesH或scalesW的值为负值。

aclnnUpsampleBilinear2d

• 参数说明

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

• 返回值

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

约束说明

• 参数self、outputSize、scalesH、scalesW需要满足如下约束：

  $$outputSize\_H=floor(self\_H\ast scalesH)$$

  $$outputSize\_W=floor(self\_W\ast scalesW)$$

• 确定性计算：

  • aclnnUpsampleBilinear2d默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_upsample_bilinear_2d.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)
{
    // 固定写法，资源初始化
    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 CreateAclNchTensor(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_NCHW,
        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_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
    // 2. 构造输入与输出，需要根据API的接口自定义构造
    std::vector<int64_t> selfShape = {1, 1, 4, 2};
    std::vector<int64_t> outShape = {1, 1, 8, 4};
    void *selfDeviceAddr = nullptr;
    void *outDeviceAddr = nullptr;
    aclTensor *self = nullptr;
    aclTensor *out = nullptr;
    std::vector<float> selfHostData = {0, 1, 2, 3, 4, 5, 6, 7};
    std::vector<float> outHostData(32, 0);
    std::vector<int64_t> outputSize = {8, 4};
    bool alignCorners = true;
    double scalesH = 2.0;
    double scalesW = 2.0;
    // 创建self aclTensor
    ret = CreateAclNchTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建self aclIntArray
    auto outputSizeArray = aclCreateIntArray(outputSize.data(), 2);
    // 创建out aclTensor
    ret = CreateAclNchTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3. 调用CANN算子库API，需要修改为具体的API名称
    uint64_t workspaceSize = 0;
    aclOpExecutor *executor;
    // 调用aclnnUpsampleBilinear2d第一段接口
    ret = aclnnUpsampleBilinear2dGetWorkspaceSize(
        self, outputSizeArray, alignCorners, scalesH, scalesW, out, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleBilinear2dGetWorkspaceSize 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);
    }
    // 调用aclnnUpsampleBilinear2d第二段接口
    ret = aclnnUpsampleBilinear2d(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleBilinear2d 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侧
    auto size = GetShapeSize(outShape);
    std::vector<float> resultData(size, 0);
    ret = aclrtMemcpy(resultData.data(),
        resultData.size() * sizeof(resultData[0]),
        outDeviceAddr,
        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);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
    }

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

    // 7. 释放device资源，需要根据具体API的接口定义修改
    aclrtFree(selfDeviceAddr);
    aclrtFree(outDeviceAddr);
    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();

    return 0;
}