--- title: aclnnDropoutV3 description: "[? 查看源码](https://gitcode.com/cann/ops-math/tree/master/random/drop_out_v3)" url: https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/API/aolapi/context/ops-math/aclnnDropoutV3.md sourcePath: /source/zh/CANNCommunityEdition/920beta1/API/aolapi/context/ops-math/aclnnDropoutV3.md indexId: 2b3285572045b6ef46c57aab1d82f7cfddf70f3734baf386eac890f478f6d8e986 --- # aclnnDropoutV3 [? 查看源码](https://gitcode.com/cann/ops-math/tree/master/random/drop_out_v3) ## 产品支持情况 - Ascend 950PR/Ascend 950DT：支持 - Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持 - Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持 - Atlas 200I/500 A2 推理产品：不支持 - Atlas 推理系列产品：不支持 - Atlas 训练系列产品：不支持 ## 功能说明 - 接口功能：训练过程中，按照概率p随机将输入中的元素置零，并将输出按照1/(1-p)的比例缩放。 - 计算公式： $$ out_i=\begin{cases}0,&\text { with probability }p \\frac{1}{1-p}input_i,&\text { with probability }1-p\end{cases} $$ ## 函数原型 每个算子分为两段式接口，必须先调用“aclnnDropoutV3GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnDropoutV3”接口执行计算。 ```Cpp aclnnStatus aclnnDropoutV3GetWorkspaceSize( const aclTensor* input, const aclTensor* optionalNoiseShape, double p, int64_t seed, int64_t offset, aclTensor* out, aclTensor* maskOut, uint64_t* workspaceSize, aclOpExecutor** executor) ``` ```Cpp aclnnStatus aclnnDropoutV3( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream) ``` ## aclnnDropoutV3GetWorkspaceSize - **参数说明：** | 参数名 | 输入/输出 | 描述 | 使用说明 | 数据类型 | 数据格式 | 维度(shape) | 非连续Tensor | | --- | --- | --- | --- | --- | --- | --- | --- | | input | 输入 | 公式中的输入input。 | shape支持0到8维。 | FLOAT、FLOAT16、BFLOAT16 | ND | 0-8 | √ | | optionalNoiseShape | 输入 | 预留参数，入参请用空指针代替。 | - | INT64 | ND | 0 | √ | | p | 输入 | 元素置零的概率。 | 取值范围为[0, 1] | DOUBLE | - | - | - | | seed | 输入 | 随机数的种子，影响生成的随机数序列。 | - | INT64 | - | - | - | | offset | 输入 | 随机数的偏移量，它影响生成的随机数序列的位置。 | 取值约束：offset % 4 == 0，例如可以取0、4、8 ...，不满足约束会调用失败 | INT64 | - | - | - | | out | 输出 | 公式中的out | 数据类型需要是input可转换的数据类型，shape需要与input一致。 | FLOAT、FLOAT16、BFLOAT16 | ND | 0-8 | √ | | maskOut | 输出 | bit类型并使用UINT8类型存储的mask数据。 | 元素个数需要为(align(input的元素个数,128)/8)；当p=0或p=1场景下，不对传入的maskOut做任何处理；其它场景下以给定的p为置零概率生成mask。 | UINT8 | ND | 1 | √ | | workspaceSize | 输出 | 返回需要在Device侧申请的workspace大小。 | - | INT64 | - | - | - | | executor | 输出 | 返回op执行器，包含了算子计算流程。 | - | - | - | - | - | - **返回值：** aclnnStatus：返回状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现如下场景时报错： | 返回码 | 错误码 | 描述 | | --- | --- | --- | | ACLNN_ERR_PARAM_NULLPTR | 161001 | 传入的input、out、maskOut为空指针。 | | ACLNN_ERR_PARAM_INVALID | 161002 | input、out、maskOut的数据类型不在支持的范围之内。 | | p的值不在0和1之间。 | - | - | | input维度超过8维。 | - | - | | input和out的shape不一致。 | - | - | | maskOut的shape不满足条件。 | - | - | ## aclnnDropoutV3 - **参数说明：** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | workspace | 输入 | 在Device侧申请的workspace内存地址。 | | workspaceSize | 输入 | 在Device侧申请的workspace大小，由第一段接口aclnnDropoutV3GetWorkspaceSize获取。 | | executor | 输入 | op执行器，包含了算子计算流程。 | | stream | 输入 | 指定执行任务的Stream。 | - **返回值：** aclnnStatus：返回状态码，具体参见aclnn返回码。 ## 约束说明 - 确定性计算： - aclnnDropoutV3默认确定性实现。 ## 调用示例 示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。 ```c++ #include #include #include "acl/acl.h" #include "aclnnop/aclnn_dropout_v3.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& 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 int CreateAclTensor(const std::vector& hostData, const std::vector& 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 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 selfShape = {4, 2}; std::vector outShape = {4, 2}; std::vector maskOutShape = {16}; void* selfDeviceAddr = nullptr; void* outDeviceAddr = nullptr; void* maskOutDeviceAddr = nullptr; aclTensor* self = nullptr; aclTensor* optionalNoiseShape = nullptr; aclTensor* out = nullptr; aclTensor* maskOut = nullptr; std::vector selfHostData = {0, 1, 2, 3, 4, 5, 6, 7}; std::vector outHostData(8, 0); std::vector maskOutHostData(16, 0); double p = 0.5; int64_t seed = 1234; int64_t offset = 0; // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建out aclTensor ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建maskOut aclTensor ret = CreateAclTensor(maskOutHostData, maskOutShape, &maskOutDeviceAddr, aclDataType::ACL_UINT8, &maskOut); CHECK_RET(ret == ACL_SUCCESS, return ret); // 3. 调用CANN算子库API，需要修改为具体的API名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnDropoutV3第一段接口 ret = aclnnDropoutV3GetWorkspaceSize(self, optionalNoiseShape, p, seed, offset, out, maskOut, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDropoutV3GetWorkspaceSize 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); } // 调用aclnnDropoutV3第二段接口 ret = aclnnDropoutV3(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDropoutV3 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 resultData(size, 0); ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr, 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(optionalNoiseShape); aclDestroyTensor(out); aclDestroyTensor(maskOut); // 7. 释放device资源，需要根据具体API的接口定义修改 aclrtFree(selfDeviceAddr); aclrtFree(outDeviceAddr); aclrtFree(maskOutDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```