aclnnEmbeddingRenorm

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	√
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	√

功能说明

• 算子功能：根据给定的maxNorm和normType返回输入tensor在指定indices下的修正结果。

• 计算公式：向量的范数计算公式如下，其中p为normType指定的范数值：

  $$||X||_{p}=\sqrt[p]{\sum_{i=1}^nx_{i}^p}$$ $$其中X=(x_{1}, x_{2}, ... , x_{n})$$

  针对计算出的范数大于maxNorm的场景，需要做归一化处理，对indices指定的0维元素乘以系数：

  $$scalar = \frac{maxNorm}{currentNorm+1e^{-7}}$$

函数原型

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

• aclnnStatus aclnnEmbeddingRenormGetWorkspaceSize(aclTensor *selfRef, const aclTensor *indices, double maxNorm, double normType, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnEmbeddingRenorm(void *workspace, uint64_t workspace_size, aclOpExecutor *executor, const aclrtStream stream)

aclnnEmbeddingRenormGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*，计算输入/输出）：待进行renorm计算的入参，公式中的x，dim必须为2。Device侧的aclTensor，undefined支持ND，支持undefined。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT、FLOAT16、BFLOAT16。
  • indices（aclTensor*，计算输入）：selfRef中第0维上待进行renorm计算的索引。Device侧的aclTensor，shape不超过8维，数据类型支持int32、int64类型，undefined支持ND，支持undefined。indices中的索引数据不支持越界。
  • maxNorm（double，计算输入）：指定范数的最大值，超出此值需要对embedding的结果进行归一化处理，仅支持double类型。
  • normType（double，计算输入）：指定L_P范数的类型，公式中的p，仅支持double类型。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnEmbeddingRenorm

• 参数说明：

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

• 返回值：

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

约束说明

无

调用示例

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