aclnnStatelessExponentialTensor

产品支持情况

Ascend 950PR&950DT系列产品：支持

Atlas A3系列产品：不支持

Atlas A2系列产品：不支持

Atlas 200I/500 A2推理产品：不支持

Atlas推理系列产品：不支持

Atlas训练系列产品：不支持

功能说明

接口功能：按照给定的种子和偏移量，生成服从指数分布的随机数，以in-place方式写入输入张量。使用Philox4x32-10计数器式伪随机数生成器，具有确定性。
计算公式：
$\text{Philox}(\text{seed}, \text{offset}, \text{index})$ $selfi=−1lambdln⁡(ui)self_i = -\frac{1}{\text{lambd}} \ln(u_i)$
其中 $u_i$ 为通过Philox4x32-10生成的均匀分布随机数， $lambd\text{lambd}$ 为指数分布的速率参数。

函数原型

每个算子分为两段式接口，必须先调用"aclnnStatelessExponentialTensorGetWorkspaceSize"接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用"aclnnStatelessExponentialTensor"接口执行计算。

aclnnStatus aclnnStatelessExponentialTensorGetWorkspaceSize(
  aclTensor*       self,
  const aclTensor* seedTensor,
  const aclTensor* offsetTensor,
  int64_t          offset,
  double           lambd,
  uint64_t*        workspaceSize,
  aclOpExecutor**  executor)

aclnnStatus aclnnStatelessExponentialTensor(
  void          *workspace,
  uint64_t       workspaceSize,
  aclOpExecutor *executor,
  aclrtStream    stream)

aclnnStatelessExponentialTensorGetWorkspaceSize

参数说明：

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
self	输入/输出	输入张量，同时也是输出张量。算子将生成的指数分布随机数写入该张量。	shape支持0到8维。	FLOAT、FLOAT16、BFLOAT16	ND	0-8	√
seedTensor	输入	随机数生成器的种子，以Tensor形式传入，影响生成的随机数序列。	维度为1，元素个数为1。	INT64	ND	1	x
offsetTensor	输入	随机数生成器的偏移量，以Tensor形式传入，影响生成的随机数序列的位置。	维度为1，元素个数为1，取值约束：offset % 4 == 0，例如可以取0、4、8 ...，不满足约束会导致精度无法对标竞品。	INT64	ND	1	x
offset	输入	作为offsetTensor的累加量。	与offsetTensor累加后，需要满足(offset + offsetTensor) % 4 == 0。	INT64	-	-	-
lambd	输入	指数分布的速率参数。	取值范围为大于0的实数。lambd在算子内部以fp32精度参与计算，极小值可能在double转fp32后下溢为0，等同于小于等于0，将被拒绝。	DOUBLE	-	-	-
workspaceSize	输出	返回需要在Device侧申请的workspace大小。	-	INT64	-	-	-
executor	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

返回值：

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

第一段接口完成入参校验，出现如下场景时报错：

返回码	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	传入的self、seedTensor、offsetTensor为空指针。
ACLNN_ERR_PARAM_INVALID	161002	self的数据类型不在支持的范围之内。
		seedTensor、offsetTensor的数据类型不是INT64。
		lambd的值小于等于0，或为fp32无法表示的极小值（double转fp32后下溢为0）。
		seedTensor、offsetTensor的维度不为1。
self维度超过8维。

aclnnStatelessExponentialTensor

参数说明：

参数名	输入/输出	描述
workspace	输入	在Device侧申请的workspace内存地址。
workspaceSize	输入	在Device侧申请的workspace大小，由第一段接口aclnnStatelessExponentialTensorGetWorkspaceSize获取。
executor	输入	op执行器，包含了算子计算流程。
stream	输入	指定执行任务的Stream。

返回值：

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

约束说明

确定性计算：
- aclnnStatelessExponentialTensor为确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_stateless_exponential.h"

#define CHECK_RET(cond, return_expr) \
  do {                               \
    if (!(cond)) {                   \
      return_expr;                   \
    }                                \
  } while (0)

#define LOG_PRINT(message, ...)     \
  do {                              \
    printf(message, ##__VA_ARGS__); \
  } while (0)

int64_t GetShapeSize(const std::vector<int64_t>& shape) {
  int64_t shapeSize = 1;
  for (auto i : shape) {
    shapeSize *= i;
  }
  return shapeSize;
}

int Init(int32_t deviceId, aclrtStream* stream) {
  // 固定写法，资源初始化
  auto ret = aclInit(nullptr);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
  ret = aclrtSetDevice(deviceId);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
  ret = aclrtCreateStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);
  return 0;
}

