aclnnNLLLoss

支持的产品型号

• Atlas 推理系列产品。
• Atlas 训练系列产品。
• Atlas A2训练系列产品/Atlas 800I A2推理产品。

接口原型

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

• aclnnStatus aclnnNLLLossGetWorkspaceSize(const aclTensor *self, const aclTensor *target, const aclTensor *weight, int64_t reduction, int64_t ignoreIndex, aclTensor *out, aclTensor *totalWeightOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnNLLLoss(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：计算负对数似然损失值。

• 计算公式：

  当reduction为none时，

  $$\ell(x, y) = L = \{l_1,\dots,l_N\}^\top, \quad l_n = - w_{y_n} x_{n,y_n}, \quad w_{c} = \text{weight}[c] \cdot \mathbb{1}\{c \not= \text{ignoreIndex}\},$$

  其中$x$是self, $y$是target, $w$是weight，$N$是batch的大小. 如果reduction不是'none' , 那么：

  $$\ell(x, y) = \begin{cases} \sum_{n=1}^N \frac{1}{\sum_{n=1}^N w_{y_n}} l_n, & \text{if reduction} = \text{`mean';}\\ \sum_{n=1}^N l_n, & \text{if reduction} = \text{`sum'.} \end{cases}$$ $$totalWeight = \sum_{n=1}^N w_{y_n}$$

aclnnNLLLossGetWorkspaceSize

• 参数说明：

  • self(aclTensor*, 计算输入)：公式中的输入self，shape为(N,C)或者(C)，其中N表示batch size，C表示类别数。数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），支持undefined, undefined支持ND 。

  • target(aclTensor*, 计算输入)：公式中的输入target，表示真实标签，当self的shape为(N,C)时，target的shape为(N)，当self的shape为(C)时，target的shape为()，其中每个元素的取值范围是[0, C - 1]。数据类型支持INT64、UINT8、INT32 ，支持undefined， undefined支持ND 。

  • weight(aclTensor*, 计算输入)：公式中的输入weight，表示每个类别的缩放权重，shape为(C)。数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），支持undefined，undefined支持ND, 和self的数据类型要保持一致。

  • reduction(int64_t*, 计算输入)：公式中的reduction，指定要应用到输出的缩减，支持 0('none') | 1('mean') | 2('sum')。'none' 表示不应用减少，'mean' 表示输出的总和将除以输出中的元素数，'sum' 表示输出将被求和。

  • ignoreIndex(int64_t*, 计算输入)：公式中的ignoreIndex，指定一个被忽略且不影响输入梯度的目标值。

  • out(aclTensor*, 计算输出)：公式中的out，当reduction为0（'none'）且self的shape为2维时, out shape为(N,), 否则为(1,), 当数据类型和self保持一致，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）。undefined支持ND。

  • totalWeightOut(aclTensor*, 计算输出)：公式中的totalWeightOut，shape为(1,)，数据类型和self保持一致，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）。undefined支持ND。

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

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

• 返回值：

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

aclnnNLLLoss

• 参数说明：

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

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

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

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

• 返回值：

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

约束与限制

无。

调用示例

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