aclnnGridSampler3D

📄 查看源码

产品支持情况

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

功能说明

• 接口功能：提供一个输入张量input，以及一个对应的grid网格，根据grid中每个位置提供的坐标信息，将input中对应位置的像素值填充到grid指定的位置，得到最终的输出。

• 计算公式：

  输入input、grid网格、输出output的尺寸如下：

  $$\begin{gathered} input:(N,C,D_{in},H_{in},W_{in}) \\ grid:(N,D_{out},H_{out},W_{out},3) \\ output:(N,C,D_{out},H_{out},W_{out}) \end{gathered}$$

  其中input、grid、output中的N是一致的，input和output中的C是一致的，grid和output中的$D_{out}$、$H_{out}$、$W_{out}$是一致的，grid最后一维大小为3，表示input像素位置信息为(x, y, z)，会将x、y、z的取值范围归一化到[-1, 1]之间。

  • 反归一化的计算公式：

    • alignCorners=true，表示特征值位于像素中心。

      $$x^{\prime }=(grid\_x+1)/2\ast (D_{in}-1)$$

      $$y^{\prime }=(grid\_y+1)/2\ast (H_{in}-1)$$

      $$z^{\prime }=(grid\_z+1)/2\ast (W_{in}-1)$$

    • alignCorners=false，表示特征值位于像素的角点。

      $$x^{\prime }=((grid\_x+1)\ast D_{in}-1)/2$$

      $$y^{\prime }=((grid\_y+1)\ast H_{in}-1)/2$$

      $$z^{\prime }=((grid\_z+1)\ast W_{in}-1)/2$$

  • 对于超出范围的坐标，会根据paddingMode进行不同处理：

    • paddingMode=0，表示对越界位置用0填充。
    • paddingMode=1，表示对越界位置用边界值填充。
    • paddingMode=2，表示对越界位置用边界值的对称值填充。

  • 对input采样时，会根据interpolationMode进行不同处理：

    • interpolationMode="bilinear"，表示取input中(x, y, z)周围八个坐标的加权平均值。

      $$output(N,C,D_{out},H_{out},W_{out})=\sum _{i=0}^2\sum _{j=0}^2\sum _{k=0}^{2}w(i,j,k)\ast f(x^{\prime },y^{\prime },z^{\prime })$$

      其中：

      • $f(x^{\prime },y^{\prime },z^{\prime })$是原图像在$(x^{\prime },y^{\prime },z^{\prime })$的像素值。

      • $w(i,j,k)$是双线性插值周边8个点的权重，计算公式为：

        $$w(i)=\{\begin{array}{ll}1-|x_i^{\prime }-x_i|& |x_i^{\prime }-x_i|<1\\ 0& otherwise\end{array}$$

        $$w(j)=\{\begin{array}{ll}1-|y_j^{\prime }-y_j|& |y_j^{\prime }-y_j|<1\\ 0& otherwise\end{array}$$

        $$w(k)=\{\begin{array}{ll}1-|z_k^{\prime }-z_k|& |z_k^{\prime }-z_k|<1\\ 0& otherwise\end{array}$$

        $$w(i,j,k)=w(i)\ast w(j)\ast w(k)$$

    • interpolationMode="nearest"，表示取input中距离(x, y, z)最近的坐标值。

      $$output(N,C,D_{out},H_{out},W_{out})=input(N,C,D_{in},H_{in},W_{in})$$

      其中：

      $$\begin{gathered} D_{out}=min(round(x^{\prime }),H-1) \\ {D}_{out}=max(round(x^{\prime }),0) \end{gathered}$$

      $$\begin{gathered} H_{out}=min(round(y^{\prime }),H-1) \\ {H}_{out}=max(round(y^{\prime }),0) \end{gathered}$$

      $$\begin{gathered} W_{out}=min(round(z^{\prime }),W-1) \\ {W}_{out}=max(round(z^{\prime }),0) \end{gathered}$$

函数原型

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

aclnnStatus aclnnGridSampler3DGetWorkspaceSize(
  const aclTensor *input,
  const aclTensor *grid,
  int64_t          interpolationMode,
  int64_t          paddingMode,
  bool             alignCorners,
  aclTensor       *out,
  uint64_t        *workspaceSize,
  aclOpExecutor  **executor)

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

aclnnGridSampler3DGetWorkspaceSize

• 参数说明

  参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
  input（aclTensor*）	输入	进行插值计算的输入张量，对应公式中描述的`input`。	支持空Tensor。 当数据格式为ND时，会按照NCDHW格式进行处理；仅当满足条件（数据类型为FLOAT32 && interpolationMode为0 && C轴为4的倍数）时支持NDHWC。	FLOAT16、FLOAT32、DOUBLE、BFLOAT16	NCDHW、NDHWC、ND	5	√
  grid（aclTensor*）	输入	采样的网格，对应公式中描述的`grid`。	支持空Tensor。 数据类型与入参`input`的数据类型一致。 支持shape为(N, Dout, Hout, Wout, 3)，且N与入参`input`的shape中的N一致。	FLOAT16、FLOAT32、DOUBLE、BFLOAT16	ND	5	√
  interpolationMode（int64_t）	输入	表示插值模式，对应公式描述中的`interpolationMode`。	支持0：bilinear（双线性插值）、1：nearest（最邻近插值）两种模式。	-	-	-	-
  paddingMode（int64_t）	输入	表示grid范围外填充模式。即当grid有超过[-1, 1]范围的值，则按照paddingMode定义的方式处理相应的输出。对应公式描述中的`paddingMode`。	支持0：zeros、1：border、2：reflection三种模式。	-	-	-	-
  alignCorners（bool）	输入	表示设定特征图坐标与特征值的对应方式。	如果为True，则将极值-1和1视为参考输入的角像素点的中心点。如果为False，则视为参考输入的角像素点的角点。	-	-	-	-
  out（aclTensor*）	输出	插值计算的最终输出结果，对应公式中描述的`output`。	支持空Tensor。 数据格式和数据类型与input保持一致。 shape的N轴、C轴与input保持一致，shape的D轴、H轴、W轴与grid保持一致。	FLOAT16、FLOAT32、DOUBLE、BFLOAT16	NCDHW、NDHWC、ND	5	√
  workspaceSize（uint64_t*）	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
  executor（aclOpExecutor**）	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

  • Atlas 训练系列产品：

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

• 返回值

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

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

  返回码	错误码	描述
  ACLNN_ERR_PARAM_NULLPTR	161001	传入的input、grid或out是空指针。
  ACLNN_ERR_PARAM_INVALID	161002	input、grid、out的数据类型不在支持的范围之内或数据类型不一致。
  		input、grid、out的数据格式不在支持的范围之内。
  		interpolationMode或paddingMode的值不在支持范围内。
  		input、grid和out的维度关系不匹配。

aclnnGridSampler3D

• 参数说明

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

• 返回值

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

约束说明

• 输入input的$（D轴的大小\ast H轴的大小\ast W轴的大小）<INT32的最大值$。
• 确定性计算：
  • aclnnGridSampler3D默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_grid_sampler3d.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 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_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

    // 2. 构造输入与输出，需要根据API的接口自定义构造
    int64_t interpolationMode = 0;
    int64_t paddingMode = 0;
    bool alignCorners = false;
    std::vector<int64_t> inputShape = {1, 1, 1, 3, 3};
    std::vector<int64_t> gridShape = {1, 1, 2, 2, 3};
    std::vector<int64_t> outShape = {1, 1, 1, 2, 2};
    void *inputDeviceAddr = nullptr;
    void *gridDeviceAddr = nullptr;
    void *outDeviceAddr = nullptr;
    aclTensor *input = nullptr;
    aclTensor *grid = nullptr;
    aclTensor *out = nullptr;

    std::vector<float> inputHostData = {1, 2, 3, 4, 5, 6, 7, 8, 9};
    std::vector<float> gridHostData = {-1, -1, 0, -1, 1, -1, -1, 0, 0, 0, 1, 0};
    std::vector<float> outHostData = {0, 0, 0, 0};

    // 创建input aclTensor
    ret = CreateAclTensor(inputHostData, inputShape, &inputDeviceAddr, aclDataType::ACL_FLOAT, &input);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建grid aclTensor
    ret = CreateAclTensor(gridHostData, gridShape, &gridDeviceAddr, aclDataType::ACL_FLOAT, &grid);
    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);

    // 3. 调用CANN算子库API，需要修改为具体的Api名称
    uint64_t workspaceSize = 0;
    aclOpExecutor *executor;
    // 调用aclnnGridSampler3D第一段接口
    ret = aclnnGridSampler3DGetWorkspaceSize(
        input, grid, interpolationMode, paddingMode, alignCorners, out, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGridSampler3DGetWorkspaceSize 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);
    }
    // 调用aclnnGridSampler3D第二段接口
    ret = aclnnGridSampler3D(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGridSampler3D 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(resultData[0]),
        ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy resultData from device to host failed. ERROR: %d\n", ret);
              return ret);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("resultData[%ld] is: %f\n", i, resultData[i]);
    }

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

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