aclnnMoeInitRoutingV3

产品支持情况

产品	是否支持
[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]	×

功能说明

• 算子功能：MoE的routing计算，根据undefined的计算结果做routing处理，支持不量化和动态量化模式。本接口针对V2接口undefined做了如下功能变更，请根据实际情况选择合适的接口：

  1.增加动态量化功能，支持输出expendX的 int8动态量化输出

  2.增加参数activeExpertRangeOptional，支持筛选有效范围内的expertId

  3.删除属性expertTokensBeforeCapacityFlag、删除输出expertTokensBeforeCapacityOut (使用expertTokensCountOrCumsumOut进行输出)

• 计算公式：

  1.对输入expertIdx做排序，得出排序后的结果sortedExpertIdx和对应的序号sortedRowIdx：

  $$sortedExpertIdx, sortedRowIdx=keyValueSort(expertIdx,rowIdx)$$

  2.以sortedRowIdx做位置映射得出expandedRowIdxOut：

  $$expandedRowIdxOut[sortedRowIdx[i]]=i$$

  3.在drop模式下，对sortedExpertIdx的每个专家统计直方图结果，得出expertTokensCountOrCumsumOutOptional：

  $$expertTokensCountOrCumsumOutOptional[i]=Histogram(sortedExpertIdx)$$

  4.计算quant结果：

  • 动态quant：
    • 若不输入scale：$$dynamicQuantScaleOutOptional = row\_max(abs(x)) / 127$$ $$quantResult = round(x / dynamicQuantScaleOutOptional)$$
    • 若输入scale:$$dynamicQuantScaleOutOptional = row\_max(abs(x * scaleOptional)) / 127$$ $$quantResult = round(x / dynamicQuantScaleOutOptional)$$

  5.对quantResult取前NUM_ROWS个sortedRowIdx的对应位置的值，得出expandedXOut：

  $$expandedXOut[i]=quantResult[sortedRowIdx[i]\%NUM\_ROWS]$$

  6.expandedRowIdxOut的有效元素数量availableIdxNum计算方式为，expertIdx中activeExpertRangeOptional范围内的元素的个数 $$ availableIdxNum = |{x\in expertIdx| expert_start \le x<expert_end \ }| $$

函数原型

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

• aclnnStatus aclnnMoeInitRoutingV3GetWorkspaceSize(const aclTensor *x, const aclTensor *expertIdx, const aclTensor *scaleOptional, const aclTensor *offsetOptional, int64_t activeNum, int64_t expertCapacity, int64_t expertNum, int64_t dropPadMode, int64_t expertTokensNumType, bool expertTokensNumFlag, int64_t quantMode, const aclIntArray *activeExpertRangeOptional, int64_t rowIdxType, const aclTensor *expandedXOut, const aclTensor *expandedRowIdxOut, const aclTensor *expertTokensCountOrCumsumOut, const aclTensor *expandedScaleOut, uint64_t *workspaceSize, aclOpExecutor **executor)

