aclnnQuantMatmulAllReduceV2
产品支持情况
| 产品 | 是否支持 |
|---|---|
| Ascend 950PR/Ascend 950DT | √ |
| Atlas A3 训练系列产品/Atlas A3 推理系列产品 | × |
| Atlas A2 训练系列产品/Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | × |
| Atlas 推理系列产品 | × |
| Atlas 训练系列产品 | × |
说明: 使用该接口时,请确保驱动固件包和CANN包都为配套的8.0.RC2版本或者配套的更高版本,否则将会引发报错,比如BUS ERROR等。
功能说明
-
接口功能:
aclnnQuantMatmulAllReduceV2接口是对aclnnQuantMatmulAllReduce接口的功能扩展,新增支持pertoken量化方式。aclnnQuantMatmulAllReduceV2共支持pertensor、perchannel、pertoken量化方式。 -
计算公式:
分为以下2种情形:
-
情形1:对量化后的入参x1、x2进行MatMul计算后,接着进行dequant计算,接着与x3进行Add操作,最后做AllReduce计算。
output=AllReduce(dequantScale∗(x1int8@x2int8+biasint32)+x3)output= AllReduce(dequantScale*(x1_{int8}@x2_{int8} + bias_{int32}) + x3)
-
情形2:对量化后的入参x1、x2进行MatMul计算后,接着进行dequant和pertoken计算,接着与x3进行Add操作,最后做AllReduce计算。
output=AllReduce(dequantScale∗pertokenScaleOptional∗(x1int8@x2int8+biasOptionalint32)+x3Optional)output= AllReduce(dequantScale * pertokenScaleOptional * (x1_{int8}@x2_{int8} + biasOptional_{int32}) + x3Optional)
-
函数原型
每个算子分为两段式接口,必须先调用aclnnQuantMatmulAllReduceV2GetWorkspaceSize接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用aclnnQuantMatmulAllReduceV2接口执行计算。
aclnnStatus aclnnQuantMatmulAllReduceV2GetWorkspaceSize(
const aclTensor *x1,
const aclTensor *x2,
const aclTensor *biasOptional,
const aclTensor *x3Optional,
const aclTensor *dequantScale,
const aclTensor *pertokenScaleOptional,
const char *group,
const char *reduceOp,
int64_t commTurn,
int64_t streamMode,
const aclTensor *output,
uint64_t *workspaceSize,
aclOpExecutor **executor)
aclnnStatus aclnnQuantMatmulAllReduceV2(
void *workspace,
uint64_t workspaceSize,
aclOpExecutor *executor,
const aclrtStream stream)
aclnnQuantMatmulAllReduceV2GetWorkspaceSize
-
参数说明
参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor x1 输入 MatMul计算的左矩阵,即计算公式中的x1。 - 当前版本仅支持二维或者三维输入。
- 支持不转置场景。
INT8 ND 2-3 × x2 输入 MatMul计算的右矩阵,即计算公式中的x2。 - 当前版本仅支持二维输入。
- 支持转置/不转置场景。
- ND格式下支持最后两轴转置情况下的非连续的tensor,其他非连续tensor不支持
INT8 ND、FRACTAL_NZ 2 × biasOptional 输入 计算公式中的biasOptional。 当前版本仅支持一维输入。 INT32 ND 0-1 √ x3Optional 输入 MatMul计算后的add计算,即计算公式中的x3Optional。 shape与MatMul计算后的shape一致。 FLOAT16、BFLOAT16 ND 2 √ dequantScale 输入 MatMul计算后的去量化系数,即计算公式中的dequantScale。 - shape在pertensor场景为(1),PerChannel场景为(n)/(1, n)
- 输出为BFLOAT16时,直接将BFLOAT16类型的dequantScale传入本接口。
- 输出为FLOAT16时,如果pertokenScaleOptional不为空,可直接将FLOAT32类型的dequantScale传入本接口,如果pertokenScaleOptional为空,则需提前调用TransQuantParamV2算子的aclnn接口来将dequantScale转成INT64/UINT64数据类型。
INT64、UINT64、FLOAT32、BFLOAT16 ND 2 √ pertokenScaleOptional 输入 MatMul计算后的pertoken去量化系数,即计算公式中的pertokenScaleOptional。 x1为(b, s, k)时,shape为(b*s);x1为(m, k)时shape为(m)。 FLOAT32 ND 2 √ group 输入 通信域名称。 通过Hccl提供的接口“extern HcclResult HcclGetCommName(HcclComm comm, char* commName);”获取,其中commName即为group。 String - - - reduceOp 输入 reduce操作类型。 当前版本仅支持输入"sum"。 String - - - commTurn 输入 通信数据切分数,即总数据量/单次通信量。 当前版本仅支持输入0。 INT64 - - - streamMode 输入 流模式的枚举。 当前版本仅支持枚举值1。 INT64 - - - output 输出 MatMul计算与AllReduce通信的结果,即计算公式中的output。 output的维数与x1一致。 FLOAT16、BFLOAT16 ND 2-3 √ workspaceSize 输出 返回需要在device侧申请的workspace大小。 - - - - - executor 输出 返回op执行器,包含了算子计算流程。 - - - - - -
Atlas A2 训练系列产品/Atlas A2 推理系列产品:
- 输入x2的数据格式支持ND(当前版本仅支持二维输入)和
FRACTAL_NZ格式(当前版本仅支持四维输入)。当x2的数据格式为FRACTAL_NZ时,配合aclnnCalculateMatmulWeightSizeV2和aclnnTransMatmulWeight完成数据格式ND到数据格式NZ的转换,非连续的tensor仅支持transpose场景。
- 输入x2的数据格式支持ND(当前版本仅支持二维输入)和
-
Ascend 950PR/Ascend 950DT:
- 输入x2的数据格式仅支持ND格式(当前版本仅支持二维输入)。
-
返回值
返回aclnnStatus状态码,具体参见aclnn返回码。
第一阶段接口完成入参校验,出现以下场景报错:
返回值 错误码 描述 ACLNN_ERR_PARAM_NULLPTR 161001 传入的x1、x2、dequantScale或output是空指针。 ACLNN_ERR_PARAM_INVALID 161002 x1、x2、biasOptional、dequantScale、pertokenScaleOptional、x3Optional或output的数据类型不在支持的范围之内。 streamMode不在合法范围内。 x1、x2、biasOptional、dequantScale、pertokenScaleOptional、x3Optional或output的shape不符合约束要求。
aclnnQuantMatmulAllReduceV2
-
参数说明
参数名 输入/输出 描述 workspace 输入 在device侧申请的workspace内存地址。 workspaceSize 输入 在device侧申请的workspace大小,由第一段接口 aclnnQuantMatmulAllReduceV2GetWorkspaceSize获取。executor 输入 op执行器,包含了算子计算流程。 stream 输入 指定执行任务的stream。 -
返回值
返回aclnnStatus状态码,具体参见aclnn返回码。
约束说明
- 确定性计算:
- Atlas A2 训练系列产品/Atlas A2 推理系列产品:
aclnnQuantMatmulAllReduceV2默认非确定性实现,支持通过配置HCCL_DETERMINISTIC环境变量为true开启确定性计算。 - Ascend 950PR/Ascend 950DT:
aclnnQuantMatmulAllReduceV2默认确定性实现。
- Atlas A2 训练系列产品/Atlas A2 推理系列产品:
- 增量场景不使能MC2,全量场景使能MC2。
- 输入x1可为二维或者三维,且不为空Tensor,其shape为(b, s, k)或者(m, k)。x2必须是二维,且不为空Tensor。其shape为(k, n),k轴满足mm算子入参要求,k轴相等。
- m大小不超过2147483647,x1与x2的最后一维大小不超过65535,x1的最后一维指k,x2的最后一维指转置时的k或非转置时的n。
- bias若非空,shape为(n)。x3若非空,shape大小与output相等。
- 当输入x1的shape为(b, s, k)时,输出output的shape为(b, s, n),当输入x1的shape为(m, k)时,输出output的shape为(m, n)。
- 传入的x1、x2、dequantScale或者output不为空指针。
- x1和x2、dequantScale、output、bias(非空场景)、x3(非空场景)的数据类型和数据格式需要在支持的范围之内。
- 若输出output类型为FLOAT16,当pertokenScaleOptional为空时,dequantScale的类型为INT64、UINT64;当pertokenScaleOptional不为空时,dequantScale的类型为FLOAT32。
- 若输出output类型为BFLOAT16,dequantScale的类型为BFLOAT16。
- x1的shape为(b, s, k)时,pertokenScaleOptional的shape为(b*s),x1的shape为(m, k)时,pertokenScaleOptional的shape为(m)。
- 仅支持hccs链路all mesh组网。
- Atlas A2 训练系列产品/Atlas A2 推理系列产品:支持1、2、4、8卡。
- Ascend 950PR/Ascend 950DT:支持1、2、4、8、16、32、64卡。
- Atlas A2 训练系列产品/Atlas A2 推理系列产品:一个模型中的通算融合MC2算子,仅支持相同通信域。
- 空tensor支持度:
- 不支持空tensor。
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
说明:本示例代码调用了部分HCCL集合通信库接口:HcclGetCommName、HcclCommInitAll、HcclCommDestroy, 请参考 <<HCCL API (C)>>。
-
Atlas A2 训练系列产品/Atlas A2 推理系列产品、Ascend 950PR/Ascend 950DT:
#include <iostream> #include <vector> #include <thread> #include "hccl/hccl.h" #include "aclnn/opdev/fp16_t.h" #include "aclnnop/aclnn_trans_matmul_weight.h" #include "aclnnop/aclnn_quant_matmul_all_reduce_v2.h" int ndev = 2; #define ACL_CHECK(ret) \ do { \ auto retcode = ret; \ if (retcode != ACL_SUCCESS) { \ printf("[ERROR] acl interface return err %s:%d, retcode: %d \n", __FILE__, __LINE__, retcode); \ return retcode; \ } \ } while (0) #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; } struct Args { uint32_t rankId; HcclComm hcclComm; aclrtStream stream; aclrtContext context; std::string format; }; template<typename T> int CreateWeightNzAclTensor(const std::vector<T> &hostData, const std::vector<int64_t> &shape, void **deviceAddr, aclDataType dataType, aclTensor **tensor, Args &args) { auto size = GetShapeSize(shape) * sizeof(T); const aclIntArray *mat2Size = aclCreateIntArray(shape.data(), shape.size()); auto ret = aclnnCalculateMatmulWeightSizeV2(mat2Size, ACL_INT8, &size); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnCalculateMatmulWeightSizeV2 failed. ERROR: %d\n", ret); return ret); // 调用aclrtMalloc申请device内存 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); uint64_t transWorkspaceSize; aclOpExecutor *executor; void *transWorkspaceAddr = nullptr; ret = aclnnTransMatmulWeightGetWorkspaceSize(*tensor, &transWorkspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS && transWorkspaceSize > 0, printf("[ERROR] aclnnTransMatmulWeightGetWorkspaceSize failed. ret = %d \n", ret); return ret); ACL_CHECK(aclrtMalloc(&transWorkspaceAddr, transWorkspaceSize, ACL_MEM_MALLOC_HUGE_FIRST)); ret = aclnnTransMatmulWeight(transWorkspaceAddr, transWorkspaceSize, executor, args.stream); CHECK_RET(ret == ACL_SUCCESS, printf("[ERROR] aclnnTransMatmulWeight failed. ret = %d \n", ret);return ret); ACL_CHECK(aclrtSynchronizeStreamWithTimeout(args.stream, 20000)); 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 launchOneThreadQuantMatmulAllReduce(Args &args) { int ret; ret = aclrtSetCurrentContext(args.context); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetCurrentContext failed. ERROR: %d\n", ret); return ret); char hcom_name[128]; ret = HcclGetCommName(args.hcclComm, hcom_name); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("[ERROR] HcclGetCommName failed. ret = %d \n", ret); return -1); LOG_PRINT("[INFO] rank %d hcom: %s stream: %p, context : %p\n", args.rankId, hcom_name, args.stream, args.context); std::vector<int64_t> x1Shape = {32, 64}; std::vector<int64_t> x2Shape = {64, 128}; std::vector<int64_t> biasShape = {128}; std::vector<int64_t> dequantScaleShape = {128}; std::vector<int64_t> pertokenScaleShape = {32}; std::vector<int64_t> x3Shape = {32, 128}; std::vector<int64_t> outShape = {32, 128}; void *x1DeviceAddr = nullptr; void *x2DeviceAddr = nullptr; void *biasDeviceAddr = nullptr; void *dequantScaleDeviceAddr = nullptr; void *pertokenScaleDeviceAddr = nullptr; void *x3DeviceAddr = nullptr; void *outDeviceAddr = nullptr; aclTensor *x1 = nullptr; aclTensor *x2 = nullptr; aclTensor *bias = nullptr; aclTensor *dequantScale = nullptr; aclTensor *pertokenScale = nullptr; aclTensor *x3 = nullptr; aclTensor *out = nullptr; int64_t commTurn = 0; int64_t streamMode = 1; uint64_t workspaceSize = 0; aclOpExecutor *executor; void *workspaceAddr = nullptr; long long x1ShapeSize = GetShapeSize(x1Shape); long long x2ShapeSize = GetShapeSize(x2Shape); long long biasShapeSize = GetShapeSize(biasShape); long long dequantScaleShapeSize = GetShapeSize(dequantScaleShape); long long pertokenScaleShapeSize = GetShapeSize(pertokenScaleShape); long long x3ShapeSize = GetShapeSize(x3Shape); long long outShapeSize = GetShapeSize(outShape); std::vector<int8_t> x1HostData(x1ShapeSize, 1); std::vector<int8_t> x2HostData(x2ShapeSize, 1); std::vector<int32_t> biasHostData(biasShapeSize, 1); std::vector<float> dequantScaleHostData(dequantScaleShapeSize, 1); std::vector<float> pertokenScaleHostData(pertokenScaleShapeSize, 1); std::vector<op::fp16_t> x3HostData(x3ShapeSize, 1); std::vector<op::fp16_t> outHostData(outShapeSize, 0); // 创建 tensor ret = CreateAclTensor(x1HostData, x1Shape, &x1DeviceAddr, aclDataType::ACL_INT8, &x1); CHECK_RET(ret == ACL_SUCCESS, return ret); if (args.format == "NZ") { ret = CreateWeightNzAclTensor(x2HostData, x2Shape, &x2DeviceAddr, aclDataType::ACL_INT8, &x2, args); } else { ret = CreateAclTensor(x2HostData, x2Shape, &x2DeviceAddr, aclDataType::ACL_INT8, &x2); } CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(biasHostData, biasShape, &biasDeviceAddr, aclDataType::ACL_INT32, &bias); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(dequantScaleHostData, dequantScaleShape, &dequantScaleDeviceAddr, aclDataType::ACL_FLOAT, &dequantScale); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(pertokenScaleHostData, pertokenScaleShape, &pertokenScaleDeviceAddr, aclDataType::ACL_FLOAT, &pertokenScale); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(x3HostData, x3Shape, &x3DeviceAddr, aclDataType::ACL_FLOAT16, &x3); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT16, &out); CHECK_RET(ret == ACL_SUCCESS, return ret); // 调用第一段接口 ret = aclnnQuantMatmulAllReduceV2GetWorkspaceSize(x1, x2, bias, x3, dequantScale, pertokenScale, hcom_name, "sum", commTurn, streamMode, out, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantMatmulAllReduceV2GetWorkspaceSize failed. ERROR: %d\n", ret); return ret); // 根据第一段接口计算出的workspaceSize申请device内存 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); } // 调用第二段接口 ret = aclnnQuantMatmulAllReduceV2(workspaceAddr, workspaceSize, executor, args.stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantMatmulAllReduceV2 failed. ERROR: %d\n", ret); return ret); //(固定写法)同步等待任务执行结束 ret = aclrtSynchronizeStreamWithTimeout(args.stream, 10000); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret); LOG_PRINT("device%d aclnnQuantMatmulAllReduceV2 execute success \n", args.rankId); // 释放device资源,需要根据具体API的接口定义修改 if (x1 != nullptr) { aclDestroyTensor(x1); } if (x2 != nullptr) { aclDestroyTensor(x2); } if (bias != nullptr) { aclDestroyTensor(bias); } if (dequantScale != nullptr) { aclDestroyTensor(dequantScale); } if (pertokenScale != nullptr) { aclDestroyTensor(pertokenScale); } if (x3 != nullptr) { aclDestroyTensor(x3); } if (out != nullptr) { aclDestroyTensor(out); } if (x1DeviceAddr != nullptr) { aclrtFree(x1DeviceAddr); } if (x2DeviceAddr != nullptr) { aclrtFree(x2DeviceAddr); } if (biasDeviceAddr != nullptr) { aclrtFree(biasDeviceAddr); } if (dequantScaleDeviceAddr != nullptr) { aclrtFree(dequantScaleDeviceAddr); } if (pertokenScaleDeviceAddr != nullptr) { aclrtFree(pertokenScaleDeviceAddr); } if (x3DeviceAddr != nullptr) { aclrtFree(x3DeviceAddr); } if (outDeviceAddr != nullptr) { aclrtFree(outDeviceAddr); } if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(args.stream); HcclCommDestroy(args.hcclComm); aclrtDestroyContext(args.context); aclrtResetDevice(args.rankId); return 0; } int main(int argc, char *argv[]) { int ret; int32_t devices[ndev]; for (int i = 0; i < ndev; i++) { devices[i] = i; } HcclComm comms[128]; ret = aclInit(nullptr); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret); // 初始化集合通信域 for (int i = 0; i < ndev; i++) { ret = aclrtSetDevice(devices[i]); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret); } ret = HcclCommInitAll(ndev, devices, comms); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("HcclCommInitAll failed. ERROR: %d\n", ret); return ret); Args args[ndev]; aclrtStream stream[ndev]; aclrtContext context[ndev]; for (uint32_t rankId = 0; rankId < ndev; rankId++) { ret = aclrtSetDevice(rankId); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret); ret = aclrtCreateContext(&context[rankId], rankId); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateContext failed. ERROR: %d\n", ret); return ret); ret = aclrtCreateStream(&stream[rankId]); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret); } // 启动多线程 std::vector<std::unique_ptr<std::thread>> threads(ndev); for (uint32_t rankId = 0; rankId < ndev; rankId++) { args[rankId].rankId = rankId; args[rankId].hcclComm = comms[rankId]; args[rankId].stream = stream[rankId]; args[rankId].context = context[rankId]; threads[rankId].reset( new(std::nothrow) std::thread(&launchOneThreadQuantMatmulAllReduce, std::ref(args[rankId]))); } for (uint32_t rankId = 0; rankId < ndev; rankId++) { threads[rankId]->join(); } aclFinalize(); return 0; }