0
代码
代码
Issues
Pull Requests
讨论
Wiki
分析
0
cann-robotcann-robotMaskedCausalConv1d&MaskedCausalConv1dBackward文档修改
e703f33e创建于 4月29日历史提交

aclnnMaskedCausalConv1dBackward

📄 查看源码

产品支持情况

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

功能说明

  • 接口功能：对hidden层的token之间进行一维分组卷积操作的反向梯度计算。

  • 计算公式：

    假定卷积输入x、卷积输出的梯度gradY和卷积输入的梯度gradX的shape是[S, B, H]，weight的shape是[W, H]，i和j分别表示S/B轴的索引，k为卷积窗口W内的索引，那么计算将被表示为：

    gradYMasked[i,j]=mask[j,i]∗gradY[i,j]gradYMasked[i,j] = mask[j,i] * gradY[i,j]

    gradX[i,j]=∑k=0W−1gradYMasked[i+k,j]∗weight[W−1−k]gradX[i,j] = \sum_{k=0}^{W-1} gradYMasked[i+k,j] * weight[W-1-k]

    gradWeight[k]=∑j=0B−1∑i=0S−1gradYMasked[i+W−1−k,j]∗x[i,j]gradWeight[k] = \sum_{j=0}^{B-1}\sum_{i=0}^{S-1} gradYMasked[i+W-1-k,j] * x[i,j]

    其中，无效位置的padding为0填充；当前W仅支持3；H轴为elementwise操作，上述公式不体现。

函数原型

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

aclnnStatus aclnnMaskedCausalConv1dBackwardGetWorkspaceSize(
  const aclTensor   *gradY,
  const aclTensor   *x,
  const aclTensor   *weight,
  const aclTensor   *maskOptional,
  aclTensor         *gradXOut,
  aclTensor         *gradWeightOut,
  uint64_t          *workspaceSize,
  aclOpExecutor    **executor)

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

aclnnMaskedCausalConv1dBackwardGetWorkspaceSize

  • 参数说明：

    参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor
    gradY（aclTensor*） 输入 表示分组卷积输出y的梯度，对应公式中的gradY。
    • 不支持空Tensor。
    • shape为[S, B, H]。
    		 BFLOAT16、FLOAT16 ND 3 √
    x（aclTensor*） 输入 表示分组卷积输入，对应公式中的x。
    • 不支持空Tensor。
    • shape与gradY一致。
    		 数据类型与gradY一致 ND 3 √
    weight（aclTensor*） 输入 表示卷积权重，对应公式中的weight。
    • 不支持空Tensor。
    • shape为[W, H]。
    		 数据类型与gradY一致 ND 2 √
    maskOptional（aclTensor*） 可选输入 表示卷积操作的输出掩码，对应公式中的mask。
    • 不支持空Tensor。
    • shape为[B, S]。
    • 默认值是nullptr。
    		 BOOL ND 2 √
    gradXOut（aclTensor*） 输出 表示分组卷积输入x的梯度，对应公式中的gradX。
    • 不支持空Tensor。
    • shape与gradY一致。
    		 数据类型与gradY一致 ND 3 x
    gradWeightOut（aclTensor*） 输出 表示分组卷积输入weight的梯度，对应公式中的gradWeight。
    • 不支持空Tensor。
    • shape与weight一致。
    		 数据类型与gradY一致 ND 2 x
    workspaceSize 输出 返回需要在Device侧申请的workspace大小。 - - - - -
    executor 输出 返回op执行器，包含算子计算流程。 - - - - -

  • 返回值：

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

    返回码 错误码 描述
    ACLNN_ERR_PARAM_NULLPTR 161001 传入参数是必选输入，输出或者必选属性，且是空指针。
    ACLNN_ERR_PARAM_INVALID 161002 gradY、x、weight、maskOptional、gradXOut和gradWeightOut的数据类型或数据格式不在支持的范围内。
    ACLNN_ERR_INNER_TILING_ERROR 561002 输入、输出Tensor的shape不在支持的范围内。

aclnnMaskedCausalConv1dBackward

  • 参数说明：

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

  • 返回值：

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

