aclnnStridedSliceGrad

产品支持情况

  • Ascend 950PR&950DT系列产品:支持
  • Atlas A3系列产品:不支持
  • Atlas A2系列产品:不支持
  • Atlas 200I/500 A2推理产品:不支持
  • Atlas推理系列产品:不支持
  • Atlas训练系列产品:不支持

功能说明

  • 接口功能:StridedSlice的反向算子,将切片梯度张量dy映射回原始张量形状shape的对应位置,未被切片覆盖的位置填零。

函数原型

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

aclnnStatus aclnnStridedSliceGradGetWorkspaceSize(
    const aclIntArray  *shape,
    const aclIntArray  *begin,
    const aclIntArray  *end,
    const aclIntArray  *strides,
    const aclTensor    *dy,
    int64_t             beginMask,
    int64_t             endMask,
    int64_t             ellipsisMask,
    int64_t             newAxisMask,
    int64_t             shrinkAxisMask,
    const aclTensor    *out,
    uint64_t           *workspaceSize,
    aclOpExecutor     **executor)
aclnnStatus aclnnStridedSliceGrad(
    void           *workspace,
    uint64_t        workspaceSize,
    aclOpExecutor  *executor,
    aclrtStream     stream)

aclnnStridedSliceGradGetWorkspaceSize

  • 参数说明:

    参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor
    shape(aclIntArray*) 输入 原始输入张量的形状,即输出out的shape。
    • 长度与begin/end/strides相同。
    • 各元素值≥0(0表示空张量)。
    • 剔除长度为1的维度后秩不超过8。
    INT64 - - -
    begin(aclIntArray*) 输入 切片起始索引,对应正向StridedSlice的begin参数。
    • 长度与shape相同。
    • 支持负索引(从末尾倒数)。
    INT64 - - -
    end(aclIntArray*) 输入 切片结束索引(不含),对应正向StridedSlice的end参数。
    • 长度与shape相同。
    • 支持负索引。
    INT64 - - -
    strides(aclIntArray*) 输入 切片步长,对应正向StridedSlice的strides参数。
    • 长度与shape相同。
    • 元素值不能为0,支持负值(反向切片)。
    • 被shrinkAxisMask置位的维度,其strides必须为1。
    INT64 - - -
    dy(aclTensor*) 输入 切片操作的输出梯度张量。
    • dy.shape必须等于对原始shape执行StridedSlice正向操作后的输出shape。
    FLOAT16、BFLOAT16、FLOAT、DOUBLE、INT8、INT16、INT32、INT64、UINT8、UINT16、UINT32、UINT64、COMPLEX32、COMPLEX64 ND 0-8 √
    beginMask(int64_t) 输入 位掩码,第i位为1时该维度的begin被忽略,从该维首元素开始。 - INT64 - - -
    endMask(int64_t) 输入 位掩码,第i位为1时该维度的end被忽略,切片延伸至该维末尾。 - INT64 - - -
    ellipsisMask(int64_t) 输入 位掩码,标记省略号维度,被标记的维度全量保留(等价于":")。
    • 至多有1位为1。
    INT64 - - -
    newAxisMask(int64_t) 输入 位掩码,第i位为1时在对应位置插入新维度(长度为1)。 - INT64 - - -
    shrinkAxisMask(int64_t) 输入 位掩码,第i位为1时对应维度在输出中被压缩(该维取单个元素)。被置位维度的strides必须为1。 - INT64 - - -
    out(aclTensor*) 输出 反向传播结果张量,shape与原始正向算子输入相同(即shape参数指定的形状)。
    • 数据类型与dy一致。
    • 未被切片覆盖的位置填0。
    与dy一致 ND - -
    workspaceSize(uint64_t*) 输出 返回需要在Device侧申请的workspace大小。 - - - - -
    executor(aclOpExecutor**) 输出 返回op执行器,包含了算子计算流程。 - - - - -
  • 返回值:

    aclnnStatus:返回状态码,具体参见aclnn返回码。

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

    返回值 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 dy、out存在空指针。
    ACLNN_ERR_PARAM_INVALID 161002 dy或out的数据类型不在支持的范围之内。

aclnnStridedSliceGrad

  • 参数说明:

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

    aclnnStatus:返回状态码,具体参见aclnn返回码。

