Star478
267
代码
代码
Issues22
Pull Requests24
流水线
讨论
Wiki
分析
Star478
267
cann-robotcann-robotmodified md files(for readability improvement)
f085306b创建于 3月31日历史提交

aclnnUpsampleNearest2dV2

📄 查看源码

产品支持情况

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

功能说明

  • 接口功能：对由多个输入通道组成的输入信号应用最近邻插值算法进行上采样。如果输入shape为(N, C, H, W)，则输出shape为(N, C, outputSize[0], outputSize[1])。本接口相较于aclnnUpsampleNearest2d，增加入参scalesH、scalesW，请根据实际情况选择合适的接口。

  • 计算公式：

    hsrc=min(floor(hdst∗scalesH),H−1), scalesH=outputSize[0]/self_Hh_{src} = min(floor(h_{dst} * scalesH), H - 1), \ scalesH = outputSize[0] / self\_H

    wsrc=min(floor(wdst∗scalesW),W−1), scalesW=outputSize[1]/self_Ww_{src} = min(floor(w_{dst} * scalesW), W - 1), \ scalesW = outputSize[1] / self\_W

    out(N,C,hdst,wdst)=self(N,C,hsrc,wsrc)out(N, C, h_{dst}, w_{dst}) = self(N, C, h_{src}, w_{src})

函数原型

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

aclnnStatus aclnnUpsampleNearest2dV2GetWorkspaceSize(
  const aclTensor   *self, 
  const aclIntArray *outputSize, 
  float              scalesH, 
  float              scalesW, 
  aclTensor         *out, 
  uint64_t          *workspaceSize, 
  aclOpExecutor    **executor)

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

aclnnUpsampleNearest2dV2GetWorkspaceSize

  • 参数说明

    参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor
    self（aclTensor*） 输入 表示进行上采样的输入数据，对应公式中的`self`。
    • 支持空Tensor。
    • 当数据类型为DOUBLE、UINT8时，self的H轴和W轴均必须小于2^24。
    • 其他数据类型时，self的所有维度取值均小于等于(2^31-1)。
    		 FLOAT32、BFLOAT16、FLOAT16、DOUBLE、UINT8 NCHW、NHWC 4 √
    outputSize（aclIntArray*） 输入 表示指定`out`在H和W维度上的空间大小。
    • 各元素均不等于零。
    • size为2。
    		 INT64 - - -
    scalesH（float） 输入 表示指定空间大小纵轴的乘数，对应公式中的`scalesH`。 - - - - -
    scalesW（float） 输入 表示指定空间大小横轴的乘数，对应公式中的`scalesW`。 - - - - -
    out（aclTensor*） 输出 表示进行上采样的输出结果，对应公式中的`out`。
    • 支持空Tensor。
    • 数据类型和数据格式与入参self保持一致。
    • 当数据类型为FLOAT32、BFLOAT16、FLOAT16时，out的所有维度取值均小于等于(2^31-1)。
    • shape的N轴、C轴与入参self保持一致。
    		 FLOAT32、BFLOAT16、FLOAT16、DOUBLE、UINT8 NCHW、NHWC 4 √
    workspaceSize（uint64_t*） 输出 返回用户需要在Device侧申请的workspace大小。 - - - - -
    executor（aclOpExecutor**） 输出 返回op执行器，包含了算子计算流程。 - - - - -

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

      入参self和出参out的数据类型不支持FLOAT32、BFLOAT16。

  • 返回值

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

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

    返回码 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 如果传入参数是必选输入，输出或者必选属性，且是空指针。
    ACLNN_ERR_PARAM_INVALID 161002 self的数据类型不在支持的范围内或self与out数据类型不同。
    self和out的数据格式不在支持的范围之内。
    self的shape不是4维。
    outputSize中存在值为0的元素。

aclnnUpsampleNearest2dV2

  • 参数说明

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

  • 返回值

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

约束说明

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

    outputSize_H=floor(self_H∗scalesH)outputSize\_H = floor(self\_H * scalesH)

    outputSize_W=floor(self_W∗scalesW)outputSize\_W = floor(self\_W * scalesW)

  • 确定性计算：

    • aclnnUpsampleNearest2dV2默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_upsample_nearest_2d_v2.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_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根据自己的需要处理
    CHECK_RET(ret == 0, 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<int64_t> outputSizeHostData = {8, 4};
    std::vector<float> outHostData(32, 0);
    float scalesH = 0.0;
    float scalesW = 0.0;

    // 创建self aclTensor
    ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建self aclIntArray
    auto outputSizeArray = aclCreateIntArray(outputSizeHostData.data(), 2);
    // 创建out aclTensor
    ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 3. 调用CANN算子库API，需要修改为具体的API
    uint64_t workspaceSize = 0;
    aclOpExecutor *executor;
    // 调用aclnnUpsampleNearest2dV2第一段接口
    ret = aclnnUpsampleNearest2dV2GetWorkspaceSize(
        self, outputSizeArray, scalesH, scalesW, out, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleNearest2dV2GetWorkspaceSize 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;);
    }
    // 调用aclnnUpsampleNearest2dV2第二段接口
    ret = aclnnUpsampleNearest2dV2(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleNearest2dV2 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> resultData(size, 0);
    ret = aclrtMemcpy(resultData.data(),
        resultData.size() * sizeof(resultData[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("result[%ld] is: %f\n", i, resultData[i]);
    }

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

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