约束说明

  • 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
  • 确定性计算：
    • aclnnMaskedCausalConv1dBackward默认确定性实现。
  • 输入限制：
    • 输入输出的shape数据范围约束如下：
      • B（Batchsize）：取值范围为1~32。
      • B * S（Batchsize * SeqLength）：取值范围为1~512K。
      • H（hiddenSize）：取值范围384~24576，且是64的整数倍。
      • W：W当前只支持3。
  • 算子入参与中间计算结果，在对应运行数据类型（float16/bfloat16） 下，数值均不会超出该类型值域范围。
  • 算子输入不支持有±inf和nan的情况。

调用示例

通过aclnn单算子调用示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnn/opdev/fp16_t.h"
#include "aclnnop/aclnn_masked_causal_conv1d_backward.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;
}

void PrintOutResult(std::vector<int64_t>& shape, void** deviceAddr)
{
    auto size = GetShapeSize(shape);
    std::vector<int8_t> resultData(size, 0);
    auto ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), *deviceAddr, 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);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("result[%ld] is: %d\n", i, resultData[i]);
    }
}

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_ND, 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 S = 1;
    int64_t B = 2;
    int64_t H = 192 * 2;
    int64_t W = 3;

    std::vector<int64_t> gradYShape = {S, B, H};
    std::vector<int64_t> xShape = {S, B, H};
    std::vector<int64_t> weightShape = {W, H};
    std::vector<int64_t> maskShape = {B, S};
    std::vector<int64_t> gradXShape = {S, B, H};
    std::vector<int64_t> gradWeightShape = {W, H};

    std::vector<op::fp16_t> gradYHostData(S * B * H, 0);
    std::vector<op::fp16_t> xHostData(S * B * H, 0);
    std::vector<op::fp16_t> weightHostData(W * H, 0);
    std::vector<uint8_t> maskHostData(B * S, 0);
    std::vector<op::fp16_t> gradXHostData(S * B * H, 0);
    std::vector<op::fp16_t> gradWeightHostData(W * H, 0);

    void* gradYDeviceAddr = nullptr;
    void* xDeviceAddr = nullptr;
    void* weightDeviceAddr = nullptr;
    void* maskDeviceAddr = nullptr;
    void* gradXDeviceAddr = nullptr;
    void* gradWeightDeviceAddr = nullptr;

    aclTensor* gradY = nullptr;
    aclTensor* x = nullptr;
    aclTensor* weight = nullptr;
    aclTensor* mask = nullptr;
    aclTensor* gradX = nullptr;
    aclTensor* gradWeight = nullptr;

    ret = CreateAclTensor(gradYHostData, gradYShape, &gradYDeviceAddr, aclDataType::ACL_FLOAT16, &gradY);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT16, &x);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(weightHostData, weightShape, &weightDeviceAddr, aclDataType::ACL_FLOAT16, &weight);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(maskHostData, maskShape, &maskDeviceAddr, aclDataType::ACL_BOOL, &mask);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(gradXHostData, gradXShape, &gradXDeviceAddr, aclDataType::ACL_FLOAT16, &gradX);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(gradWeightHostData, gradWeightShape, &gradWeightDeviceAddr, aclDataType::ACL_FLOAT16, &gradWeight);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3. 调用CANN算子库API，需要修改为具体的API
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;

    // 调用aclnnMaskedCausalConv1dBackward第一段接口
    ret = aclnnMaskedCausalConv1dBackwardGetWorkspaceSize(
        gradY, x, weight, mask, gradX, gradWeight, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnMaskedCausalConv1dBackwardGetWorkspaceSize 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);
    }

    // 调用aclnnMaskedCausalConv1dBackward第二段接口
    ret = aclnnMaskedCausalConv1dBackward(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnMaskedCausalConv1dBackward 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的接口定义修改
    PrintOutResult(gradXShape, &gradXDeviceAddr);
    PrintOutResult(gradWeightShape, &gradWeightDeviceAddr);

    // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
    aclDestroyTensor(gradY);
    aclDestroyTensor(x);
    aclDestroyTensor(weight);
    aclDestroyTensor(mask);
    aclDestroyTensor(gradX);
    aclDestroyTensor(gradWeight);

    // 7. 释放device 资源
    aclrtFree(gradYDeviceAddr);
    aclrtFree(xDeviceAddr);
    aclrtFree(weightDeviceAddr);
    aclrtFree(maskDeviceAddr);
    aclrtFree(gradXDeviceAddr);
    aclrtFree(gradWeightDeviceAddr);

    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();

    return 0;
}