aclnnFusedCrossEntropyLossWithMaxSum

产品支持情况

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

功能说明

• 算子功能：本算子是词汇表并行场景下交叉熵计算模块的一部分，解决超大规模词汇表下的显存和计算效率问题，当前部分为计算loss与softMax的结果。
• 计算公式： $$ lossOut = log(sum_exp_logits) - predicted_logits $$ $$ softMaxOutOptional = exp(vocab_parallel_logits -logits_max.unsqueeze(dim = -1)) \ sum_exp_logits.unsqueeze(dim = -1) $$

函数原型

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

• aclnnStatus aclnnFusedCrossEntropyLossWithMaxSumGetWorkspaceSize(const aclTensor* logitsMax, const aclTensor* sumExpLogits, const aclTensor* predictedLogits, float labelSmoothing, const aclTensor* inputOptional, const aclTensor* weightOptional, const aclTensor* vocabParallelLogitsOptional, aclTensor* lossOut, aclTensor* softMaxOutOptional, uint64_t* workspaceSize, aclOpExecutor** executor);
• aclnnStatus aclnnFusedCrossEntropyLossWithMaxSum(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

aclnnFusedCrossEntropyLossWithMaxSumGetWorkspaceSize

• 参数说明：

  • logitsMax(aclTensor*，计算输入)：matmul计算后各行的最大值，公式中的logitsMax。Device侧的aclTensor，支持undefined，undefined支持ND，数据维度支持1维，数据类型支持FLOAT。

  • sumExpLogits(aclTensor*，计算输入)：matmul计算结果与其各行的最大值作差后exp的结果。公式中的sumExpLogits。Device侧的aclTensor，支持undefined，undefined支持ND，数据维度支持1维，shape与logitsMax一致，数据类型支持FLOAT。

  • predictedLogits(aclTensor*，计算输入)：matmul计算结果与各行的最大值做差后晒徐的结果。公式中的predictedLogits。Device侧的aclTensor，支持undefined，undefined支持ND，数据维度支持1维，shape与logitsMax一致，数据类型支持FLOAT。

  • labelSmoothing(float，计算输入)：标签平滑系数，用于缓解过拟合，当前只支持0。

  • inputOptional(aclTensor*，计算输入)：matmul输入左矩阵。Device侧的aclTensor，支持undefined，undefined支持ND，当前只支持输入空指针。

  • weightOptional(aclTensor*，计算输入)：matmul输入右矩阵。权重矩阵。Device侧的aclTensor，支持undefined，undefined支持ND，当前只支持输入空指针。

  • vocabParallelLogitsOptional(aclTensor*，计算输入)：matmul计算结果。公式中的vocabParallelLogits。Device侧的aclTensor，支持undefined，undefined支持ND，数据维度支持2维，shape第1维需要与logitsMax第1维一致。数据类型支持FLOAT16，BFLOAT16。

  • lossOut(aclTensor*，计算输出)：中间变量。公式中的loss，Device侧的aclTensor，shape与logitsMax一致，undefined支持ND，数据类型支持FLOAT。

  • softMaxOutOptional(aclTensor*，计算输出)：中间变量。公式中的vocabParallelLogits，Device侧的aclTensor，shape与vocabParallelLogitsOptional一致，undefined支持ND，数据类型支持FLOAT。

  • workspaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。

  • executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnFusedCrossEntropyLossWithMaxSum

• 参数说明：

  • workspace(void*，入参)：在Device侧申请的workspace内存地址。

  • workspaceSize(uint64_t，入参)：在Device侧申请的workspace大小，由第一段接口aclnnFusedCrossEntropyLossWithMaxSumGetWorkspaceSize获取。

  • executor(aclOpExecutor*，入参)：op执行器，包含了算子计算流程。

  • stream(aclrtStream，入参)：指定执行任务的Stream。

• 返回值：

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

约束说明

无。

调用示例

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