aclStft

支持的产品型号

Atlas A2训练系列产品。

接口原型

每个算子分为两段式接口，必须先调用“aclStftGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclStft”接口执行计算。

• aclnnStatus aclStftGetWorkspaceSize(const aclTensor *self, const aclTensor *window, aclTensor *out, int64_t nFft, int64_t hopLength, int64_t winLength, bool normalized, bool onesided, bool returnComplex, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclStft(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)

功能描述

• 算子功能: 计算输入在滑动窗口内的傅里叶变换。
• 计算公式:$$X[w,m]=\sum_{k=0}^{winLength-1}window[k]self[m*hopLength+k]exp(-j*\frac{2{\pi}wk}{nFft})$$

aclStftGetWorkspaceSize

• 参数说明：

  • self（aclTensor*，计算输入）：必选参数，待计算的输入，要求是一个1D/2D的Tensor，shape为(L)/(B, L)，数据类型支持FLOAT32，数据格式要求为ND。

  • window（aclTensor*，计算输入）：可选参数，要求是一个1D的Tensor，shape为(winLength)，数据类型支持FLOAT32，数据格式要求为ND。

  • nFft（int64_t，计算输入）：必选参数，Host侧的int，FFT的点数。

  • hopLength（int64_t，计算输入）：可选参数，Host侧的int，滑动窗口的间隔。

  • winLength（int64_t，计算输入）：可选参数，Host侧的int，window的大小。

  • normalized（bool，计算输入）：可选参数，Host侧的bool，是否对傅里叶变换结果进行标准化。

  • onesided（bool，计算输入）：可选参数，Host侧的bool，是否返回全部的结果或者一半结果。

  • returnComplex（bool，计算输入）：可选参数，Host侧的bool，确认返回值是complex tensor或者是实部、虚部分开的tensor。

  • workspaceSize（uint64_t*，出参）：Device侧的整型，返回需要在Device侧申请的workspace大小。

  • executor（aclOpExecutor**，出参）：Device侧的aclOpExecutor，返回op执行器，包含了算子计算流程。

  • out（aclTensor*，计算输出）：self在window内的傅里叶变换结果，要求是一个2D/3D/4D的Tensor。

    • 如果returnComplex=True，out是shape为[N, T]或者[B, N, T]的复数tensor。
    • 如果returnComplex=False，out是shape为[N, T, 2]或者[B, N, T, 2]的tensor。

    其中，N=nFft(onesided=False)或者(nFft // 2 + 1)(onesided=True)，T是滑动窗口的个数，T = L // hopLength + 1。当前仅支持returnComplex=False，数据类型支持FLOAT32，数据格式要求为ND。

• 返回值：

  返回aclnnStatus状态码，具体参见。

aclStft

• 参数说明：
  • workspace（void*，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclStftGetWorkspaceSize获取。
  • executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
  • stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。

约束与限制

• 输入self与PyTorch接口的不同：PyTorch接口的输入self为原始输入；aclStftGetWorkspaceSize的入参self是原始输入经过前端PyTorch补pad后得到的结果。

• nFft <= sizeof(self)。

• hopLength的缺省值：None，此时 hopLength = floor(nFft / 4)，滑动窗口的大小为nFft。

• winLength的缺省值：None，此时 winLength=nFft。

• normalized的缺省值：False；当normalized=True时，

  $$STFT(w,m)=\frac{1}{\sqrt{N}}X[w,m]$$

• onesided的缺省值：True（input和window为实数）；False（其他）。

• returnComplex的缺省值：False，在PyTorch 2.0版本后缺省值：True，且输入为实数时，此参数为必选。

调用示例