aclnnBernoulli&aclnnInplaceBernoulli

支持的产品型号

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

接口原型

• aclnnBernoulli和aclnnInplaceBernoulli实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

  • aclnnBernoulli：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceBernoulli：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。

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

  • aclnnStatus aclnnBernoulliGetWorkspaceSize(const aclTensor* self, const aclScalar* prob, int64_t seed, int64_t offset, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnBernoulli(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceBernoulliGetWorkspaceSize(const aclTensor* selfRef, const aclScalar* prob, int64_t seed, int64_t offset, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnInplaceBernoulli(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

• 算子功能： 从伯努利分布中提取二进制随机数（0 或 1），prob为生成二进制随机数的概率，输入的张量用于指定shape。

• 计算公式：

$$out∼Bernoulli(prob)$$

其中，当使用aclnnBernoulli时，公式中的prob对应第一段接口原型中的prob，公式中的out对应第一段接口原型中的out；当使用aclnnInplaceBernoulli时，公式中的prob对应第一段接口原型中的prob，公式中的out对应第一段接口原型中的selfRef。

aclnnBernoulliGetWorkspaceSize

• 参数说明：

  • self（aclTensor*，计算输入）：用于指定输出out的shape，Device侧的aclTensor，数据类型需要与out一致，shape支持0-8维，且shape需要与out一致，支持，支持ND。
    • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
  • prob（aclScalar*，计算输入）：公式中的prob，Host侧的aclScalar，满足$0≤prob≤1$。
    • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT、DOUBLE。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、DOUBLE、BFLOAT16。
  • seed（int64_t，计算输入）：Host侧的整型，设置随机数生成器的种子。
  • offset（int64_t，计算输入）：Host侧的整型，设置随机数偏移量。
  • out（aclTensor*，计算输出）：公式中的out，Device侧的aclTensor，数据类型需要与self一致，shape支持0-8维，且shape需要与self一致，支持，支持ND。
    • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnBernoulli

• 参数说明：

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

• 返回值：

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

aclnnInplaceBernoulliGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*，计算输入/输出）：公式中的out，Device侧的aclTensor，shape支持0-8维，支持，支持ND。
    • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
  • prob（aclScalar*，计算输入）：公式中的prob，Host侧的aclScalar，满足$0≤prob≤1$。
    • Atlas 训练系列产品：数据类型支持FLOAT16、FLOAT、DOUBLE。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT16、FLOAT、DOUBLE、BFLOAT16。
  • seed（int64_t，计算输入）：Host侧的整型，设置随机数偏移量。
  • offset（int64_t，计算输入）：Host侧的整型，设置随机数偏移量。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnInplaceBernoulli

• 参数说明：

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

• 返回值：

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

约束与限制

无。

调用示例

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

aclnnBernoulli

aclnnInplaceBernoulli