aclnnMoeTokenUnpermuteGrad
产品支持情况
| 产品 | 是否支持 |
|---|---|
| Ascend 950PR/Ascend 950DT | √ |
| Atlas A3 训练系列产品/Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品/Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | × |
| Atlas 推理系列产品 | × |
| Atlas 训练系列产品 | × |
功能说明
-
接口功能：aclnnMoeTokenUnpermute的反向传播。
-
计算公式：
-
probs非None：
unpermutedTokens[i]=permutedTokens[sortedIndices[i]]unpermutedTokens[i] = permutedTokens[sortedIndices[i]]
unpermutedTokens=unpermutedTokens.reshape(−1,topK_num,hiddenSize)unpermutedTokens = unpermutedTokens.reshape(-1, topK\_num, hiddenSize)
unpermutedTokens=unpermutedTokensGrad.unsqueeze(1)∗unpermutedTokensunpermutedTokens = unpermutedTokensGrad.unsqueeze(1) * unpermutedTokens
probsGrad=∑k=0K(unpermutedTokensi,j,k)probsGrad = \sum_{k=0}^{K}(unpermutedTokens_{i,j,k})
permutedTokensGrad[sortedIndices[i]]=((unpermutedTokensGrad.unsqueeze(1)∗probs.unsqueeze(−1)).reshape(−1,hiddenSize))[i]permutedTokensGrad[sortedIndices[i]] = ((unpermutedTokensGrad.unsqueeze(1) * probs.unsqueeze(-1)).reshape(-1, hiddenSize))[i]
-
probs为None：
permutedTokensGrad[sortedIndices[i]]=unpermutedTokensGrad[i]permutedTokensGrad[sortedIndices[i]] = unpermutedTokensGrad[i]
-
函数原型
每个算子分为两段式接口，必须先调用“aclnnMoeTokenUnpermuteGradGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnMoeTokenUnpermuteGrad”接口执行计算。
aclnnStatus aclnnMoeTokenUnpermuteGradGetWorkspaceSize(
const aclTensor *permutedTokens,
const aclTensor *unpermutedTokensGrad,
const aclTensor *sortedIndices,
const aclTensor *probsOptional,
bool paddedMode,
const aclIntArray *restoreShapeOptional,
aclTensor *permutedTokensGradOut,
aclTensor *probsGradOut,
uint64_t *workspaceSize,
aclOpExecutor **executor)
aclnnStatus aclnnMoeTokenUnpermuteGrad(
void *workspace,
uint64_t workspaceSize,
aclOpExecutor *executor,
aclrtStream stream)
aclnnMoeTokenUnpermuteGradGetWorkspaceSize
-
参数说明
参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor permutedTokens（aclTensor） 输入 表示输入token。 - BFLOAT16、FLOAT16、FLOAT32 ND (tokens_num * topK_num, hidden_size) √ unpermutedTokensGrad（aclTensor） 输入 unpermutedTokens的梯度。 - 与permutedTokens一致。 ND (tokens_num, hidden_size) √ sortedIndices（aclTensor） 输入 表示输入输出梯度的映射关系。 取值范围为[0, tokens_num * topK_num - 1]，且索引值不重复。 INT32 ND (tokens_num * topK_num) √ probsOptional（aclTensor） 输入 表示token选择指定专家的权重。 当probsOptional不为空时，topK_num等于probsOptional第2维；当probsOptional为空时，topK_num=1。 BFLOAT16、FLOAT16、FLOAT32 ND (tokens_num, topK_num) √ paddedMode（bool） 输入 true表示开启paddedMode，false表示关闭paddedMode。 目前仅支持false。 - - - - restoreShapeOptional（aclIntArray） 输入 当paddedMode为true后生效，否则不会对其进行操作。当paddedMode为true时，此为unpermutedTokens的shape。 当前仅支持nullptr。 aclIntArray* - - - permutedTokensGradOut（aclTensor） 输出 permutedTokens的梯度。 - 与permutedTokens一致。 ND (tokens_num * topK_num, hidden_size) × probsGradOut（aclTensor） 输出 probs的梯度。 - 与probsOptional一致。 ND (tokens_num, topK_num) × workspaceSize（uint64_t） 输出 返回需要在Device侧申请的workspace大小。 - - - - - executor（aclOpExecutor） 输出 返回op执行器，包含了算子计算流程。 - - - - - -
返回值
aclnnStatus：返回状态码，具体参见aclnn返回码。
第一段接口完成入参校验，出现以下场景时报错：
返回值 错误码 描述 ACLNN_ERR_PARAM_NULLPTR 161001 输入或输出的Tensor是空指针。 ACLNN_ERR_PARAM_INVALID 161002 输入和输出的数据类型不在支持的范围内。
aclnnMoeTokenUnpermuteGrad
-
参数说明
参数名 输入/输出 描述 workspace 输入 在Device侧申请的workspace内存地址。 workspaceSize 输入 在Device侧申请的workspace大小，由第一段接口aclnnMoeTokenUnpermuteGradGetWorkspaceSize获取。 executor 输入 op执行器，包含了算子计算流程。 stream 输入 指定执行任务的Stream。 -
返回值
aclnnStatus：返回状态码，具体参见aclnn返回码。
约束说明
- 确定性计算：
- aclnnMoeTokenUnpermuteGrad默认确定性实现。
- tokens_num表示输入的token数量，hidden_size表示词向量维度。
- 通过paddedMode区分以下两种模式：paddedMode等于true时，每个专家固定能够处理capacity个token。paddedMode等于false时，每个token固定被topK_num个专家处理。
- Atlas A2 训练系列产品/Atlas A2 推理系列产品、Atlas A3 训练系列产品/Atlas A3 推理系列产品：topK_num <= 512。
- Ascend 950PR/Ascend 950DT：
在调用本接口时，框架内部会转调用aclnnMoeFinalizeRoutingV2Grad接口，如果出现参数错误提示，请参考以下参数映射关系：
- permutedTokens输入等同于aclnnMoeFinalizeRoutingV2Grad接口的expandedXOptional输入。
- unpermutedTokensGrad输入等同于aclnnMoeFinalizeRoutingV2Grad接口的gradY输入。
- sortedIndices输入等同于aclnnMoeFinalizeRoutingV2Grad接口的expandedRowIdx输入。
- probsOptional输入等同于aclnnMoeFinalizeRoutingV2Grad接口的scalesOptional输入。
- paddedMode输入等同于aclnnMoeFinalizeRoutingV2Grad接口的dropPadMode输入。
- permutedTokensGradOut输出等同于aclnnMoeFinalizeRoutingV2Grad接口的gradExpandedXOut输出。
- probsGradOut输出等同于aclnnMoeFinalizeRoutingV2Grad接口的gradScalesOut输出。
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_moe_token_unpermute_grad.h"
#include <iostream>
#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<float> 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("mean result[%ld] is: %f\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的接口自定义构造
std::vector<int64_t> permutedTokensShape = {3, 2};
std::vector<int64_t> unpermutedTokensGradShape = {1, 2};
std::vector<int64_t> probsShape = {1, 3};
std::vector<int64_t> sortedIndicesShape = {3};
std::vector<int64_t> permutedTokensGradShape = {3, 2};
std::vector<int64_t> probsGradShape = {1, 3};
void* permutedTokensDeviceAddr = nullptr;
void* unpermutedTokensGradDeviceAddr = nullptr;
void* probsDeviceAddr = nullptr;
void* sortedIndicesDeviceAddr = nullptr;
void* permutedTokensGradDeviceAddr = nullptr;
void* probsGradDeviceAddr = nullptr;
aclTensor* permutedTokens = nullptr;
aclTensor* unpermutedTokensGrad = nullptr;
aclTensor* probs = nullptr;
aclTensor* sortedIndices = nullptr;
bool paddedMode = false;
aclTensor *permutedTokensGrad = nullptr;
aclTensor *probsGrad = nullptr;
std::vector<float> permutedTokensHostData = {1, 1, 1, 1, 1, 1};
std::vector<float> unpermutedTokensGradHostData = {1, 1};
std::vector<float> probsHostData = {1, 1, 1};
std::vector<int> sortedIndicesHostData = {0, 1, 2};
std::vector<float> permutedTokensGradHostData = {0, 0, 0, 0, 0, 0};
std::vector<float> probsGradHostData = {0, 0, 0};
ret = CreateAclTensor(permutedTokensHostData, permutedTokensShape,
&permutedTokensDeviceAddr, aclDataType::ACL_BF16,
&permutedTokens);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(unpermutedTokensGradHostData, unpermutedTokensGradShape, &unpermutedTokensGradDeviceAddr,
aclDataType::ACL_BF16, &unpermutedTokensGrad);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(probsHostData, probsShape, &probsDeviceAddr,
aclDataType::ACL_BF16, &probs);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(sortedIndicesHostData, sortedIndicesShape, &sortedIndicesDeviceAddr,
aclDataType::ACL_INT32, &sortedIndices);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(permutedTokensGradHostData, permutedTokensGradShape, &permutedTokensGradDeviceAddr, aclDataType::ACL_BF16,
&permutedTokensGrad);
CHECK_RET(ret == ACL_SUCCESS, return ret);
ret = CreateAclTensor(probsGradHostData, probsGradShape, &probsGradDeviceAddr, aclDataType::ACL_BF16,
&probsGrad);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API，需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor *executor;
// 调用aclnnMoeTokenUnpermuteGrad第一段接口
ret = aclnnMoeTokenUnpermuteGradGetWorkspaceSize(permutedTokens, unpermutedTokensGrad, sortedIndices, probs, paddedMode, nullptr,
permutedTokensGrad, probsGrad, &workspaceSize, &executor);
CHECK_RET(
ret == ACL_SUCCESS,
LOG_PRINT("aclnnMoeTokenUnpermuteGradGetWorkspaceSize 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);
}
// 调用aclnnMoeTokenUnpermuteGrad第二段接口
ret = aclnnMoeTokenUnpermuteGrad(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS,
LOG_PRINT("aclnnMoeTokenUnpermuteGrad 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(permutedTokensGradShape, &permutedTokensGradDeviceAddr);
PrintOutResult(probsGradShape, &probsGradDeviceAddr);
// 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
aclDestroyTensor(permutedTokens);
aclDestroyTensor(unpermutedTokensGrad);
aclDestroyTensor(sortedIndices);
aclDestroyTensor(probs);
aclDestroyTensor(permutedTokensGrad);
aclDestroyTensor(probsGrad);
// 7. 释放device资源
aclrtFree(permutedTokensDeviceAddr);
aclrtFree(unpermutedTokensGradDeviceAddr);
aclrtFree(probsDeviceAddr);
aclrtFree(sortedIndicesDeviceAddr);
aclrtFree(permutedTokensGradDeviceAddr);
aclrtFree(probsGradDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}