Ors
产品支持情况
- Ascend 950PR/Ascend 950DT：支持
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持
- Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持
- Atlas 200I/500 A2 推理产品：不支持
- Atlas 推理系列产品 AI Core：不支持
- Atlas 推理系列产品 Vector Core：不支持
- Atlas 训练系列产品：不支持
功能说明
矢量内每个元素和标量间做或操作，支持标量在前和标量在后两种场景，其中标量输入支持配置LocalTensor单点元素。计算公式如下，idx表示LocalTensor单点元素的位置系数。
函数原型
Tensor前n个数据计算
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Ors(const U& dst, const S& src0, const V& src1, const int32_t& count)Tensor高维切分计算
mask逐比特模式
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Ors(const U& dst, const S& src0, const V& src1, uint64_t mask[], const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)mask连续模式
C++template <typename T = BinaryDefaultType, bool isSetMask = true, const BinaryConfig& config = DEFAULT_BINARY_CONFIG, typename U, typename S, typename V> __aicore__ inline void Ors(const U& dst, const S& src0, const V& src1, uint64_t mask, const uint8_t repeatTime, const UnaryRepeatParams& repeatParams)
参数说明
表1 模板参数说明
| 参数名 | 描述 |
|---|---|
| T | 预留参数，暂未启用，为后续的功能扩展做保留，需要指定时，传入默认值BinaryDefaultType即可。 |
| isSetMask | 是否在接口内部设置mask。 • true，表示在接口内部设置mask。 • false，表示在接口外部设置mask，开发者需要使用SetVectorMask接口设置mask值。这种模式下： • 针对tensor前n个数据计算接口，接口入参中的count不生效，建议设置成1。 • 针对tensor高维切分计算接口，接口入参中的mask值设置为占位符 MASK_PLACEHOLDER，用于占位，无实际含义。 |
| config | 类型为BinaryConfig，当标量为LocalTensor单点元素类型时生效，用于指定单点元素操作数位置。默认值DEFAULT_BINARY_CONFIG，表示右操作数为标量。 struct BinaryConfig { int8_t scalarTensorIndex = 1; // 用于指定标量为LocalTensor单点元素时标量的位置，0表示左操作数，1表示右操作数 }; constexpr BinaryConfig DEFAULT_BINARY_CONFIG = {1}; |
| U | LocalTensor类型，根据输入参数dst自动推导相应的数据类型，开发者无需配置该参数，保证dst满足数据类型的约束即可。 |
| S | LocalTensor类型或标量类型，根据输入参数src0自动推导相应的数据类型，开发者无需配置该参数，保证src0满足数据类型的约束即可。 |
| V | LocalTensor类型或标量类型，根据输入参数src1自动推导相应的数据类型，开发者无需配置该参数，保证src1满足数据类型的约束即可。 |
表2 参数说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| dst | 输出 | 目的操作数。 类型为LocalTensor，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 |
| src0/src1 | 输入 | 源操作数。 支持类型为LocalTensor或标量。数据类型需要与目的操作数保持一致。 类型为LocalTensor时，支持当作矢量操作数或标量单点元素，支持的TPosition为VECIN/VECCALC/VECOUT。 LocalTensor的起始地址需要32字节对齐。 |
| count | 输入 | 参与计算的元素个数。 |
| mask/mask[] | 输入 | mask用于控制每次迭代内参与计算的元素。详细设置参考掩码。 |
| repeatTime | 输入 | 重复迭代次数。矢量计算单元，每次读取连续的256Bytes数据进行计算，为完成对输入数据的处理，必须通过多次迭代（repeat）才能完成所有数据的读取与计算。repeatTime表示迭代的次数。 关于该参数的具体描述请参考高维切分API。 |
| repeatParams | 输入 | 元素操作控制结构信息，具体请参考UnaryRepeatParams。 |
数据类型
Ascend 950PR/Ascend 950DT，目的操作数dst和源操作数src支持的数据类型为：int16_t、uint16_t、int64_t、uint64_t。数据类型int64_t、uint64_t仅支持tensor前n个数据计算接口。
返回值说明
无
约束说明
使用Tensor高维切分计算接口时，节省地址空间，开发者可以定义一个Tensor，供源操作数与目的操作数同时使用（即地址重叠），相关约束如下：
- 对于单次repeat（repeatTime=1），且源操作数与目的操作数之间要求100%完全重叠，不支持部分重叠。
- 对于多次repeat（repeatTime>1），操作数与目的操作数之间存在依赖的情况下，即第N次迭代的目的操作数是第N+1次的源操作数，不支持地址重叠。
- 源操作数为LocalTensor单点元素的场景，不支持源操作数和目的操作数地址重叠。
操作数地址对齐要求请参见通用地址对齐约束。
- 针对Ascend 950PR/Ascend 950DT，tensor前n个数据计算API中的isSetMask参数不生效，保持默认值即可。
- 左操作数及右操作数中，必须有一个为矢量；当前不支持左右操作数同时为标量。
- 本接口传入LocalTensor单点数据作为标量时，idx参数需要传入编译期已知的常量，传入变量时需要声明为constexpr。
调用示例
Tensor高维切分计算样例-mask连续模式
C++// dstLocal：输出Tensor // src0Local：输入Tensor // src1Local：输入Tensor uint64_t mask = 128; // repeatTime = 4,单次迭代处理128个数，计算512个数需要迭代4次 // dstBlkStride, srcBlkStride = 1,每个迭代内src0参与计算的数据地址间隔为1个datablock，表示单次迭代内数据连续读取和写入 // dstRepStride, srcRepStride = 8,相邻迭代间的地址间隔为8个datablock，表示相邻迭代间数据连续读取和写入 // 标量在后示例 AscendC::Ors(dstLocal, src0Local, src1Local[0], mask, 4, { 1, 1, 8, 8 }); // 标量在前示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Ors<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, mask, 4, {1, 1, 8, 8});Tensor高维切分计算样例-mask逐比特模式
C++// dstLocal：输出Tensor // src0Local：输入Tensor // src1Local：输入Tensor uint64_t mask[2] = { UINT64_MAX, UINT64_MAX }; // repeatTime = 4,单次迭代处理128个数，计算512个数需要迭代4次 // dstBlkStride, srcBlkStride = 1,每个迭代内src0参与计算的数据地址间隔为1个datablock，表示单次迭代内数据连续读取和写入 // dstRepStride, srcRepStride = 8,相邻迭代间的地址间隔为8个datablock，表示相邻迭代间数据连续读取和写入 // 标量在后示例 AscendC::Ors(dstLocal, src0Local, src1Local[0], mask, 4, {1, 1, 8, 8}); // 标量在前示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Ors<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, mask, 4, {1, 1, 8, 8});Tensor前n个数据计算样例
C++// 标量在后示例 AscendC::Ors(dstLocal, src0Local, src1Local[0], 512); // 标量在前示例 static constexpr AscendC::BinaryConfig config = { 0 }; AscendC::Ors<BinaryDefaultType, true, config>(dstLocal, src0Local[0], src1Local, 512);
结果示例如下：
// 标量在后，src1Local[0]作为标量
输入数据src0Local: [1 2 3 ... 512]
输入数据src1Local: [1]
输出数据dstLocal: [1 2 3 ... 512]
// 标量在前，src0Local[0]作为标量
输入数据src0Local: [1]
输入数据src1Local: [1 2 3 ... 512]
输出数据dstLocal: [1 2 3 ... 512]