aclnnKlDiv

产品支持情况

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

功能说明

• 算子功能：计算KL散度
• 计算公式：

  • 定义loss_pointwise，保存中间结果。

    $$loss\_pointwise_i=\begin{cases} NaN & \text{ if }&logTarget=false \text{ and } target_i <= 0, \\ target_i * \left ( \log{(target_i)}- \log{(self_i)} \right ) & \text{ if }& logTarget=false， \\ \exp^ {target_i} * \left ( target_i- \log{(self_i)} \right ) & \text{ else. } \end{cases}$$

  • out计算公式为：

    $$out=\begin{cases} \frac{\sum loss\_pointwise}{self.size(0)} & \text{ if }& reduction= 1, \\ \sum loss\_pointwise & \text{ elif }& reduction= 2,\\ loss\_pointwise & \text{ else. } \end{cases}$$

函数原型

每个算子分为undefined，必须先调用“aclnnKlDivGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnKlDiv”接口执行计算。

• aclnnStatus aclnnKlDivGetWorkspaceSize(const aclTensor *self, const aclTensor *target, int64_t reduction, bool logTarget, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnKlDiv(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnKlDivGetWorkspaceSize

• 参数说明：

  • self (aclTensor*,计算输入)：公式中的self。Device侧的aclTensor。且数据类型与target的数据类型需满足数据类型推导规则（参见undefined），shape需要与target满足undefined。支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT、FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT、FLOAT16
  • target (aclTensor*, 计算输入)：公式中的target。且数据类型与self的数据类型需满足数据类型推导规则（参见undefined），shape需要与self满足undefined。支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT、FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT、FLOAT16
  • reduction (int64_t，计算输入): 公式中的reduction，指定计算完loss_pointwise之后的操作。
    • 0：none，表示不做reduction操作。
    • 1：batchmean，表示对loss_pointwise取平均，再给out。
    • 2：sum，表示对loss_pointwise求和，再给out。
  • logTarget(bool，计算输入): 指定传入的target数据是否已经做过log操作。
  • out (aclTensor*，计算输出)：公式中的out。数据类型与self的数据类型需满足数据类型推导规则（参见undefined）。当reduction为 0 时，shape需要与self和target满足undefined。当reduction不为0时，shape固定为(1,)。undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT、FLOAT16、BFLOAT16
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT、FLOAT16
  • workspaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnKlDiv

• 参数说明：

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

• 返回值：

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

约束说明

无

调用示例

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