--- title: Gather description: "| 产品 | 是否支持 |" url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/ascendcopapi/atlasascendc_api_07_0092.html sourcePath: /source/zh/canncommercial/900/API/ascendcopapi/atlasascendc_api_07_0092.html indexId: 172e3a339f098db406b632f862de1addc7e17f27a37aef289303134ea8b625ff76 --- # Gather #### 产品支持情况 | 产品 | 是否支持 | | --- | --- | | Atlas 350 加速卡 | √ | | Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ | | Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ | | Atlas 200I/500 A2 推理产品 | √ | | Atlas 推理系列产品 AI Core | √ | | Atlas 推理系列产品 Vector Core | x | | Atlas 训练系列产品 | x | #### 功能说明 给定输入的张量和一个地址偏移张量，本接口根据偏移地址将输入张量按元素收集到结果张量中。 #### 函数原型 - tensor前n个数据计算 1 2 template __aicore__ inline void Gather(const LocalTensor& dst, const LocalTensor& src, const LocalTensor& srcOffset, const uint32_t srcBaseAddr, const uint32_t count) - tensor高维切分计算 - mask逐bit模式 1 2 template __aicore__ inline void Gather(const LocalTensor& dst, const LocalTensor& src, const LocalTensor& srcOffset, const uint32_t srcBaseAddr, const uint64_t mask[], const uint8_t repeatTime, const uint16_t dstRepStride) - mask连续模式 1 2 template __aicore__ inline void Gather(const LocalTensor& dst, const LocalTensor& src, const LocalTensor& srcOffset, const uint32_t srcBaseAddr, const uint64_t mask, const uint8_t repeatTime, const uint16_t dstRepStride) #### 参数说明 **表1 模板参数说明** | 参数名 | 描述 | | --- | --- | | T | 操作数数据类型。 Atlas 350 加速卡，支持的数据类型为：uint8\_t/int8\_t/uint16\_t/int16\_t/half/bfloat16\_t/uint32\_t/int32\_t/float/uint64\_t/int64\_t Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持的数据类型为：int16\_t/uint16\_t/int32\_t/uint32\_t/float/half/bfloat16\_t Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持的数据类型为：int16\_t/uint16\_t/int32\_t/uint32\_t/float/half/bfloat16\_t Atlas 200I/500 A2 推理产品 ，支持的数据类型为：uint8\_t/int8\_t/uint16\_t/int16\_t/half/uint32\_t/int32\_t/float Atlas 推理系列产品 AI Core，支持的数据类型为：int16\_t/uint16\_t/int32\_t/uint32\_t/float/half | **表2 参数说明** | 参数名称 | 输入/输出 | 含义 | | --- | --- | --- | | dst | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 | | src | 输入 | 源操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 数据类型和dst保持一致。 | | srcOffset | 输入 | 每个元素在src中对应的地址偏移。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 该偏移量相对于src的起始基地址而言。单位为Bytes。取值要求如下： 取值应保证src元素类型位宽对齐。 偏移地址后不能超出UB大小数据的范围。 针对以下型号，地址偏移的取值范围：不能超出uint32\_t的范围。 Atlas 推理系列产品 AI Core Atlas A2 训练系列产品 / Atlas A2 推理系列产品 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 针对以下型号，地址偏移的取值范围：当操作数为8位时，取值范围为[0, 216\-1]；当操作数为16位时，取值范围为[0, 217\-1]，当操作数为32位或者64位时，不能超出uint32\_t的范围。 Atlas 200I/500 A2 推理产品 Atlas 350 加速卡 | | srcBaseAddr | 输入 | src的起始基地址，用于指定Gather操作中源操作数的起始位置，单位为Bytes。取值应保证src元素类型位宽对齐，否则会导致非预期行为。 | | count | 输入 | 执行处理的数据个数。 | | mask/mask[] | 输入 | mask(https://www.hiascend.comdocument/detail/zh/canncommercial/900/programug/Ascendcopdevg/atlas\_ascendc\_10\_0022.html\#ZH\-CN\_TOPIC\_0000002562282205\_\_zh\-cn\_topic\_0000002267504656\_zh\-cn\_topic\_0000001764162593\_section4252658182)用于控制每次迭代内参与计算的元素。 连续模式：表示前面连续的多少个元素参与计算。取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为8位或16位时，mask∈[1, 128]；当操作数为32位时，mask∈[1, 64]；当操作数为64位时，mask∈[1, 32]。 逐bit模式：可以按位控制哪些元素参与计算，bit位的值为1表示参与计算，0表示不参与。参数类型为长度为2的uint64\_t类型数组。 例如，mask=[8, 0]，8=0b1000，表示仅第4个元素参与计算。 参数取值范围和操作数的数据类型有关，数据类型不同，每次迭代内能够处理的元素个数最大值不同。当操作数为8位或16位时，mask[0]、mask[1]∈[0, 264\-1]并且不同时为0；当操作数为32位时，mask[1]为0，mask[0]∈(0, 264\-1]；当操作数为64位时，mask[1]为0，mask[0]∈(0, 232\-1]。 | | repeatTime | 输入 | 指令迭代次数，每次迭代完成8个datablock（32Bytes）的数据收集，数据范围：repeatTime∈[0,255]。 特别地，针对以下型号： Atlas 200I/500 A2 推理产品 Atlas 350 加速卡 操作数为8位时，每次迭代完成4个datablock（32Bytes）的数据收集。 | | dstRepStride | 输入 | 相邻迭代间的地址步长，单位是datablock（32Bytes）。 | #### 约束说明 - 操作数地址对齐要求请参见 通用地址对齐约束 。 - 操作数地址重叠约束请参考 通用地址重叠约束 。 - 针对Atlas 350 加速卡，uint8_t/int8_t数据类型仅支持tensor前n个数据计算接口。 #### 调用示例 本样例中只展示Compute流程中的部分代码。 - tensor高维切分计算样例-mask连续模式 1 2 3 4 5 // repeatTime = 4, mask = 128, 128 elements one repeat, 512 elements total // srcLocal数据类型为half，srcOffsetLocal数据类型为uint32_t，dstLocal数据类型为half // srcBaseAddr = 0, srcLocal的起始基地址为0 // dstRepStride = 8, no gap between repeats AscendC::Gather(dstLocal, srcLocal, srcOffsetLocal, (uint32_t)0, 128, 4, 8); - tensor高维切分计算样例-mask逐bit模式 1 2 3 4 5 6 uint64_t mask[2] = { 0xFFFFFFFFFFFFFFFF, 0xFFFFFFFFFFFFFFFF }; // repeatTime = 4, 128 elements one repeat, 512 elements total // srcLocal数据类型为half，srcOffsetLocal数据类型为uint32_t，dstLocal数据类型为half // srcBaseAddr = 0, srcLocal的起始基地址为0 // dstRepStride = 8, no gap between repeats AscendC::Gather(dstLocal, srcLocal, srcOffsetLocal, (uint32_t)0, mask, 4, 8); - tensor前n个数据计算样例 1 2 3 4 uint32_t count = 512; // 参与计算的元素个数 // srcLocal数据类型为half，srcOffsetLocal数据类型为uint32_t，dstLocal数据类型为half // srcBaseAddr = 0, srcLocal的起始基地址为0 AscendC::Gather(dstLocal, srcLocal, srcOffsetLocal, (uint32_t)0, count); 结果示例如下： ``` 输入数据srcOffsetLocal: [254 252 250 ... 4 2 0] 输入数据srcLocal（128个half类型数据）: [0 1 2 ... 125 126 127] 输出数据(dstLocal)初始值: [0. 0. 0. 0. 0. 0. ... 0.] 进行Gather计算后，输出数据(dstLocal): [127 126 125 ... 2 1 0] ```