cann-robotmodified md files(for readability improvement)

aclnnUpsampleNearest3d

产品支持情况

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

功能说明

接口功能：对由多个输入通道组成的输入信号应用最近邻插值算法进行上采样。如果输入shape为(N, C, D, H, W)，则输出shape为(N, C, outputSize[0], outputSize[1], outputSize[2])。
计算公式：
- 核心算法逻辑：
  1. 将目标图像的每一个点映射回原图，得到一个带小数点的坐标。
  2. 根据这个浮点数坐标，计算距离最近的原始图像的点，后者的值直接复制给前者。
- 具体计算逻辑：
  $d_{src} = min(floor(d_{dst} / scalesD), self\_D - 1), \ scalesD = outputSize[0] / self\_D$ $h_{src} = min(floor(h_{dst} / scalesH), self\_H - 1), \ scalesH = outputSize[1] / self\_H$ $w_{src} = min(floor(w_{dst} / scalesW), self\_W - 1), \ scalesW = outputSize[2] / self\_W$ $out(N, C, d_{dst},h_{dst}, w_{dst}) = self(N, C, d_{src},h_{src}, w_{src})$

函数原型

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

aclnnStatus aclnnUpsampleNearest3dGetWorkspaceSize(
  const aclTensor   *self, 
  const aclIntArray *outputSize, 
  double             scalesD, 
  double             scalesH, 
  double             scalesW, 
  aclTensor         *out, 
  uint64_t          *workspaceSize, 
  aclOpExecutor    **executor)

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

aclnnUpsampleNearest3dGetWorkspaceSize

参数说明

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
self（aclTensor*）	输入	表示进行上采样的输入张量。对应公式中的`self`。	不支持空Tensor。当数据格式为ND时，默认按照NCDHW格式处理。 self的所有维度取值均小于等于(2^31-1)。 shape的C、D、H、W维的size大于0。	FLOAT32、FLOAT16、BFLOAT16、DOUBLE、UINT8	NCDHW、NDHWC、ND	5	√
outputSize（aclIntArray*）	输入	指定输出out在D、H、W维度上的空间大小。对应公式中的`outputSize`。	size为3，各元素取值均大于零。	INT64	-	-	-
scalesD（double）	输入	指定输出out的depth维度乘数，对应公式中的`scalesD`。	-	-	-	-	-
scalesH（double）	输入	指定输出out的height维度乘数，对应公式中的`scalesH`。	-	-	-	-	-
scalesW（double）	输入	指定输出out的width维度乘数，对应公式中的`scalesW`。	-	-	-	-	-
out（aclTensor*）	输出	表示采样后的输出张量，对应公式中`out`的点p坐标。	不支持空Tensor。数据类型和数据格式需与入参self的数据类型和数据格式保持一致。输入和输出shape的N、C轴必须相同。 out的所有维度取值均小于等于(2^31-1)。	FLOAT32、FLOAT16、BFLOAT16、DOUBLE、UINT8	NCDHW、NDHWC、ND	5	√
workspaceSize（uint64_t*）	输出	返回用户需要在Device侧申请的workspace大小。	-	-	-	-	-
executor（aclOpExecutor**）	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

Atlas 推理系列产品：

入参self和出参out的数据类型不支持BFLOAT16、DOUBLE、UINT8。
Atlas 训练系列产品：

入参self和出参out的数据类型不支持BFLOAT16、UINT8。
Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品：

入参self和出参out的数据类型不支持UINT8。

返回值

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

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

返回码	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	如果传入参数是必选输入，输出或者必选属性，且是空指针。
ACLNN_ERR_PARAM_INVALID	161002	self的数据类型不在支持的范围之内或self与out数据类型不同。
		self的shape不是5维。
		outputSize的size不等于3。
		self在C、D、H、W维度上的size不大于0。
		outputSize的某个元素值不大于0。
		out的shape中D、H、W不等于outputSize。

aclnnUpsampleNearest3d

参数说明

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

返回值

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

约束说明

参数self、outputSize、scalesD、scalesH、scalesW需要满足如下约束：
$outputSize\_D = floor(self\_D * scalesD)$ $outputSize\_H = floor(self\_H * scalesH)$ $outputSize\_W = floor(self\_W * scalesW)$
确定性计算：
- aclnnUpsampleNearest3d默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_upsample_nearest_3d.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_NCDHW, 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 = {2, 2, 2, 2, 3};
    std::vector<int64_t> outShape = {2, 2, 1, 1, 1};
    void* selfDeviceAddr = nullptr;
    void* outDeviceAddr = nullptr;
    aclTensor* self = nullptr;
    aclTensor* out = nullptr;
    std::vector<float> selfHostData = {1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11, 12, 13, 14, 15, 16,
                                       17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32,
                                       33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48};
    std::vector<float> outHostData = {1, 2, 3, 4};
    std::vector<int64_t> outputSizeData = {1, 1, 1};
    double scalesD = 0.0;
    double scalesH = 0.0;
    double scalesW = 0.0;
    // 创建self aclTensor
    ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建out aclTensor
    ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    const aclIntArray* outputSize = aclCreateIntArray(outputSizeData.data(), outputSizeData.size());
    CHECK_RET(outputSize != nullptr, return ACL_ERROR_INTERNAL_ERROR);

    // 3. 调用CANN算子库API，需要修改为具体的API
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    // 调用aclnnUpsampleNearest3d第一段接口
    ret = aclnnUpsampleNearest3dGetWorkspaceSize(
        self, outputSize, scalesD, scalesH, scalesW, out, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleNearest3dGetWorkspaceSize 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;);
    }
    // 调用aclnnUpsampleNearest3d第二段接口
    ret = aclnnUpsampleNearest3d(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnUpsampleNearest3d 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和aclScalar，需要根据具体API的接口定义修改
    aclDestroyTensor(self);
    aclDestroyTensor(out);

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