Star532
724
代码
代码
Issues78
Pull Requests133
流水线
讨论
Wiki
分析
Star532
724
cann-robotcann-robotupdate vector binary and unary api docs
0287e32b创建于 2 天前历史提交

Muls

产品支持情况

产品 是否支持
Ascend 950PR/Ascend 950DT √
Atlas A3 训练系列产品/Atlas A3 推理系列产品 √
Atlas A2 训练系列产品/Atlas A2 推理系列产品 √
Atlas 200I/500 A2 推理产品 √
Atlas 推理系列产品AI Core √
Atlas 推理系列产品Vector Core x
Atlas 训练系列产品 √
Kirin X90 √
Kirin 9030 √

功能说明

头文件路径为："basic_api/kernel_operator_vec_binary_scalar_intf.h"。

Muls属于双目标量类计算接口，输入为一个矢量tensor和一个标量scalar，Muls负责将矢量tensor内的每个元素与标量进行求积。计算公式如下：

dsti=srci×scalarValuedst_i = src_i \times scalarValue

函数原型

  • tensor前n个数据连续计算

    template <typename T, bool isSetMask = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const T& scalarValue, const int32_t& count)

  • tensor高维切分计算

    • mask逐bit模式

      template <typename T, bool isSetMask = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const T& scalarValue, uint64_t mask[], const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

    • mask连续模式

      template <typename T, bool isSetMask = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const T& scalarValue, uint64_t mask, const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

dst和src使用TensorTrait类型时，其数据类型TensorTrait和scalarValue的数据类型（对应TensorTrait中的LiteType类型）不一致。因此新增模板类型U表示scalarValue的数据类型，并通过std::enable_if检查T中萃取出的LiteType和U是否完全一致，一致则接口通过编译，否则编译失败。接口原型定义如下：

  • tensor前n个数据计算

    template <typename T, typename U, bool isSetMask = true, typename Std::enable_if<Std::is_same<PrimT<T>, U>::value, bool>::type = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const U& scalarValue, const int32_t& count)

  • tensor高维切分计算

    • mask逐bit模式

      template <typename T, typename U, bool isSetMask = true, typename Std::enable_if<Std::is_same<PrimT<T>, U>::value, bool>::type = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const U& scalarValue, uint64_t mask[], const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

    • mask连续模式

      template <typename T, typename U, bool isSetMask = true, typename Std::enable_if<Std::is_same<PrimT<T>, U>::value, bool>::type = true>
__aicore__ inline void Muls(const LocalTensor<T>& dst, const LocalTensor<T>& src, const U& scalarValue, uint64_t mask, const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)

参数说明

表 1 模板参数说明

参数名 描述
T 操作数数据类型。
U scalarValue的数据类型。
isSetMask 是否在接口内部设置mask。
• true，表示在接口内部设置mask。
• false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下，本接口入参中的mask值必须设置为占位符MASK_PLACEHOLDER。
具体使用方式可参考掩码。
针对以下型号，tensor前n个数据计算API中的isSetMask参数不生效，保持默认值即可。
• Ascend 950PR/Ascend 950DT
• Atlas 200I/500 A2 推理产品

表 2 参数说明

参数名 输入/输出 描述
dst 输出 目的操作数。
类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。
地址对齐约束参考通用地址对齐约束。
src 输入 源操作数。
类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。
地址对齐约束参考通用地址对齐约束。
scalarValue 输入 源操作数，数据类型需要与目的操作数中的元素类型保持一致。
count 输入 参与计算的元素个数。关于该参数的具体说明请参考连续计算。
mask[]/mask 输入 mask用于控制每次迭代内参与计算的元素。详细设置参考掩码。
repeatTime 输入 重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。
关于该参数的具体说明请参考高维切分。
repeatParams 输入 控制操作数地址步长的参数。UnaryRepeatParams类型，包含操作数相邻迭代间相同DataBlock的地址步长，操作数同一迭代内不同DataBlock的地址步长等参数。
相邻迭代间的地址步长参数说明请参考repeatStride；同一迭代内DataBlock的地址步长参数说明请参考dataBlockStride。

数据类型

  • 针对Ascend 950PR/Ascend 950DT，T和U支持的数据类型为：int16_t、half、bfloat16_t、int32_t、float、complex32、int64_t、uint64_t、complex64。数据类型complex32、int64_t、uint64_t、complex64仅支持tensor前n个数据计算接口。
  • 针对Atlas A3 训练系列产品/Atlas A3 推理系列产品，T和U支持的数据类型为：int16_t、half、int32_t、float。
  • 针对Atlas A2 训练系列产品/Atlas A2 推理系列产品，T和U支持的数据类型为：int16_t、half、int32_t、float。
  • 针对Atlas 200I/500 A2 推理产品，T和U支持的数据类型为：int16_t、half、int32_t、float。
  • 针对Atlas 推理系列产品AI Core，T和U支持的数据类型为：int16_t、half、int32_t、float。
  • 针对Atlas 训练系列产品，T和U支持的数据类型为：half、float。
  • 针对Kirin X90，T和U支持的数据类型为：int16_t、half、int32_t、float。
  • 针对Kirin 9030，T和U支持的数据类型为：int16_t、half、int32_t、float。

返回值说明

无

约束说明

  • 针对如下型号，当参数count或repeatTime取值为0时，不会执行计算操作，不会对目的操作数进行写入，该接口将被视为NOP（空操作）。

    • Atlas A3 训练系列产品/Atlas A3 推理系列产品
    • Atlas A2 训练系列产品/Atlas A2 推理系列产品

调用示例

  • tensor高维切分计算样例-mask连续模式

    uint64_t mask = 128;
int16_t scalar = 2;
// repeatTime = 4, 128 elements one repeat, 512 elements total.
// dstBlkStride, srcBlkStride = 1, no gap between blocks in one repeat.
// dstRepStride, srcRepStride = 8, no gap between repeats.
AscendC::Muls(dstLocal, srcLocal, scalar, mask, 4, { 1, 1, 8, 8 });

  • tensor高维切分计算样例-mask逐bit模式

    uint64_t mask[2] = { UINT64_MAX, UINT64_MAX };
int16_t scalar = 2;
// repeatTime = 4, 128 elements one repeat, 512 elements total.
// dstBlkStride, srcBlkStride = 1, no gap between blocks in one repeat.
// dstRepStride, srcRepStride = 8, no gap between repeats.
AscendC::Muls(dstLocal, srcLocal, scalar, mask, 4, {1, 1, 8, 8});

  • tensor前n个数据计算接口样例

    int16_t scalar = 2;
AscendC::Muls(dstLocal, srcLocal, scalar, 512);

结果示例如下：

输入数据srcLocal：[1 2 3 ... 512]
输入数据scalar = 2
输出数据dstLocal：[2 4 6 ... 1024]