aclnnDropout

支持的产品型号

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

接口原型

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

• aclnnStatus aclnnDropoutGetWorkspaceSize(const aclTensor* input, double p, bool train, int64_t seed, int64_t offset, aclTensor* out, aclTensor* maskOut, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnDropout(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能：训练过程中，按照概率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}$$

aclnnDropoutGetWorkspaceSize

• 参数说明：

  • input(aclTensor*, 计算输入)：公式中的输入input，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），支持undefined, undefined支持ND 。

  • p(double, 计算输入)：元素置零的概率。

  • train(bool, 计算输入)：是否训练场景。

  • seed(int64_t, 计算输入)：随机数的种子，影响生成的随机数序列。

  • offset(int64_t, 计算输入)：随机数的偏移量，它影响生成的随机数序列的位置。

  • out(aclTensor*, 计算输出)：公式中的out，数据类型需要是input可转换的数据类型，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），shape需要与input一致，支持undefined。undefined支持ND。

  • maskOut(aclTensor*, 计算输出)：bit类型并使用UINT8类型存储的mask数据。Device侧的aclTensor，数据类型支持UINT8，shape需要为(align(input的元素个数,128)/8)，表示比特数需要与128对齐，其中，align表示将input的元素个数向上对齐为128的倍数，如align(1111, 128)的结果为1152。支持undefined。undefined支持ND。当p=0、p=1或train=false场景下，不对传入的maskOut做任何处理；其它场景下以给定的p为置零概率生成mask。

  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。

  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnDropout

• 参数说明：

  • workspace(void*, 入参)：在Device侧申请的workspace内存地址。

  • workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnDropoutGetWorkspaceSize获取。

  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。

  • stream(aclrtStream, 入参)：指定执行任务的 AscendCL Stream流。

• 返回值：

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

约束与限制

无。

调用示例

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