aclnnRange
支持的产品型号
- Atlas 推理系列产品。
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
- Atlas 200/500 A2推理产品。
接口原型
每个算子分为两段式接口,必须先调用“aclnnRangeGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnRange”接口执行计算。
aclnnStatus aclnnRangeGetWorkspaceSize(const aclScalar *start, const aclScalar *end, const aclScalar *step, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnRange(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
功能描述
算子功能:从start起始到end结束按照step的间隔取值,并返回大小为 的1维张量。其中,步长step是张量中相邻两个值的间隔。
计算公式:
aclnnRangeGetWorkspaceSize
参数说明:
start(aclScalar):获取值的范围的起始位置,需要满足在step大于0时输入的start小于end,或者step小于0时输入的start大于end。
- Atlas 推理系列产品、Atlas 训练系列产品、Atlas 200/500 A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
end(aclScalar):获取值的范围的结束位置,需要满足在step大于0时输入的start小于end,或者step小于0时输入的start大于end。
- Atlas 推理系列产品、Atlas 训练系列产品、Atlas 200/500 A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
step(aclScalar):获取值的步长,需要满足step不等于0, 即start不等于end。
- Atlas 推理系列产品、Atlas 训练系列产品、Atlas 200/500 A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、UINT8、INT8、INT16、INT32、INT64、BOOL、BFLOAT16。
out(aclTensor):指定的输出Tensor;数据类型支持FLOAT16、FLOAT、DOUBLE、BFLOAT16(仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持)、INT32、INT64,数据格式支持ND。
- Atlas 推理系列产品、Atlas 训练系列产品、Atlas 200/500 A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT16、FLOAT、DOUBLE、BFLOAT16。
workspaceSize(uint64_t*, 出参):返回需要在Device侧申请的workspace大小。
executor(aclOpExecutor**, 出参):返回op执行器,包含了算子计算流程。
返回值:
aclnnStatus:返回状态码,具体参见aclnn返回码。
161001 (ACLNN_ERR_PARAM_NULLPTR):1. 传入的start、end、step或out是空指针。
161002 (ACLNN_ERR_PARAM_INVALID):1. start、end、step或out的数据类型不在支持的范围之内。
2. start、end、step不满足range的运算逻辑,即在step大于0时输入的start大于end,或者step小于0时输入的start小于end, 或者start等于end。
561103 (TILING_ERR_PARAM_INVALID): 1. 传入的输出Size小于Tiling按照out数据类型计算的输出Size时,会在Tiling侧进行校验拦截。
aclnnRange
参数说明:
workspace(void *, 入参):在Device侧申请的workspace内存地址。
workspaceSize(uint64_t, 入参):在Device侧申请的workspace大小,由第一段接口aclnnRangeGetWorkspaceSize获取。
executor(aclOpExecutor *, 入参):op执行器,包含了算子计算流程。
stream(aclrtStream, 入参):指定执行任务的AscendCL Stream流。
返回值:
aclnnStatus:返回状态码,具体参见aclnn返回码。
约束与限制
Warning:输入数据类型为float时,受限于数据类型本身的精度误差,对out的输出大小计算请采用float。如果用户采用double计算输出, double结果可能小于float结果,此时Tiling侧会进行校验拦截。
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_range.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)
#define ACLNN_ERR_PARAM_NULLPTR 161001
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) {
// 固定写法,AscendCL初始化
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初始化,参考AscendCL对外接口列表
// 根据自己的实际device填写deviceId
int32_t deviceId = 0;
aclrtStream stream;
auto ret = Init(deviceId, &stream);
CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. 构造输入与输出,需要根据API的接口自定义构造
std::vector<int64_t> outShape = {8,};
void* outDeviceAddr = nullptr;
aclScalar* start = nullptr;
aclScalar* end = nullptr;
aclScalar* step = nullptr;
aclTensor* out = nullptr;
std::vector<float> outHostData = {0, 0, 0, 0, 0, 0, 0, 0};
float startValue = 1.31f;
float endValue = 9.97f;
float stepValue = 1.17f;
// 创建start aclScalar
start = aclCreateScalar(&startValue, aclDataType::ACL_FLOAT);
CHECK_RET(start != nullptr, LOG_PRINT("ACLNN_ERR_PARAM_NULLPTR: start is null\n"); return ACLNN_ERR_PARAM_NULLPTR);
// 创建end aclScalar
end = aclCreateScalar(&endValue, aclDataType::ACL_FLOAT);
CHECK_RET(end != nullptr, LOG_PRINT("ACLNN_ERR_PARAM_NULLPTR: end is null\n"); return ACLNN_ERR_PARAM_NULLPTR);
// 创建step aclScalar
step = aclCreateScalar(&stepValue, aclDataType::ACL_FLOAT);
CHECK_RET(step != nullptr, LOG_PRINT("ACLNN_ERR_PARAM_NULLPTR: step is null\n"); return ACLNN_ERR_PARAM_NULLPTR);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnRange第一段接口
ret = aclnnRangeGetWorkspaceSize(start, end, step, out, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRangeGetWorkspaceSize 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);
}
// 调用aclnnRange第二段接口
ret = aclnnRange(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRange 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侧
auto size = GetShapeSize(outShape);
std::vector<float> resultData(size, 0);
ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr,
size * sizeof(float), 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
aclDestroyScalar(start);
aclDestroyScalar(end);
aclDestroyScalar(step);
aclDestroyTensor(out);
// 7. 释放device 资源
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}