约束说明

  • 确定性计算:
    • aclnnStridedSliceGrad默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_strided_slice_grad.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)
{
    // 固定写法,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);
    // 申请 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);
    // 将 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];
    }
    // 创建 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 对外接口列表
    int32_t deviceId = 0;
    aclrtStream stream;
    auto ret = Init(deviceId, &stream);
    CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

    // 2. 构造输入与输出
    //
    // 场景说明:
    //   正向 StridedSlice 从 shape=[3,4,5] 的张量中切出 [0:2, 1:3, 2:4](步长全1),
    //   正向输出 shape = [2, 2, 2]。
    //   本反向算子将 dy(shape=[2,2,2])中的梯度散射回 output(shape=[3,4,5]),
    //   未被切片覆盖的位置填 0。
    //
    // 参数:
    //   shape   = [3, 4, 5]   — 原始正向输入的 shape,即 output 的 shape
    //   begin   = [0, 1, 2]
    //   end     = [2, 3, 4]
    //   strides = [1, 1, 1]
    //   mask 全 0

    std::vector<int64_t> shapeData = {3, 4, 5};
    std::vector<int64_t> beginData = {0, 1, 2};
    std::vector<int64_t> endData = {2, 3, 4};
    std::vector<int64_t> stridesData = {1, 1, 1};

    std::vector<int64_t> dyShape = {2, 2, 2};
    std::vector<int64_t> outputShape = {3, 4, 5};

    // dy 梯度数据(float,全 1.0)
    std::vector<float> dyHostData(GetShapeSize(dyShape), 1.0f);
    // output 初始化为 0
    std::vector<float> outputHostData(GetShapeSize(outputShape), 0.0f);

    void* dyDeviceAddr = nullptr;
    void* outputDeviceAddr = nullptr;
    aclTensor* dy = nullptr;
    aclTensor* output = nullptr;

    // 创建 dy aclTensor
    ret = CreateAclTensor(dyHostData, dyShape, &dyDeviceAddr, aclDataType::ACL_FLOAT, &dy);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 创建 output aclTensor
    ret = CreateAclTensor(outputHostData, outputShape, &outputDeviceAddr, aclDataType::ACL_FLOAT, &output);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 创建值依赖输入(aclIntArray)
    aclIntArray* shape = aclCreateIntArray(shapeData.data(), shapeData.size());
    aclIntArray* begin = aclCreateIntArray(beginData.data(), beginData.size());
    aclIntArray* end = aclCreateIntArray(endData.data(), endData.size());
    aclIntArray* strides = aclCreateIntArray(stridesData.data(), stridesData.size());
    CHECK_RET(shape != nullptr && begin != nullptr && end != nullptr && strides != nullptr,
              LOG_PRINT("aclCreateIntArray failed.\n");
              return -1);

    // mask 参数(全 0 表示不启用任何特殊切片语义)
    int64_t beginMask = 0;
    int64_t endMask = 0;
    int64_t ellipsisMask = 0;
    int64_t newAxisMask = 0;
    int64_t shrinkAxisMask = 0;

    // 3. 调用 CANN 算子库 API(两段式接口)
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor = nullptr;

    // 调用 aclnnStridedSliceGrad 第一段接口
    ret = aclnnStridedSliceGradGetWorkspaceSize(shape, begin, end, strides, dy, beginMask, endMask, ellipsisMask,
                                                newAxisMask, shrinkAxisMask, output, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnStridedSliceGradGetWorkspaceSize 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);
    }

    // 调用 aclnnStridedSliceGrad 第二段接口
    ret = aclnnStridedSliceGrad(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnStridedSliceGrad 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(outputShape);
    std::vector<float> resultData(size, 0);
    ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(float), outputDeviceAddr, 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. 释放 aclIntArray 和 aclTensor
    aclDestroyIntArray(shape);
    aclDestroyIntArray(begin);
    aclDestroyIntArray(end);
    aclDestroyIntArray(strides);
    aclDestroyTensor(dy);
    aclDestroyTensor(output);

    // 7. 释放 Device 资源
    aclrtFree(dyDeviceAddr);
    aclrtFree(outputDeviceAddr);
    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();

    return 0;
}