aclnnRenorm&aclnnInplaceRenorm

支持的产品型号

• Atlas 训练系列产品。
• Atlas A2训练系列产品。

接口原型

• aclnnRenorm和aclnnInplaceRenorm实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

  • aclnnRenorm：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceRenorm：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。

• 每个算子分为，必须先调用“aclnnRenormGetWorkspaceSize”或者“aclnnInplaceRenormGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnRenorm”或者“aclnnInplaceRenorm”接口执行计算。

  • aclnnstatus aclnnRenormGetWorkspaceSize(const aclTensor *self, const aclScalar *p, int64_t dim, const aclScalar *maxNorm, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnstatus aclnnRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnstatus aclnnInplaceRenormGetWorkspaceSize(aclTensor *selfRef, const aclScalar *p, int64_t dim, const aclScalar *maxNorm, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnstatus aclnnInplaceRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：返回一个张量，其中输入张量self沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。

• 计算公式：

  $$output_i=\left\{ \begin{aligned} input_i,\quad ||input_i||_p <= maxNorm \\ \frac {input_i} {||input_i||_p} \cdot maxNorm,\quad ||input_i||_p>maxNorm \end{aligned} \right.$$

  其中： $i$维dim确定的某维度张量切片：

  $$||input_i||_p = (\sum_{i=0}^{n}{input_i^p}^\frac{1}{p})$$

• 举例：

  [object Object]

aclnnRenormGetWorkspaceSize

• 参数说明：

  • self(aclTensor *，计算输入): 数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持），shape不超过8维。支持，支持空Tensor，支持ND。

  • p(aclScalar *，计算输入): 表示范数，数据类型支持FLOAT。

  • dim(int64_t，计算输入): 表示指定求norm的唯度方向，范围在[-self的维度数量，self的维度数量-1]之内，数据类型支持INT64。

  • maxNorm(aclScalar *，计算输入): 表示最大允许的归一化值，要求大于等于0，如果运算时对应维度的p范数（由p值确定）大于maxNorm，则将该维度的值关于p范数归一化并乘上maxNorm；如果运算时对应维度的p范数（由p值确定）小于maxNorm，则该维度张量保持不变输出，数据类型支持FLOAT。

  • out(aclTensor *，计算输出): 数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持），且数据类型需要与self保持一致，shape需要与self一致。支持，支持空Tensor，支持ND。

  • workspaceSize(uint64_t *，出参): 返回用户需要在Device侧申请的workspace大小。

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

• 返回值：

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

  [object Object]

aclnnRenorm

• 参数说明：

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

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

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

  • stream（aclrtStream）：指定执行任务的AscendCL Stream流。

• 返回值：

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

aclnnInplaceRenormGetWorkspaceSize

• 参数说明：

  • selfRef(aclTensor *，计算输入|计算输出): 输入输出tensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持），shape不超过8维。支持，支持空Tensor，支持ND。
  • p(aclScalar *，计算输入): 公式中的输入p，表示范数，数据类型支持FLOAT。
  • dim(int64_t，计算输入): 公式中的输入dim，表示指定求norm的唯度方向，范围在[-selfRef的维度数量，selfRef的维度数量-1]之内，数据类型支持INT64。
  • maxNorm(aclScalar *，计算输入): 公式中的输入maxNorm，表示最大允许的归一化值，要求大于等于0，如果运算时对应维度的p范数（由p值确定）大于maxNorm，则将该维度的值关于p范数归一化并乘上maxNorm；如果运算时对应维度的p范数（由p值确定）小于maxNorm，则该维度张量保持不变输出，数据类型支持FLOAT。
  • workspaceSize(uint64_t *，出参): 返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **，出参): 返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnInplaceRenorm

• 参数说明：

  • workspace(void *，入参): 在Device侧申请的workspace内存地址。
  • workspaceSize(uint64_t，入参): 在Device侧申请的workspace大小，由第一段接口aclnnInplaceRenormGetWorkspaceSize获取。
  • executor（aclOpExecutor*, 入参）：op执行器，包含了算子计算流程。
  • stream（aclrtStream，入参）：指定执行任务的AscendCL Stream流。

• 返回值：

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

约束与限制

无。

调用示例

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

aclnnInplaceRenorm示例代码：