aclnnApplyTopKTopP

产品支持情况

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

功能说明

• 算子功能：对原始输入logits进行top-k和top-p采样过滤。
• 计算公式：
  • 对输入logits按最后一轴进行升序排序，得到对应的排序结果sortedValue和sortedIndices。 $$sortedValue, sortedIndices = sort(logits, dim=-1, descend=false, stable=true)$$
  • 计算保留的阈值（第k大的值）。 $$topKValue[b][v] = sortedValue[b][sortedValue.size(1) - k[b]]$$
  • 生成top-k需要过滤的mask。 $$topKMask = sortedValue < topKValue$$
  • 通过topKMask将小于阈值的部分置为-inf。$$sortedValue[b][v] = \begin{cases} -inf & \text{topKMask[b][v]=true}\\ sortedValue[b][v] & \text{topKMask[b][v]=false} \end{cases}$$
  • 通过softmax将经过top-k过滤后的数据按最后一轴转换为概率分布。 $$probsValue = softmax(sortedValue, dim=-1)$$
  • 按最后一轴计算累计概率（从最小的概率开始累加） $$probsSum = cumsum(probsValue, dim=-1)$$
  • 生成top-p的mask，累计概率小于等于1-p的位置需要过滤掉，并保证每个batch至少保留一个元素。 $$topPMask[b][v] = probsSum[b][v] <= 1-p[b]$$ $$topPMask[b][-1] = false$$
  • 通过topPMask将小于阈值的部分置为-inf。$$sortedValue[b][v] = \begin{cases} -inf & \text{topPMask[b][v]=true}\\ sortedValue[b][v] & \text{topPMask[b][v]=false} \end{cases}$$
  • 将过滤后的结果按sortedIndices还原到原始顺序。 $$out[b][v] = sortedValue[b][sortedIndices[b][v]]$$ 其中$0 \le b \lt logits.size(0), 0 \le v \lt logits.size(1)$。

函数原型

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

• aclnnStatus aclnnApplyTopKTopPGetWorkspaceSize(const aclTensor* logits, const aclTensor* p, const aclTensor* k, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnApplyTopKTopP(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

aclnnApplyTopKTopPGetWorkspaceSize

• 参数说明：

  • logits(aclTensor*, 计算输入)：表示需要处理的数据，公式中的logits，Device侧的aclTensor。数据类型支持BFLOAT16、FLOAT16、FLOAT32，shape支持2维，支持undefined，支持空tensor，undefined支持ND。
  • p(aclTensor*, 计算输入)：表示top-p的阈值，公式中的p，值域为[0, 1]，Device侧的aclTensor。数据类型支持BFLOAT16、FLOAT16、FLOAT32，数据类型需要与logits一致，shape支持1维且需要与logits的首轴相同，支持undefined，支持空tensor，undefined支持ND。
  • k(aclTensor*, 计算输入)：表示top-k的阈值，公式中的k，值域为[1, 1024]，且最大值需要小于等于logits.size(1)，Device侧的aclTensor。数据类型支持INT32，shape支持1维且需要与logits的首轴相同，支持undefined，支持空tensor，undefined支持ND。
  • out(aclTensor*, 计算输出)：表示过滤后的数据，公式中的out，Device侧的aclTensor。数据类型支持BFLOAT16、FLOAT16、FLOAT32，数据类型需要与logits一致，shape支持2维且需要与logits一致，支持undefined，undefined支持ND。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnApplyTopKTopP

• 参数说明：

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

• 返回值：

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

约束说明

无。

调用示例

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