Merge branch 'develop' of https://github.com/PaddlePaddle/docs into mapping1

Author: ustiniankw

ci_scripts/hooks/pre-doc-compile.sh

@@ -3,28 +3,28 @@
 SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
 
 ## 1 merge the pytorch to paddle api map tables
-FILES_ARRAY=("https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/README.md"
-"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/ops/README.md"
-"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/nn/README.md"
-"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/loss/README.md"
-"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/utils/README.md"
-"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/vision/README.md"
-)
-TARGET_FILE=${SCRIPT_DIR}/../../docs/guides/model_convert/convert_from_pytorch/pytorch_api_mapping_cn.md
-TMP_FILE=/tmp/merge_pytorch_to_paddle_maptables.tmp
-
-echo -n > ${TARGET_FILE}
-for f in ${FILES_ARRAY[@]} ; do
-    echo -n > ${TMP_FILE}
-    echo "downloading ${f} ..."
-    if [ "${https_proxy}" != "" ] ; then
-        curl -o ${TMP_FILE} -s -x ${https_proxy} ${f}
-    else
-        curl -o ${TMP_FILE} -s ${f}
-    fi
-    echo >> ${TMP_FILE}
-    cat ${TMP_FILE} >> $TARGET_FILE
-done
+# FILES_ARRAY=("https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/README.md"
+# "https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/ops/README.md"
+#"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/nn/README.md"
+#"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/loss/README.md"
+#"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/utils/README.md"
+#"https://raw.githubusercontent.com/PaddlePaddle/X2Paddle/develop/docs/pytorch_project_convertor/API_docs/vision/README.md"
+#)
+#TARGET_FILE=${SCRIPT_DIR}/../../docs/guides/model_convert/convert_from_pytorch/pytorch_api_mapping_cn.md
+#TMP_FILE=/tmp/merge_pytorch_to_paddle_maptables.tmp
+#
+#echo -n > ${TARGET_FILE}
+#for f in ${FILES_ARRAY[@]} ; do
+#    echo -n > ${TMP_FILE}
+#    echo "downloading ${f} ..."
+#    if [ "${https_proxy}" != "" ] ; then
+#        curl -o ${TMP_FILE} -s -x ${https_proxy} ${f}
+#    else
+#        curl -o ${TMP_FILE} -s ${f}
+#    fi
+#    echo >> ${TMP_FILE}
+#    cat ${TMP_FILE} >> $TARGET_FILE
+#done
 
 
 ## 2 convert all ipynb files to markdown, and delete the ipynb files.

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

@@ -13,7 +13,7 @@ get_current_backend
 返回
 :::::::::
 
-``str``,语音 I/O 的后端名称。
+``str``，语音 I/O 的后端名称。
 
 代码示例
 :::::::::

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

@@ -13,7 +13,7 @@ list_available_backends
 返回
 :::::::::
 
-``List[str]``, 可用的音频 I/O 后端集合。
+``List[str]``，可用的音频 I/O 后端集合。
 
 代码示例
 :::::::::

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

@@ -10,7 +10,7 @@ set_backend
 参数
 ::::::::::::
 
-    - **backend_name** (str) - 语音 I/O 后端名称，现支持‘wave_backend’,如果安装了 paddleaudio >=1.0.2,则也支持‘soundfile’。
+    - **backend_name** (str) - 语音 I/O 后端名称，现支持 ``'wave_backend'`` ，如果安装了 paddleaudio >=1.0.2，则也支持 ``'soundfile'`` 。
 
 返回
 :::::::::

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

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

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

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

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

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

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

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

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

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

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

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