• aclnnStatus aclnnMoeInitRoutingV3(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnMoeInitRoutingV3GetWorkspaceSize

• 参数说明：

  • x（aclTensor*，计算输入）：MOE的输入即token特征输入，要求为一个2D的Tensor，shape为(NUM_ROWS, H)，H代表每个Token的长度，数据类型支持FLOAT16、BFLOAT16、FLOAT32、INT8，undefined要求为ND。
  • expertIdx （aclTensor*，计算输入）：undefined的输出每一行特征对应的K个处理专家，要求是一个2D的shape (NUM_ROWS, K)，且里面元素专家id不能超过专家数。数据类型支持INT32，undefined要求为ND。
  • scaleOptional （aclTensor*，计算输入）：表示用于计算quant结果的参数，数据类型支持FLOAT32，undefined要求为ND。如果不输入表示计算时不使用scale，且输出expandedScaleOut中的值未定义。
    • 非量化场景下，如果输入则要求为1D的Tensor，shape为(NUM_ROWS,)。
    • 动态quant场景下，如果输入则要求为2D的Tensor，shape为(expertEnd-expertStart, H)。
  • offsetOptional（aclTensor*，计算输入）：表示用于计算quant结果的偏移值。数据类型支持FLOAT32，undefined要求为ND。
    • 在非量化场景下不输入。
    • 动态quant场景下不输入。
  • activeNum（int64_t，计算输入）：表示总的最大处理row数，输出expandedXOut只有这么多行是有效的，当前入参校验需大于等于0。当前未使用，校验需等于NUM_ROWS*K。
  • expertCapacity（int64_t， 计算输入）：表示每个专家能够处理的tokens数，取值范围大于等于0。当前未使用，仅校验非空。
  • expertNum（int64_t， 计算输入）：表示专家数，要求大于0，expertTokensNumType为key_value模式时，取值范围为(0, 5120], 其它模式取值范围(0, 10240]。
  • dropPadMode（int64_t， 计算输入）：表示是否为DropPad场景，取值为0和1（当前仅支持0）。
    • 0：表示Dropless场景，该场景下不校验expertCapacity。
    • 1：表示DropPad场景。
  • expertTokensNumType（int64_t， 计算输入）：取值为0、1和2 （当前仅支持1和2）。
    • 0：表示cumsum模式。
    • 1：表示count模式，即输出的值为各个专家处理的token数量的累计值。
    • 2：表示key_value模式，即输出的值为专家和对应专家处理token数量的累计值。
  • expertTokensNumFlag（bool，计算输入）：取值为false和true（当前仅支持true）。
    • false：表示不输出expertTokensCountOrCumsumOut。
    • true：表示输出expertTokensCountOrCumsumOut。
  • quantMode（int64_t， 计算输入）：取值为0、1、-1（当前仅支持1和-1）。
    • 0：表示静态quant场景。
    • 1：表示动态quant场景。
    • -1：表示不量化场景。
  • activeExpertRangeOptional（aclIntArray *， 计算输入）, 长度为2，数组内的值为[expertStart, expertEnd], 表示活跃的expert范围在区间[expertStart, expertEnd)内，左闭右开。要求数组内的值大于等于0，并且expertEnd不大于expertNum。
  • rowIdxType（int64_t， 计算输入）：表示expandedRowIdxOut使用的索引类型，取值为0、1。
    • 0：表示gather类型的索引。
    • 1：表示scatter类型的索引。
  • expandedXOut（aclTensor*，计算输出）：根据expertIdx进行扩展过的特征，要求为2D的Tensor，shape为(NUM_ROWS*K, H)。非量化场景下数据类型同x，量化场景下数据类型支持INT8，undefined要求为ND。前availableIdxNum*H个元素为有效数据，其余为无效数据。量化场景下，当x的数据类型为INT8时，输出值未定义。
  • expandedRowIdxOut（aclTensor*，计算输出）：expandedXOut和x的索引映射关系， 要求是一个1D的Tensor，Shape为(NUM_ROWS*K,)，数据类型支持INT32，undefined要求为ND。当rowIdxType为0时，有效元素与无效元素共存，其中无效元素由-1填充；当rowIdxType为1时，前availableIdxNum个元素有效，其余无效元素值未定义。
  • expertTokensCountOrCumsumOut（aclTensor*，计算输出）：数据类型支持INT64，undefined要求为ND。
    • 在expertTokensNumType为1的场景下，要求是1D的Tensor，表示activeExpertRangeOptional范围内每个expert对应的处理token的总数。shape为(expertEnd-expertStart,)。
    • 在expertTokensNumType为2的场景下，要求是2D的Tensor，shape为(expertNum, 2)，表示activeExpertRangeOptional范围内每个expert及其处理的非零token总数。有效元素对指expert_id在active_expert_range范围内且处理的token数不为0的元素对，这些有效元素对按顺序存放在Tensor头部。如果有效非零元素对的数量少于expert_num，其后会跟随一对(0,0)以表示有效元素对的结束。
  • expandedScaleOut（aclTensor*，计算输出）：数据类型支持FLOAT32，undefined要求为ND。
    • 非量化场景下，即quant_mode为-1，shape为(NUM_ROWS*K,)。当scaleOptional未输入时，输出值未定义。当scaleOptional输入时，输出表示一个1D的Tensor；当scaleOptional输入时，输出表示一个1D的Tensor，前availableIdxNum个元素为有效数据，其余为无效数据。
    • 动态量化场景下，即quant_mode为1，输出量化计算过程中scaleOptional的中间值，shape为(NUM_ROWS*K,)。输出表示一个1D的Tensor，前availableIdxNum个元素为有效数据，其余为无效数据，若x的数据类型为INT8，输出值未定义。
  • workspaceSize（uint64_t*，出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值

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

  [object Object]

aclnnMoeInitRoutingV3

• 参数说明：

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

• 返回值：

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

约束说明

该算子在部分产品型号下，支持两种性能模板。进入两种性能模板需要分别额外满足以下条件，不满足条件则进入通用模板：

• 支持性能模板的产品型号：

  • Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件
  • Atlas A3 训练系列产品/Atlas A3 推理系列产品

• 性能模板的约束条件：

  • 进入低时延性能模板需要同时满足以下条件：

    • x、expertIdx、scaleOptional输入Shape要求分别为：(1, 7168)、(1, 8)、(256, 7168)
    • x数据类型要求：BFLOAT16
    • 属性要求：activeExpertRangeOptional=[0,256]、 quantMode=1、expertTokensNumType=2、expertNum=256

  • 进入大batch性能模板需要同时满足以下条件：

    • NUM_ROWS范围为[384, 8192]
    • K=8
    • expertNum=256
    • expertEnd-expertStart<=32
    • quantMode=-1
    • rowIdxType=1
    • expertTokensNumType=1

调用示例

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