Sum

产品支持情况

功能说明

获取最后一个维度的元素总和。

如果输入是向量，则在向量中对各元素相加；如果输入是矩阵，则沿最后一个维度对每行中元素求和。本接口最多支持输入为二维数据，不支持更高维度的输入。

如下图所示，对shape为(2, 3)的二维矩阵进行运算，输出结果为[6, 15]。

为计算如上过程，引入一些必备概念：行数称之为外轴长度（outter），每行实际的元素个数称之为内轴的实际元素个数（n），存储n个元素所需的字节长度向上补齐到32整数倍后转换的元素个数称之为补齐后的内轴元素个数(inner)。本接口要求输入的内轴长度为32字节的整数倍，所以当n占据的字节长度不是32的整数倍时，需要开发者将其向上补齐到32的整数倍。比如，如下的样例中，元素类型为half，每行的实际元素个数n为3，占据字节长度为6字节，不是32字节的整数倍，向上补齐后得到32字节，转换为元素个数为16。故outter = 2，n =3，inner=16。图中的padding代表补齐操作。n和inner的关系如下：inner = (n *sizeof(T) + 32 - 1) / 32 * 32 / sizeof(T)。

函数原型

• 通过sharedTmpBuffer入参传入临时空间

  template <typename T, int32_t reduceDim = -1, bool isReuseSource = false, bool isBasicBlock = false>
  __aicore__ inline void Sum(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const SumParams& sumParams)
  

• 接口框架申请临时空间

  template <typename T, int32_t reduceDim = -1, bool isReuseSource = false, bool isBasicBlock = false>
  __aicore__ inline void Sum(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const SumParams& sumParams)
  

由于该接口的内部实现中涉及复杂的数学计算，需要额外的临时空间来存储计算过程中的中间变量。临时空间支持开发者通过sharedTmpBuffer入参传入和接口框架申请两种方式。

• 通过sharedTmpBuffer入参传入，使用该tensor作为临时空间进行处理，接口框架不再申请。该方式开发者可以自行管理sharedTmpBuffer内存空间，并在接口调用完成后，复用该部分内存，内存不会反复申请释放，灵活性较高，内存利用率也较高。
• 接口框架申请临时空间，开发者无需申请，但是需要预留临时空间的大小。

通过sharedTmpBuffer传入的情况，开发者需要为tensor申请空间；接口框架申请的方式，开发者需要预留临时空间。临时空间大小BufferSize的获取方式如下：通过GetSumMaxMinTmpSize中提供的接口获取需要预留空间范围的大小。

参数说明

表 1 模板参数说明

表 2 接口参数说明

struct SumParams{
    uint32_t outter = 1;    // 表示输入数据的外轴长度
    uint32_t inner;         // 表示输入数据内轴的补齐后元素个数，inner*sizeof(T)必须是32字节的整数倍
    uint32_t n;             // 表示输入数据内轴的实际元素个数
};

返回值说明

无

约束说明

• 操作数地址对齐要求请参见通用地址对齐约束。

• 不支持源操作数与目的操作数地址重叠。

• 不支持sharedTmpBuffer与源操作数和目的操作数地址重叠。

• 当前仅支持ND格式的输入，不支持其他格式。

• 一维输入的outter值填为1；二维输入按实际情况填写outter和n，inner计算请按如上公式计算，否则功能不正确。

• srcTensor需要能够容纳内轴对齐后的数据占用空间大小，dstTensor需要能够容纳outter个结果对齐后的数据占用空间大小。

• 对于Sum，其内部使用的底层相加方式和ReduceSum以及WholeReduceSum的内部的相加方式一致，采用二叉树方式，两两相加：

  假设源操作数为128个half类型的数据[data0,data1,data2...data127]，一个repeat可以计算完，计算过程如下。

  1. data0和data1相加得到data00，data2和data3相加得到data01...data124和data125相加得到data62，data126和data127相加得到data63；
  2. data00和data01相加得到data000，data02和data03相加得到data001...data62和data63相加得到data031；
  3. 以此类推，得到目的操作数为1个half类型的数据[data]。

调用示例

AscendC::SumParams params;
params.inner = inner;
params.outter = outter;
params.n = n;
T scalar(0);
AscendC::Duplicate<T>(yLocal, scalar, out_inner);
AscendC::Sum(yLocal, xLocal, sharedTmpBuffer, params);

结果示例如下，输入元素类型为half，大小为2*3的二维数据，则outter为2，n为3，sizeof(T)为2，inner = (3 * 2 + 32 - 1)/32 * 32 / 2 = 16。

输入数据srcLocal: [[1 2 3 0 0 0 0 0 0 0 0 0 0 0 0 0],
                     [4 5 6 0 0 0 0 0 0 0 0 0 0 0 0 0]]
输出数据dstLocal: [6 15 0 0 0 0 0 0 0 0 0 0 0 0 0 0]