aclnnBinaryCrossEntropy

产品支持情况

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

功能说明

• 算子功能：计算self和target的二元交叉熵。

• 计算公式：

  $$\ell(self, target)= L = \{l_{1},...,l_{n}\}^{T}, \ell_{n} = - weight_{n}[target_{n}·log(self_{n}) + (1 - target_{n}·log(1-self_{n}))]$$

  当reduction不为None时：

  $$\ell(self, target) \begin{cases} mean(L), & if\ reduction = mean \\ sum(L), & if\ reduction = sum \\ \end{cases}$$

函数原型

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

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

aclnnBinaryCrossEntropyGetWorkspaceSize

• 参数说明：

  • self（aclTensor*, 计算输入）：表示预测的概率值，公式中的输入self，Device侧的Tensor。不支持undefined。undefined支持ND，取值在0~1之间。
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持BFLOAT16、FLOAT16、FLOAT32。
  • target（aclTensor*, 计算输入）：表示目标张量，公式中的输入target，Device侧的Tensor。不支持undefined。shape需要与self一致，undefined支持ND，取值在0~1之间。
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：数据类型与self一致，支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型与self一致，支持BFLOAT16、FLOAT16、FLOAT32。
  • weight（aclTensor*, 计算输入）：表示权重张量，公式中的输入weight，Device侧的Tensor。不支持undefined。shape需要与self一致，undefined支持ND，weight可以是nullptr，等价于所有权重值都是1。
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：数据类型与self一致，支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型与self一致，支持BFLOAT16、FLOAT16、FLOAT32。
  • reduction（int64_t, 计算输入）：表示规约方式，公式中的输入reduction，输出规约的枚举值，支持三种枚举值：当取值为0，即为Reduction::None；当取值为1，即为Reduction::Mean；当取值为2，即为Reduction::Sum。
  • out（aclTensor *, 计算输出）：表示计算输出，公式中的$\ell(self,target)$，如果reduction = None，shape与self一致，其他情况shape为[1]，undefined支持ND。
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：数据类型与self一致，支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型与self一致，支持BFLOAT16、FLOAT16、FLOAT32。
  • workspaceSize（uint64_t *, 出参）：返回需要在Device侧申请的workspace大小。

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

• 返回值：

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

  [object Object]

aclnnBinaryCrossEntropy

• 参数说明：

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

• 返回值：

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

约束说明

无

调用示例

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