diff --git a/docs/api/paddle/bartlett_window_cn.rst b/docs/api/paddle/bartlett_window_cn.rst new file mode 100644 index 00000000000..c833df6f2c4 --- /dev/null +++ b/docs/api/paddle/bartlett_window_cn.rst @@ -0,0 +1,38 @@ +.. _cn_api_paddle_bartlett_window: + +bartlett_window +------------------------------- + +.. py:function:: paddle.bartlett_window( + window_length: int, + periodic: bool = True, + *, + dtype: str = 'float32', + layout: str | None = None, + device: PlaceLike | None = None, + pin_memory: bool = False, + requires_grad: bool = False, +) + +计算一个 Bartlett 窗。 + +参数 +:::::::::::: + - **window_length** (int): 返回窗口的长度。必须为正数。 + - **periodic** (bool, 可选): 如果为 True,返回一个周期性的窗口;如果为 False,返回一个对称性的窗口。默认值为 True。 + - **dtype** (str, 可选): 返回的 Tensor 的数据类型。默认值为 'float32'。 + - **layout** (str, 可选): 仅用于 API 一致性,Paddle 中忽略。默认值为 None。 + - **device** (PlaceLike|None, 可选): 返回的 Tensor 所在的设备。如果为 None,则使用当前默认设备(参考 paddle.device.set_device())。对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。 + - **pin_memory** (bool, 可选): 如果设置为 True,返回的 Tensor 将被分配在固定内存(pinned memory)中。仅对 CPU Tensor 生效。默认值为 False。 + - **requires_grad** (bool, 可选): 是否在 autograd 中记录返回 Tensor 的操作。默认值为 False。 + + +返回 +::::::::: + +``paddle.Tensor``,一维张量,大小为 `(window_length,)`,表示 Bartlett 窗口。 + +代码示例 +::::::::: + +COPY-FROM: paddle.bartlett_window diff --git a/docs/api/paddle/blackman_window_cn.rst b/docs/api/paddle/blackman_window_cn.rst new file mode 100644 index 00000000000..bfc21d3ee8f --- /dev/null +++ b/docs/api/paddle/blackman_window_cn.rst @@ -0,0 +1,38 @@ +.. _cn_api_paddle_blackman_window: + +blackman_window +------------------------------- + +.. py:function:: paddle.blackman_window( + window_length: int, + periodic: bool = True, + *, + dtype: str = 'float32', + layout: str | None = None, + device: PlaceLike | None = None, + pin_memory: bool = False, + requires_grad: bool = False, +) + +计算一个 Blackman 窗。 + +参数 +:::::::::::: + - **window_length** (int): 返回窗口的长度。必须为正数。 + - **periodic** (bool, 可选): 如果为 True,返回一个周期性的窗口;如果为 False,返回一个对称性的窗口。默认值为 True。 + - **dtype** (str, 可选): 返回的 Tensor 的数据类型。默认值为 'float32'。 + - **layout** (str, 可选): 仅用于 API 一致性,Paddle 中忽略。默认值为 None。 + - **device** (PlaceLike|None, 可选): 返回的 Tensor 所在的设备。如果为 None,则使用当前默认设备(参考 paddle.device.set_device())。对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。 + - **pin_memory** (bool, 可选): 如果设置为 True,返回的 Tensor 将被分配在固定内存(pinned memory)中。仅对 CPU Tensor 生效。默认值为 False。 + - **requires_grad** (bool, 可选): 是否在 autograd 中记录返回 Tensor 的操作。默认值为 False。 + + +返回 +::::::::: + +``paddle.Tensor``,一维张量,大小为 `(window_length,)`,表示 Blackman 窗口。 + +代码示例 +::::::::: + +COPY-FROM: paddle.blackman_window diff --git a/docs/api/paddle/hamming_window_cn.rst b/docs/api/paddle/hamming_window_cn.rst new file mode 100644 index 00000000000..3630077385b --- /dev/null +++ b/docs/api/paddle/hamming_window_cn.rst @@ -0,0 +1,40 @@ +.. _cn_api_paddle_hamming_window: + +hamming_window +------------------------------- + +.. py:function:: paddle.hamming_window( + window_length: int, + periodic: bool = True, + alpha: float = 0.54, + beta: float = 0.46, + *, + dtype: str = 'float32', + layout: str | None = None, + device: PlaceLike | None = None, + pin_memory: bool = False, + requires_grad: bool = False, +) + +计算一个广义的汉明窗。 + +参数 +:::::::::::: + - **window_length** (int): 返回窗口的长度。必须为正数。 + - **periodic** (bool, 可选): 如果为 True,返回一个周期性的窗口;如果为 False,返回一个对称性的窗口。默认值为 True。 + - **alpha** (float, 可选): 窗口系数 α。默认值为 0.54。 + - **beta** (float, 可选): 窗口系数 β。默认值为 0.46。 + - **dtype** (str, 可选): 返回的 Tensor 的数据类型。默认值为 'float32'。 + - **layout** (str, 可选): 仅用于 API 一致性,Paddle 中忽略。默认值为 None。 + - **device** (PlaceLike|None, 可选): 返回的 Tensor 所在的设备。如果为 None,则使用当前默认设备(参考 paddle.device.set_device())。对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。 + - **pin_memory** (bool, 可选): 如果设置为 True,返回的 Tensor 将被分配在固定内存(pinned memory)中。仅对 CPU Tensor 生效。默认值为 False。 + - **requires_grad** (bool, 可选): 是否在 autograd 中记录返回 Tensor 的操作。默认值为 False。 +返回 +::::::::: + +``paddle.Tensor``,一维张量,大小为 `(window_length,)`,表示 Hamming 窗口。 + +代码示例 +::::::::: + +COPY-FROM: paddle.hamming_window diff --git a/docs/api/paddle/hann_window_cn.rst b/docs/api/paddle/hann_window_cn.rst new file mode 100644 index 00000000000..f1d6e2c8817 --- /dev/null +++ b/docs/api/paddle/hann_window_cn.rst @@ -0,0 +1,38 @@ +.. _cn_api_paddle_hann_window: + +hann_window +------------------------------- + +.. py:function:: paddle.hann_window( + window_length: int, + periodic: bool = True, + *, + dtype: str = 'float32', + layout: str | None = None, + device: PlaceLike | None = None, + pin_memory: bool = False, + requires_grad: bool = False, +) + +计算一个 Hann 窗。 + +参数 +:::::::::::: + - **window_length** (int): 返回窗口的长度。必须为正数。 + - **periodic** (bool, 可选): 如果为 True,返回一个周期性的窗口;如果为 False,返回一个对称性的窗口。默认值为 True。 + - **dtype** (str, 可选): 返回的 Tensor 的数据类型。默认值为 'float32'。 + - **layout** (str, 可选): 仅用于 API 一致性,Paddle 中忽略。默认值为 None。 + - **device** (PlaceLike|None, 可选): 返回的 Tensor 所在的设备。如果为 None,则使用当前默认设备(参考 paddle.device.set_device())。对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。 + - **pin_memory** (bool, 可选): 如果设置为 True,返回的 Tensor 将被分配在固定内存(pinned memory)中。仅对 CPU Tensor 生效。默认值为 False。 + - **requires_grad** (bool, 可选): 是否在 autograd 中记录返回 Tensor 的操作。默认值为 False。 + + +返回 +::::::::: + +``paddle.Tensor``,一维张量,大小为 `(window_length,)`,表示 Hann 窗口。 + +代码示例 +::::::::: + +COPY-FROM: paddle.hann_window diff --git a/docs/api/paddle/kaiser_window_cn.rst b/docs/api/paddle/kaiser_window_cn.rst new file mode 100644 index 00000000000..185eecb1312 --- /dev/null +++ b/docs/api/paddle/kaiser_window_cn.rst @@ -0,0 +1,40 @@ +.. _cn_api_paddle_kaiser_window: + +kaiser_window +------------------------------- + +.. py:function:: paddle.kaiser_window( + window_length: int, + periodic: bool = True, + beta: float = 12.0, + *, + dtype: str = 'float32', + layout: str | None = None, + device: PlaceLike | None = None, + pin_memory: bool = False, + requires_grad: bool = False, +) + +计算一个 Kaiser 窗。 + +参数 +:::::::::::: + - **window_length** (int): 返回窗口的长度。必须为正数。 + - **periodic** (bool, 可选): 如果为 True,返回一个周期性的窗口;如果为 False,返回一个对称性的窗口。默认值为 True。 + - **beta** (float, 可选): 窗口的形状参数。默认值为 12.0。 + - **dtype** (str, 可选): 返回的 Tensor 的数据类型。默认值为 'float32'。 + - **layout** (str, 可选): 仅用于 API 一致性,Paddle 中忽略。默认值为 None。 + - **device** (PlaceLike|None, 可选): 返回的 Tensor 所在的设备。如果为 None,则使用当前默认设备(参考 paddle.device.set_device())。对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。 + - **pin_memory** (bool, 可选): 如果设置为 True,返回的 Tensor 将被分配在固定内存(pinned memory)中。仅对 CPU Tensor 生效。默认值为 False。 + - **requires_grad** (bool, 可选): 是否在 autograd 中记录返回 Tensor 的操作。默认值为 False。 + + +返回 +::::::::: + +``paddle.Tensor``,一维张量,大小为 `(window_length,)`,表示 Kaiser 窗口。 + +代码示例 +::::::::: + +COPY-FROM: paddle.kaiser_window