Cos

产品支持情况

产品

是否支持

Ascend 950PR/Ascend 950DT

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

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

Kirin X90

Kirin 9030

功能说明

按元素做三角函数余弦运算,计算公式如下:

Cos(x)的泰勒展开式为:

函数原型

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

    • 源操作数Tensor全部/部分参与计算

      template <typename T, bool isReuseSource = false, const CosConfig& config = defaultCosConfig>
      __aicore__ inline void Cos(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const uint32_t calCount)
      
    • 源操作数Tensor全部参与计算

      template <typename T, bool isReuseSource = false, const CosConfig& config = defaultCosConfig>
      __aicore__ inline void Cos(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer)
      
  • 接口框架申请临时空间

    • 源操作数Tensor全部/部分参与计算

      template <typename T, bool isReuseSource = false, const CosConfig& config = defaultCosConfig>
      __aicore__ inline void Cos(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const uint32_t calCount)
      
    • 源操作数Tensor全部参与计算

      template <typename T, bool isReuseSource = false, const CosConfig& config = defaultCosConfig>
      __aicore__ inline void Cos(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor)
      

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

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

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

参数说明

表 1 模板参数说明

参数名

描述

T

操作数的数据类型。

Ascend 950PR/Ascend 950DT,支持的数据类型为:half、float。

Atlas A3 训练系列产品/Atlas A3 推理系列产品,支持的数据类型为:half、float。

Atlas A2 训练系列产品/Atlas A2 推理系列产品,支持的数据类型为:half、float。

Kirin X90,支持的数据类型为:half、float。

Kirin 9030,支持的数据类型为:half、float。

isReuseSource

是否允许修改源操作数,默认值为false。该参数仅在输入的数据类型为float时生效。

  • true:开发者允许源操作数被改写,可以使能该参数,使能后本接口内部计算时复用srcTensor的内存空间,节省部分内存空间;
  • false:本接口内部计算时不复用srcTensor的内存空间。

isReuseSource的使用样例请参考更多样例

config

Cos算法的相关配置。此参数可选配,CosConfig类型,具体定义如下方代码所示,其中参数的含义为:

algo:Cos内部实现使用的算法。CosAlgo类型,支持的取值如下:
  • POLYNOMIAL_APPROXIMATION:默认值。该算法通过简单的多项式逼近实现Cos接口,支持的输入值域范围为[-65504.0, 65504.0],支持的数据类型为half、float。
  • RADIAN_REDUCTION:该算法通过完整的周期约减实现Cos接口,支持输入全值域,支持的数据类型为half、float。
struct CosConfig {
  CosAlgo algo = CosAlgo::POLYNOMIAL_APPROXIMATION;
}
enum class CosAlgo {
  POLYNOMIAL_APPROXIMATION = 0;
  RADIAN_REDUCTION;
}

表 2 参数说明

参数名

输入/输出

描述

dstTensor

输出

目的操作数。

类型为LocalTensor,支持的TPosition为VECIN/VECCALC/VECOUT。

srcTensor

输入

源操作数。

类型为LocalTensor,支持的TPosition为VECIN/VECCALC/VECOUT。

源操作数的数据类型需要与目的操作数保持一致。

sharedTmpBuffer

输入

临时缓存。

类型为LocalTensor,支持的TPosition为VECIN/VECCALC/VECOUT。

临时空间大小BufferSize的获取方式请参考GetCosMaxMinTmpSize

calCount

输入

参与计算的元素个数。

返回值说明

约束说明

  • 对于Ascend 950PR/Ascend 950DT,模板参数config中使用多项式拟合算法POLYNOMIAL_APPROXIMATION时,必须保证输入源数据的值域在[-65504.0, 65504.0]范围内。

  • 对于以下产品,输入源数据必须保持值域在[-65504.0, 65504.0]范围内。

    • Atlas A3 训练系列产品/Atlas A3 推理系列产品
    • Atlas A2 训练系列产品/Atlas A2 推理系列产品
  • 不支持源操作数与目的操作数地址重叠。

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

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

调用示例

AscendC::TPipe pipe;
AscendC::TQue<AscendC::TPosition::VECCALC, 1> tmpQue;
pipe.InitBuffer(tmpQue, 1, bufferSize); // bufferSize 通过Host侧tiling参数获取
LocalTensor<uint8_t> sharedTmpBuffer = tmpQue.AllocTensor<uint8_t>();
// 输入tensor长度为1024, 算子输入的数据类型为half, 实际计算个数为512
AscendC::Cos(dstLocal, srcLocal, sharedTmpBuffer, 512);
constexpr AscendC::CosAlgo algo = AscendC::CosAlgo::RADIAN_REDUCTION;
constexpr AscendC::CosConfig config = { algo };
AscendC::Cos<half, false, config>(dstLocal, srcLocal, sharedTmpBuffer, 512);

结果示例如下:

输入数据(srcLocal): [0.5047314 0.1864135 ... -0.73319215 0.84544605]
输出数据(dstLocal): [0.8753044 0.98267525 ... 0.7430419 0.6633976]