aclnnMoeTokenPermuteWithRoutingMapGrad

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	√
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	×

功能说明

• 算子功能：aclnnMoeTokenPermuteWithRoutingMap的反向传播。
• 计算公式：

$$permuteTokenId, outIndex= sortedIndices.sort(dim=-1)$$ $$capacity = permutedTokenOutputGrad.size(0) / numExperts$$

• probs不为None：$$probsGradOutOptional = zeros(tokens_num, numExperts)$$
  • paddedMode为true时
  $$probsGradOutOptional [sortedIndices[i], i/capacity] = permutedProbsOutputGradOptional[i]$$
  • paddedMode为false时
  $$probsGradOutOptional = maskedscatter(probsGradOutOptional,routingMap,permutedProbsOutputGradOptional)$$
• probs为None：$$tokensGradout= zeros(restoreShape, dtype=permutedTokens.dtype, device=permutedTokens.device)$$ $$tokensGradout[permuteTokenId[i]] += permutedTokens[outIndex[i]]$$

函数原型

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

• aclnnStatus aclnnMoeTokenPermuteWithRoutingMapGradGetWorkspaceSize(const aclTensor *permutedTokenOutputGrad, const aclTensor *permutedProbsOutputGradOptional, const aclTensor *sortedIndices, const aclTensor *routingMapOptional, int64_t experts_num, int64_t tokens_num, bool dropAndPad, aclTensor *tokensGradOut, aclTensor *probsGradOutOptional, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnMoeTokenPermuteWithRoutingMapGrad(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnMoeTokenPermuteWithRoutingMapGradGetWorkspaceSize

• 参数说明：

  • permutedTokenOutputGrad（aclTensor *，计算输入）：Device侧的aclTensor，正向输出permutedTokens的梯度，要求为一个维度为2D的Tensor，非droppad模式要求shape为一个2D的（tokens_num * topK_num，hidden_size），droppad模式要求shape为一个2D的（experts_num * capacity，hidden_size），其中topK_num表示每个token选中的专家数量，capacity表示每个专家选中的token数量。数据类型支持BFLOAT16、FLOAT16、FLOAT32，undefined要求为ND。支持undefined，不支持空tensor。
  • permutedProbsOutputGradOptional（aclTensor *，计算输入）：Device侧的aclTensor，可选输入，不传则表示不需要计算probsGradOutOptional，非droppad模式要求shape为一个1D的（tokens_num * topK_num），droppad模式要求shape为一个1D的（experts_num * capacity），其中topK_num表示每个token选中的专家数量，capacity表示每个专家选中的token数量。数据类型支持BFLOAT16、FLOAT16、FLOAT32，undefined要求为ND。支持undefined。
  • sortedIndices（aclTensor *，计算输入）：Device侧的aclTensor，非droppad模式要求shape为一个1D的（tokens_num * topK_num，），数据类型支持INT32，undefined要求为ND。索引取值范围[0，tokens_num * topK_num - 1], droppad模式要求shape为一个1D的（experts_num * capacity），数据类型支持INT32，undefined要求为ND。索引取值范围[0，experts_num * capacity - 1]。支持undefined。
  • routingMap（aclTensor *，计算输入）：Device侧的aclTensor，代表token到expert的映射关系，要求shape为一个2D的（tokens_num，experts_num），数据类型支持INT8、bool。当数据类型为INT8，取值支持0、1，当数据类型为bool，取值支持true、false，undefined要求为ND。支持undefined。非droppad模式要求每行中包含topK个true 或 1。
  • experts_num（int64_t，计算输入）：表示参与运算的专家个数。
  • tokens_num（int64_t，计算输入）：表示参与运算的token个数。
  • dropAndPad（bool, 计算输入）：true表示开启dropPaddedMode，false表示关闭dropPaddedMode。
  • tokensGradOut（aclTensor*，计算输出）：输入permutedTokens的梯度，要求是一个2D的Tensor，shape为（tokens_num ，hidden_size）。数据类型同permutedTokenOutputGrad，支持BFLOAT16、FLOAT16、FLOAT32，undefined要求为ND。不支持undefined。
  • probsGradOutOptional（aclTensor*，计算输出）：输入probs的梯度，可选输出，要求是一个2D的Tensor，shape为（tokens_num，experts_num）。数据类型同permutedProbsOutputGradOptional，支持BFLOAT16、FLOAT16、FLOAT32，undefined要求为ND。不支持undefined。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnMoeTokenPermuteWithRoutingMapGrad

• 参数说明：

  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnMoeTokenPermuteWithRoutingMapGradGetWorkspaceSize获取。
  • executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
  • stream（aclrtStream,入参）：指定执行任务的Stream。

• 返回值：

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

约束说明

非dropPaddedMode 场景topK_num <= 512 不支持混合精度输入，即permutedTokenOutputGrad、permutedProbsOutputGradOptional、tokensGradOut、probsGradOutOptional需要保持相同的数据类型

调用示例

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