aclnnDropoutGenMaskV2
产品支持情况
| 产品 | 是否支持 |
|---|---|
| Ascend 950PR/Ascend 950DT | √ |
| Atlas A3 训练系列产品/Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品/Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | × |
| Atlas 推理系列产品 | √ |
| Atlas 训练系列产品 | √ |
功能说明
训练过程中，按照概率prob生成mask，用于元素置零。
函数原型
每个算子分为两段式接口，必须先调用“aclnnDropoutGenMaskV2GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnDropoutGenMaskV2”接口执行计算。
aclnnStatus aclnnDropoutGenMaskV2GetWorkspaceSize(
const aclIntArray* shape,
double prob,
int64_t seed,
int64_t offset,
aclDataType probDataType,
aclTensor* out,
uint64_t* workspaceSize,
aclOpExecutor** executor)
aclnnStatus aclnnDropoutGenMaskV2(
void* workspace,
uint64_t workspaceSize,
aclOpExecutor* executor,
aclrtStream stream)
aclnnDropoutGenMaskV2GetWorkspaceSize
-
参数说明：
参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续tensor shape（aclIntArray*） 输入 表示待处理的数据量。 - - - - - prob（double） 输入 元素置零的概率。 数值的值域为[0, 1]。 DOUBLE - - - seed（int64_t） 输入 随机数的种子，影响生成的随机数序列。 - INT64 - - - offset（int64_t） 输入 随机数的偏移量，它影响生成的随机数序列的位置。 - INT64 - - - probDataType（aclDataType） 输入 表示输入张量的数据类型。 - FLOAT、FLOAT16、BFLOAT16 - - - out（aclTensor*） 输出 输出的tensor。bit类型并使用UINT8类型存储的mask数据。 shape需要为(align(input的元素个数,128)/8)。 UINT8 ND 1 √ workspaceSize（uint64_t*） 输出 返回需要在Device侧申请的workspace大小。 - - - - - executor（aclOpExecutor**） 输出 返回op执行器，包括了算子计算流程。 - - - - - - Atlas 训练系列产品：数据类型不支持BFLOAT16。
-
返回值：
aclnnStatus: 返回状态码，具体参见aclnn返回码。
第一段接口完成入参校验，出现以下场景时报错：
返回码 错误码 描述 ACLNN_ERR_PARAM_NULLPTR 161001 传入的shape、out为空指针。 ACLNN_ERR_PARAM_INVALID 161002 out的数据类型不在支持的范围之内。 prob的值不在0和1之间。 out的shape不满足条件。
aclnnDropoutGenMaskV2
-
参数说明：
参数名 输入/输出 描述 workspace 输入 在Device侧申请的workspace内存地址。 workspaceSize 输入 在Device侧申请的workspace大小，由第一段接口aclnnDropoutGenMaskV2GetWorkspaceSize获取。 executor 输入 op执行器，包含了算子计算流程。 stream 输入 指定执行任务的Stream。 -
返回值：
aclnnStatus: 返回状态码，具体参见aclnn返回码。
约束说明
- 确定性计算：
- aclnnDropoutGenMaskV2默认确定性实现。
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_dropout_gen_mask.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对外接口列表
// 根据自己的实际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> outShape = {16};
void* outDeviceAddr = nullptr;
aclTensor* out = nullptr;
std::vector<uint8_t> outHostData(16, 0);
double p = 0.5;
int64_t seed = 1234;
int64_t offset = 0;
aclDataType probDataType = aclDataType::ACL_FLOAT;
aclIntArray* shapeArray = aclCreateIntArray(selfShape.data(), 2);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_UINT8, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用aclnnDropoutGenMaskV2生成mask
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnDropoutGenMaskV2第一段接口
ret = aclnnDropoutGenMaskV2GetWorkspaceSize(shapeArray, p, seed, offset, probDataType, out, &workspaceSize,
&executor);
CHECK_RET(ret == ACL_SUCCESS,
LOG_PRINT("aclnnDropoutGenMaskV2GetWorkspaceSize 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);
}
// 调用aclnnDropoutGenMaskV2第二段接口
ret = aclnnDropoutGenMaskV2(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDropoutGenMaskV2 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的接口定义修改
auto size = GetShapeSize(outShape);
std::vector<uint8_t> resultData(size, 0);
ret = aclrtMemcpy(resultData.data(), size, outDeviceAddr, size, 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: %u\n", i, resultData[i]);
}
// 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
aclDestroyTensor(out);
// 7. 释放Device资源，需要根据具体API的接口定义修改
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}