aclnnBernoulliTensor&aclnnInplaceBernoulliTensor

支持的产品型号

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

接口原型

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

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

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

  • aclnnStatus aclnnBernoulliTensorGetWorkspaceSize(const aclTensor* self, const aclTensor* prob, int64_t seed, int64_t offset, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnBernoulliTensor(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceBernoulliTensorGetWorkspaceSize(const aclTensor* selfRef, const aclTensor* prob, int64_t seed, int64_t offset, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnInplaceBernoulliTensor(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

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

• 计算公式：

$$out∼Bernoulli(prob)$$

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

aclnnBernoulliTensorGetWorkspaceSize

• 参数说明：

  • self（aclTensor*，计算输入）：用于指定输出out的shape，Device侧的aclTensor，shape支持0-8维，shape需要与out的shape一致，支持undefined，undefined支持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（aclTensor*，计算输入）：公式中的prob，Device侧的aclTensor，满足0≤prob≤1，shape支持0-8维，支持undefined，且undefined需要与self一致。
    • 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，shape支持0-8维，shape需要与self的shape一致，支持undefined，undefined支持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：返回状态码，具体参见undefined。

  [object Object]

aclnnBernoulliTensor

• 参数说明：

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

• 返回值：

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

aclnnInplaceBernoulliTensorGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*，计算输入）：公式中的out，Device侧的aclTensor，shape支持0-8维，支持undefined，undefined支持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（aclTensor*，计算输入）：公式中的prob，Device侧的aclTensor，满足0≤prob≤1，shape支持0-8维，支持undefined，undefined支持ND。
    • 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：返回状态码，具体参见undefined。

  [object Object]

aclnnInplaceBernoulliTensor

• 参数说明：

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

• 返回值：

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

约束与限制

• 输入prob的元素值域必须为[0, 1]。
• 当输入prob的shape与输入self/selfRef的shape不一致时，只计算两者可对应元素的数据，其余数据的行为未定义。例如：当prob的shape为[4, 2]，self的shape为[4, 4]时，只计算前8个元素，输出的shape为[4, 4]；当prob的shape为[4, 4, 2], self的shape为[4, 4]时，只计算前16个元素，输出的shape为[4, 4]。

调用示例

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

aclnnBernoulliTensor

aclnnInplaceBernoulliTensor