template <typename T>
int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr,
                    aclDataType dataType, aclTensor** tensor) {
  auto size = GetShapeSize(shape) * sizeof(T);
  // 调用aclrtMalloc申请device侧内存
  auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);
  // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上
  ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

  // 计算连续tensor的strides
  std::vector<int64_t> strides(shape.size(), 1);
  for (int64_t i = shape.size() - 2; i >= 0; i--) {
    strides[i] = shape[i + 1] * strides[i + 1];
  }

  // 调用aclCreateTensor接口创建aclTensor
  *tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND,
                            shape.data(), shape.size(), *deviceAddr);
  return 0;
}

int main() {
  // 1.（固定写法）device/stream初始化，参考acl API手册
  // 根据自己的实际device填写deviceId
  int32_t deviceId = 0;
  aclrtStream stream;
  auto ret = Init(deviceId, &stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

  // 2. 构造输入与输出，需要根据API的接口自定义构造
  std::vector<int64_t> selfShape = {4, 2};
  std::vector<int64_t> seedShape = {1};
  std::vector<int64_t> offsetShape = {1};
  void* selfDeviceAddr = nullptr;
  void* seedDeviceAddr = nullptr;
  void* offsetDeviceAddr = nullptr;
  aclTensor* self = nullptr;
  aclTensor* seedTensor = nullptr;
  aclTensor* offsetTensor = nullptr;
  std::vector<float> selfHostData(8, 0);
  std::vector<int64_t> seedHostData = {42};
  std::vector<int64_t> offsetHostData = {0};
  double lambd = 1.0;
  int64_t offset = 0;
  // 创建self aclTensor（in-place，既是输入也是输出）
  ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建seedTensor aclTensor
  ret = CreateAclTensor(seedHostData, seedShape, &seedDeviceAddr, aclDataType::ACL_INT64, &seedTensor);
  CHECK_RET(ret == ACL_SUCCESS, return ret);
  // 创建offsetTensor aclTensor
  ret = CreateAclTensor(offsetHostData, offsetShape, &offsetDeviceAddr, aclDataType::ACL_INT64, &offsetTensor);
  CHECK_RET(ret == ACL_SUCCESS, return ret);

  // 3. 调用CANN算子库API，需要修改为具体的API名称
  uint64_t workspaceSize = 0;
  aclOpExecutor* executor;
  // 调用aclnnStatelessExponentialTensor第一段接口
  ret = aclnnStatelessExponentialTensorGetWorkspaceSize(self, seedTensor, offsetTensor, offset, lambd, &workspaceSize,
                                                        &executor);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnStatelessExponentialTensorGetWorkspaceSize failed. ERROR: %d\n", ret);
            return ret);
  // 根据第一段接口计算出的workspaceSize申请device内存
  void* workspaceAddr = nullptr;
  if (workspaceSize > 0) {
    ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
  }
  // 调用aclnnStatelessExponentialTensor第二段接口
  ret = aclnnStatelessExponentialTensor(workspaceAddr, workspaceSize, executor, stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnStatelessExponentialTensor failed. ERROR: %d\n", ret); return ret);

  // 4.（固定写法）同步等待任务执行结束
  ret = aclrtSynchronizeStream(stream);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);

  // 5. 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
  // self为in-place输出，结果直接写入self的device内存
  auto size = GetShapeSize(selfShape);
  std::vector<float> resultData(size, 0);
  ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), selfDeviceAddr,
                    size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
  for (int64_t i = 0; i < size; i++) {
    LOG_PRINT("result[%ld] is: %f\n", i, resultData[i]);
  }

  // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
  aclDestroyTensor(self);
  aclDestroyTensor(seedTensor);
  aclDestroyTensor(offsetTensor);

  // 7. 释放device资源，需要根据具体API的接口定义修改
  aclrtFree(selfDeviceAddr);
  aclrtFree(seedDeviceAddr);
  aclrtFree(offsetDeviceAddr);
  if (workspaceSize > 0) {
    aclrtFree(workspaceAddr);
  }
  aclrtDestroyStream(stream);
  aclrtResetDevice(deviceId);
  aclFinalize();
  return 0;
}