Skip to content

Commit 88caecb

Browse files
SmileGoatLigoml
andauthored
[audio] fix optional in audio doc (#5609)
--------- Co-authored-by: Ligoml <[email protected]>
1 parent cfb4609 commit 88caecb

19 files changed

+90
-90
lines changed

docs/api/paddle/audio/backends/get_current_backend_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ get_current_backend
1313
返回
1414
:::::::::
1515

16-
``str``,语音 I/O 的后端名称。
16+
``str``语音 I/O 的后端名称。
1717

1818
代码示例
1919
:::::::::

docs/api/paddle/audio/backends/list_available_backends_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ list_available_backends
1313
返回
1414
:::::::::
1515

16-
``List[str]``, 可用的音频 I/O 后端集合。
16+
``List[str]``可用的音频 I/O 后端集合。
1717

1818
代码示例
1919
:::::::::

docs/api/paddle/audio/backends/set_backend_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ set_backend
1010
参数
1111
::::::::::::
1212

13-
- **backend_name** (str) - 语音 I/O 后端名称,现支持wave_backend’,如果安装了 paddleaudio >=1.0.2,则也支持soundfile
13+
- **backend_name** (str) - 语音 I/O 后端名称,现支持 ``'wave_backend'`` ,如果安装了 paddleaudio >=1.0.2则也支持 ``'soundfile'``
1414

1515
返回
1616
:::::::::

docs/api/paddle/audio/datasets/ESC50_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ ESC50
1212
:::::::::
1313

1414
- **mode** (str,可选) - ``'train'`` 或 ``'dev'`` 模式两者之一,默认值为 ``'train'``。
15-
- **split** (int) - 默认是 1,指定 dev 的文件夹。
16-
- **feat_type** (str) - 默认是 raw,raw 是原始语音,支持 mfcc,spectrogram,melspectrogram,logmelspectrogram。指定从音频提取的语音特征。
17-
- **archive** (dict) - 默认是 None,类中已经设置默认 archive,指定数据集的下载链接和 md5 值。
15+
- **split** (int,可选) - 默认是 1,指定 dev 的文件夹。
16+
- **feat_type** (str,可选) - 默认是 raw,raw 是原始语音,支持 mfcc,spectrogram,melspectrogram,logmelspectrogram。指定从音频提取的语音特征。
17+
- **archive** (dict,可选) - 默认是 None,类中已经设置默认 archive,指定数据集的下载链接和 md5 值。
1818

1919
返回
2020
:::::::::

docs/api/paddle/audio/datasets/TESS_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ TESS
1212
:::::::::
1313

1414
- **mode** (str,可选) - ``'train'`` 或 ``'dev'`` 模式两者之一,默认值为 ``'train'``。
15-
- **n_folds** (int) - 默认是 5,指定把数据集分为的文件夹数目, 1 个文件夹是 dev,其他是 train。
16-
- **split** (int) - 默认是 1,指定 dev 的文件夹。
17-
- **feat_type** (str) - 默认是 raw,raw 是原始语音,支持 mfcc,spectrogram,melspectrogram,logmelspectrogram。指定从音频提取的语音特征。
18-
- **archive** (dict) - 默认是 None,类中已经设置默认 archive,指定数据集的下载链接和 md5 值。
15+
- **n_folds** (int,可选) - 默认是 5,指定把数据集分为的文件夹数目, 1 个文件夹是 dev,其他是 train。
16+
- **split** (int,可选) - 默认是 1,指定 dev 的文件夹。
17+
- **feat_type** (str,可选) - 默认是 raw,raw 是原始语音,支持 mfcc,spectrogram,melspectrogram,logmelspectrogram。指定从音频提取的语音特征。
18+
- **archive** (dict,可选) - 默认是 None,类中已经设置默认 archive,指定数据集的下载链接和 md5 值。
1919

2020
返回
2121
:::::::::

docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,29 @@ LogMelSpectrogram
1010
参数
1111
::::::::::::
1212

13-
- **sr** (int) - 采样率,默认 22050。
14-
- **n_fft** (int) - 离散傅里叶变换中频率窗大小,默认 512。
13+
- **sr** (int,可选) - 采样率,默认 22050。
14+
- **n_fft** (int,可选) - 离散傅里叶变换中频率窗大小,默认 512。
1515
- **hop_length** (int,可选) - 帧移,默认 512。
1616
- **win_length** (int,可选) - 短时 FFT 的窗长,默认为 None。
17-
- **window** (str) - 窗函数名,默认'hann'。
18-
- **power** (float) - 幅度谱的指数。
19-
- **center** (bool) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始。
20-
- **pad_mode** (str) - 如果 center 是 True,选择填充的方式,默认值是'reflect'。
21-
- **n_mels** (int) - mel bins 的数目。
17+
- **window** (str,可选) - 窗函数名,默认'hann'。
18+
- **power** (float,可选) - 幅度谱的指数,默认是2.0
19+
- **center** (bool,可选) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始,默认是 True
20+
- **pad_mode** (str,可选) - 如果 center 是 True,选择填充的方式,默认值是'reflect'。
21+
- **n_mels** (int,可选) - mel bins 的数目,默认是64
2222
- **f_min** (float,可选) - 最小频率(hz),默认 50.0。
2323
- **f_max** (float,可选) - 最大频率(hz),默认为 None。
24-
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放.
25-
- **norm** (Union[str,float],可选) - 计算 fbank 矩阵时正则化的种类,默认是'slaney',你也可以 norm=0.5,使用 p-norm 正则化.
26-
- **ref_value** (float) - 参照值,如果小于 1.0,信号的 db 会被提升,相反 db 会下降,默认值为 1.0.
27-
- **amin** (float) - 输入的幅值的最小值.
28-
- **top_db** (float,可选) - log-mel 谱的最大值(db).
29-
- **dtype** (str) - 输入和窗的数据类型,默认是'float32'.
24+
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放,默认是 False。
25+
- **norm** (Union[str,float],可选) - 计算 fbank 矩阵时正则化的种类,默认是'slaney',你也可以 norm=0.5,使用 p-norm 正则化
26+
- **ref_value** (float,可选) - 参照值如果小于 1.0,信号的 db 会被提升,相反 db 会下降,默认值为 1.0
27+
- **amin** (float,可选) - 输入的幅值的最小值,默认是1e-10。
28+
- **top_db** (float,可选) - log-mel 谱的最大值(db),默认是None。
29+
- **dtype** (str,可选) - 输入和窗的数据类型,默认是'float32'
3030

3131

3232
返回
3333
:::::::::
3434

35-
计算``LogMelSpectrogram``的可调用对象.
35+
计算``LogMelSpectrogram``的可调用对象
3636

3737
代码示例
3838
:::::::::

docs/api/paddle/audio/features/MFCC_cn.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@ MFCC
1212

1313
- **sr** (int,可选) - 采样率,默认 22050。
1414
- **n_mfcc** (int,可选) - mfcc 的维度,默认 40。
15-
- **n_fft** (int) - 离散傅里叶变换中频率窗大小,默认 512。
15+
- **n_fft** (int,可选) - 离散傅里叶变换中频率窗大小,默认 512。
1616
- **hop_length** (int,可选) - 帧移,默认 512。
1717
- **win_length** (int,可选) - 短时 FFT 的窗长,默认为 None。
18-
- **window** (str) - 窗函数名,默认'hann'。
19-
- **power** (float) - 幅度谱的指数。
20-
- **center** (bool) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始。
21-
- **pad_mode** (str) - 如果 center 是 True,选择填充的方式,默认值是'reflect'.
22-
- **n_mels** (int) - mel bins 的数目。
18+
- **window** (str,可选) - 窗函数名,默认'hann'。
19+
- **power** (float,可选) - 幅度谱的指数,默认是2.0
20+
- **center** (bool,可选) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始,默认是 True
21+
- **pad_mode** (str,可选) - 如果 center 是 True,选择填充的方式,默认值是'reflect'
22+
- **n_mels** (int,可选) - mel bins 的数目,默认是64
2323
- **f_min** (float,可选) - 最小频率(hz),默认 50.0。
2424
- **f_max** (float,可选) - 最大频率(hz),默认为 None。
25-
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放。
26-
- **norm** (Union[strfloat], optional) - 计算 fbank 矩阵时正则化的种类,默认是'slaney',你也可以 norm=0.5,使用 p-norm 正则化。
27-
- **ref_value** (float) - 参照值, 如果小于 1.0,信号的 db 会被提升, 相反 db 会下降, 默认值为 1.0。
28-
- **amin** (float) - 输入的幅值的最小值。
29-
- **top_db** (float,可选) - log-mel 谱的最大值(db)。
30-
- **dtype** (str) - 输入和窗的数据类型,默认是'float32'。
25+
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放,默认是 False
26+
- **norm** (Union[str, float],可选) - 计算 fbank 矩阵时正则化的种类,默认是'slaney',也可以 norm=0.5,使用 p-norm 正则化。
27+
- **ref_value** (float,可选) - 参照值, 如果小于 1.0,信号的 db 会被提升, 相反 db 会下降, 默认值为 1.0。
28+
- **amin** (float,可选) - 输入的幅值的最小值,默认是1e-10
29+
- **top_db** (float,可选) - log-mel 谱的最大值(db),默认是 None
30+
- **dtype** (str,可选) - 输入和窗的数据类型,默认是'float32'。
3131

3232
返回
3333
:::::::::

docs/api/paddle/audio/features/MelSpectrogram_cn.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ MelSpectrogram
1111
::::::::::::
1212

1313
- **sr** (int,可选) - 采样率,默认 22050。
14-
- **n_fft** (int) - 离散傅里叶变换中频率窗大小,默认 512。
14+
- **n_fft** (int,可选) - 离散傅里叶变换中频率窗大小,默认 512。
1515
- **hop_length** (int,可选) - 帧移,默认 512。
1616
- **win_length** (int,可选) - 短时 FFT 的窗长,默认为 None。
17-
- **window** (str) - 窗函数名,默认'hann'。
18-
- **power** (float) - 幅度谱的指数。
19-
- **center** (bool) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始。
20-
- **pad_mode** (str) - 如果 center 是 True,选择填充的方式.默认值是'reflect'。
21-
- **n_mels** (int) - mel bins 的数目。
17+
- **window** (str,可选) - 窗函数名,默认'hann'。
18+
- **power** (float,可选) - 幅度谱的指数,默认是2.0
19+
- **center** (bool,可选) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始,默认是 True
20+
- **pad_mode** (str,可选) - 如果 center 是 True,选择填充的方式默认值是'reflect'。
21+
- **n_mels** (int,可选) - mel bins 的数目,默认是64
2222
- **f_min** (float,可选) - 最小频率(hz),默认 50.0。
2323
- **f_max** (float,可选) - 最大频率(hz),默认为 None。
24-
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放。
25-
- **norm** (Union[strfloat],可选) -计算 fbank 矩阵时正则化的种类,默认是'slaney',你也可以 norm=0.5,使用 p-norm 正则化。
26-
- **dtype** (str) - 输入和窗的数据类型,默认是'float32'。
24+
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放,默认是 False
25+
- **norm** (Union[str, float],可选) -计算 fbank 矩阵时正则化的种类,默认是'slaney',也可以 norm=0.5,使用 p-norm 正则化。
26+
- **dtype** (str,可选) - 输入和窗的数据类型,默认是'float32'。
2727

2828

2929
返回

docs/api/paddle/audio/features/Spectrogram_cn.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Spectrogram
1010
参数
1111
::::::::::::
1212

13-
- **n_fft** (int) - 离散傅里叶变换中频率窗大小,默认 512。
13+
- **n_fft** (int,可选) - 离散傅里叶变换中频率窗大小,默认 512。
1414
- **hop_length** (int,可选) - 帧移,默认 512。
1515
- **win_length** (int,可选) - 短时 FFT 的窗长,默认为 None。
16-
- **window** (str) - 窗函数名,默认'hann'。
17-
- **power** (float) - 幅度谱的指数。
18-
- **center** (bool) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始。
19-
- **pad_mode** (str) - 如果 center 是 True,选择填充的方式.默认值是'reflect'。
20-
- **dtype** (str) - 输入和窗的数据类型,默认是'float32'。
16+
- **window** (str,可选) - 窗函数名,默认'hann'。
17+
- **power** (float,可选) - 幅度谱的指数,默认是1.0
18+
- **center** (bool,可选) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始,默认是True
19+
- **pad_mode** (str,可选) - 如果 center 是 True,选择填充的方式默认值是'reflect'。
20+
- **dtype** (str,可选) - 输入和窗的数据类型,默认是'float32'。
2121

2222

2323
返回

docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ compute_fbank_matrix
1212

1313
- **sr** (int) - 采样率。
1414
- **n_fft** (int) - fft bins 的数目。
15-
- **n_mels** (float) - mels bins 的数目。
16-
- **f_min** (float) - 最小频率(hz)。
17-
- **f_max** (Optional[float]) -最大频率(hz)。
18-
- **htk** (bool) -是否使用 htk 缩放。
19-
- **norm** (Union[strfloat]) -norm 的类型,默认是'slaney'。
20-
- **dtype** (str) - 返回矩阵的数据类型,默认'float32'。
15+
- **n_mels** (float,可选) - mels bins 的数目,默认是64
16+
- **f_min** (float,可选) - 最小频率(hz),默认是0.0
17+
- **f_max** (Optional[float],可选) - 最大频率(hz),默认是 None
18+
- **htk** (bool,可选) - 是否使用 htk 缩放,默认是 False
19+
- **norm** (Union[str, float],可选) - norm 的类型,默认是'slaney'。
20+
- **dtype** (str,可选) - 返回矩阵的数据类型,默认'float32'。
2121

2222
返回
2323
:::::::::
2424

25-
``paddle.Tensor``,Tensor shape (n_mels, n_fft//2 + 1)。
25+
``paddle.Tensor``Tensor shape (n_mels n_fft//2 + 1)。
2626

2727
代码示例
2828
:::::::::

0 commit comments

Comments
 (0)