aclnnSoftMarginLoss

支持的产品型号

• Atlas 训练系列产品。
• Atlas A2训练系列产品。

接口原型

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

• aclnnStatus aclnnSoftMarginLossGetWorkspaceSize(const aclTensor *self, const aclTensor *target, int64_t reduction, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnSoftMarginLoss(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：计算输入self和目标target的二分类逻辑损失函数。reduction指定要应用到输出的缩减，支持 'none'、'mean'、'sum'。'none' 表示不应用reduction，'mean' 表示输出的总和将除以输出中的元素数，'sum' 表示输出将被求和。

• 计算公式：

  当reduction为'none'时：

  $$\text{out}(self,target)=L=log(1+\exp(-target[i]*self[i]))$$

  当reduction不为'none'时：

$$\text{out}(self,target)= \begin{cases} \operatorname{mean}(L),& \text{if reduction}= \text{'mean'}\\ \operatorname{sum}(L), & \text{if reduction} = \text{'sum'} \end{cases}$$

aclnnSoftMarginLossGetWorkspaceSize

• 参数说明：

  • self（const aclTensor*, 计算输入）：公式中的self，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品支持），shape需要与target满足。支持，支持ND。
  • target（const aclTensor*, 计算输入）：公式中的target，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品支持），shape需要与self满足。支持，支持ND。
  • reduction（int64_t，计算输入）：公式中的输入reduction，Host侧的整型，数据类型支持INT64。指定要应用到输出的缩减，支持 0('none') | 1('mean') | 2('sum')。'none' 表示不应用reduction，'mean' 表示输出的总和将除以输出中的元素数，'sum' 表示输出将被求和。
  • out（aclTensor*, 计算输出）：公式中的out，Device侧的aclTensor，数据类型支持FLOAT16、FLOAT、BFLOAT16（仅Atlas A2训练系列产品支持）。若reduction取值为'none'，则shape需要与self和target进行broadcast后的shape一致，否则out为scalar。支持，支持ND。
  • workspaceSize（uint64_t*, 出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**, 出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnSoftMarginLoss

• 参数说明：

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

• 返回值：

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

约束与限制

无

调用示例

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