From 2e40beb8d3ffb645e11ceb951b579940255366ea Mon Sep 17 00:00:00 2001 From: YangZhou Date: Fri, 14 Oct 2022 17:55:35 +0800 Subject: [PATCH 1/9] update audio datasets && backend --- .../backends/get_current_audio_backend_cn.rst | 21 ++++++++++++++ docs/api/paddle/audio/backends/info_cn.rst | 22 ++++++++++++++ .../backends/list_available_backends_cn.rst | 21 ++++++++++++++ docs/api/paddle/audio/backends/load_cn.rst | 26 +++++++++++++++++ docs/api/paddle/audio/backends/save_cn.rst | 25 ++++++++++++++++ .../paddle/audio/backends/set_backend_cn.rst | 21 ++++++++++++++ docs/api/paddle/audio/datasets/ESC50_cn.rst | 27 +++++++++++++++++ docs/api/paddle/audio/datasets/TESS_cn.rst | 29 +++++++++++++++++++ 8 files changed, 192 insertions(+) create mode 100644 docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst create mode 100644 docs/api/paddle/audio/backends/info_cn.rst create mode 100644 docs/api/paddle/audio/backends/list_available_backends_cn.rst create mode 100644 docs/api/paddle/audio/backends/load_cn.rst create mode 100644 docs/api/paddle/audio/backends/save_cn.rst create mode 100644 docs/api/paddle/audio/backends/set_backend_cn.rst create mode 100644 docs/api/paddle/audio/datasets/ESC50_cn.rst create mode 100644 docs/api/paddle/audio/datasets/TESS_cn.rst diff --git a/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst b/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst new file mode 100644 index 00000000000..d74e8e26df9 --- /dev/null +++ b/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_audio_backends_get_current_audio_backend: + +get_current_audio_backend +------------------------------- + +.. py:function:: paddle.audio.backends.get_current_audio_backend() + +获取现在的处理语音I/O的后端名称。 + +参数 +:::::::::::: + +返回 +::::::::: + +``str``,语音I/O的后端名称。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.get_current_audio_backend \ No newline at end of file diff --git a/docs/api/paddle/audio/backends/info_cn.rst b/docs/api/paddle/audio/backends/info_cn.rst new file mode 100644 index 00000000000..a94a44b94fe --- /dev/null +++ b/docs/api/paddle/audio/backends/info_cn.rst @@ -0,0 +1,22 @@ +.. _cn_api_audio_backends_info: + +info +------------------------------- + +.. py:function:: paddle.audio.backends.info(filepath:str) + +获取音频的相关信息，如采用率，通道数等。 + +参数 +:::::::::::: + + - **filepath** (str) - 输入音频路径。 +返回 +::::::::: + +``AudioInfo``, 音频相关信息。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.info \ No newline at end of file diff --git a/docs/api/paddle/audio/backends/list_available_backends_cn.rst b/docs/api/paddle/audio/backends/list_available_backends_cn.rst new file mode 100644 index 00000000000..1c8faf4d193 --- /dev/null +++ b/docs/api/paddle/audio/backends/list_available_backends_cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_audio_backends_list_available_backends: + +list_available_backends +------------------------------- + +.. py:function:: paddle.audio.backends.list_available_backends() + +获取可用的音频I/O后端。 + +参数 +:::::::::::: + +返回 +::::::::: + +``List[str]``, 可用的音频I/O后端集合。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.list_available_backends \ No newline at end of file diff --git a/docs/api/paddle/audio/backends/load_cn.rst b/docs/api/paddle/audio/backends/load_cn.rst new file mode 100644 index 00000000000..917b49bea9d --- /dev/null +++ b/docs/api/paddle/audio/backends/load_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_audio_backends_load: + +load +------------------------------- + +.. py:function:: paddle.audio.backends.load(filepath: Union[str, Path], frame_offset: int = 0, num_frames: int = -1, normalize: bool = True, channels_first: bool = True) + +获取音频的相关信息，如采用率，通道数等。 + +参数 +:::::::::::: + + - **filepath** (str 或者 Path) - 输入音频路径。 + - **frame_offset** (int) - 默认是0，开始读取音频起始帧。 + - **num_frames** (int) - 默认是-1，读取音频帧数, -1表示读取全部帧。 + - **normalize** (bool) - 默认是True。如果是True，返回是音频值被规整到[-1.0, 1.0]，如果是False，那么就返回原始值。 + - **channels_first** (bool) - 默认是True。如果是True，那么返回的形状是[channel，time]，如果是False，则是[time, channel]。 +返回 +::::::::: + +``Tuple[paddle.Tensor, int]``, 音频数据值, 采样率。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.load \ No newline at end of file diff --git a/docs/api/paddle/audio/backends/save_cn.rst b/docs/api/paddle/audio/backends/save_cn.rst new file mode 100644 index 00000000000..ebe75b1413b --- /dev/null +++ b/docs/api/paddle/audio/backends/save_cn.rst @@ -0,0 +1,25 @@ +.. _cn_api_audio_backends_save: + +save +------------------------------- + +.. py:function:: paddle.audio.backends.save(filepath: str, src: paddle.Tensor, sample_rate: int, channels_first: bool = True, encoding: Optional[str] = None, bits_per_sample: Optional[int] = 16) + +获取音频的相关信息，如采用率，通道数等。 + +参数 +:::::::::::: + + - **filepath** (str 或者 Path) - 保存音频路径。 + - **src** (paddle.Tensor) - 音频数据。 + - **sample_rate** (int) - 采样率。 + - **channels_first** (bool) - 如果是True，那么src的Tensor形状是[channel，time]，如果是False，则是[time, channel]。 + - **encoding** (Optional[str]) - 默认是None，编码信息。 + - **bits_per_sample** (Optional[int]) - 默认是16。编码位长。 +返回 +::::::::: + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.save \ No newline at end of file diff --git a/docs/api/paddle/audio/backends/set_backend_cn.rst b/docs/api/paddle/audio/backends/set_backend_cn.rst new file mode 100644 index 00000000000..49926fc2335 --- /dev/null +++ b/docs/api/paddle/audio/backends/set_backend_cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_audio_backends_set_backend: + +set_backend +------------------------------- + +.. py:function:: paddle.audio.backends.set_backend(backend_name: str) + +设置处理语音I/O的后端。 + +参数 +:::::::::::: + + - **backend_name** (str) - 语音I/O后端名称，现支持‘wave_backend’,如果安装了paddleaudio >=1.0.2,则也支持‘soundfile’。 + +返回 +::::::::: + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.set_backend \ No newline at end of file diff --git a/docs/api/paddle/audio/datasets/ESC50_cn.rst b/docs/api/paddle/audio/datasets/ESC50_cn.rst new file mode 100644 index 00000000000..bd9de5c6df9 --- /dev/null +++ b/docs/api/paddle/audio/datasets/ESC50_cn.rst @@ -0,0 +1,27 @@ +.. _cn_api_audio_datasets_ESC50: + +ESC50 +------------------------------- + +.. py:class:: paddle.audio.datasets.ESC50(mode: str = 'train', split: int = 1, feat_type: str = 'raw', archive=None, **kwargs) + + +`ESC50 `_ 数据集的实现。 + +参数 +::::::::: + + - **mode** (str，可选) - ``'train'`` 或 ``'dev'`` 模式两者之一，默认值为 ``'train'``。 + - **split** (int) - 默认是1，指定dev的文件夹。 + - **feat_type** (str) - 默认是raw，raw是原始语音，支持mfcc，spectrogram，melspectrogram，logmelspectrogram。指定从音频提取的语音特征。 + - **archive** (dict) - 默认是None，类中已经设置默认archive，指定数据集的下载链接和md5值。 + +返回 +::::::::: + +:ref:`cn_api_io_cn_Dataset`，ESC50 数据集实例。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.datasets.ESC50 diff --git a/docs/api/paddle/audio/datasets/TESS_cn.rst b/docs/api/paddle/audio/datasets/TESS_cn.rst new file mode 100644 index 00000000000..ecd82ff82e2 --- /dev/null +++ b/docs/api/paddle/audio/datasets/TESS_cn.rst @@ -0,0 +1,29 @@ +.. _cn_api_audio_datasets_TESS: + +TESS +------------------------------- + +.. py:class:: paddle.audio.datasets.TESS(mode: str = 'train', seed = 0, n_folds = 5, split = 1, feat_type = 'raw', archive=None, **kwargs) + + +`TESS `_ 数据集的实现。 + +参数 +::::::::: + + - **mode** (str，可选) - ``'train'`` 或 ``'dev'`` 模式两者之一，默认值为 ``'train'``。 + - **seed** (int) - 默认是0，指定随机数来对数据进行重新排序。 + - **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值。 + +返回 +::::::::: + +:ref:`cn_api_io_cn_Dataset`，TESS 数据集实例。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.datasets.TESS From 3c3fecc530f780bc5712529492b0110eb2ecab52 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Mon, 17 Oct 2022 11:18:36 +0800 Subject: [PATCH 2/9] add overview --- docs/api/paddle/audio/Overview_cn.rst | 37 +++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/api/paddle/audio/Overview_cn.rst diff --git a/docs/api/paddle/audio/Overview_cn.rst b/docs/api/paddle/audio/Overview_cn.rst new file mode 100644 index 00000000000..5b3016bf50a --- /dev/null +++ b/docs/api/paddle/audio/Overview_cn.rst @@ -0,0 +1,37 @@ +.. _cn_overview_callbacks: + +paddle.audio +--------------------- + +paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： + +- :ref:`音频I/O相关 API ` +- :ref:`语音数据集相关 API ` + +.. _about_backends: + +音频特征相关 API +:::::::::::::::::::: + +.. csv-table:: + :header: "API 名称", "API 功能" + :widths: 10, 30 + + " :ref:`get_current_audio_backend ` ", "获取现在的语音I/O后端" + " :ref:`list_available_backends ` ", "获取可设置得语音I/O后端" + " :ref:`set_backend ` ", "设置语音I/O后端" + " :ref:`load ` ", "载入音频" + " :ref:`info ` ", "查询音频信息" + " :ref:`save ` ", "保存音频" + +.. _about_datasets: + +音频数据集相关 API +:::::::::::::::::::: + +.. csv-table:: + :header: "API 名称", "API 功能" + :widths: 10, 30 + + " :ref:`TESS ` ", "TESS数据集" + " :ref:`ESC50 ` ", "ESC50数据集" \ No newline at end of file From d5dee67cc5ec5827b5fa14355dd9dac929e64062 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Mon, 17 Oct 2022 12:46:32 +0800 Subject: [PATCH 3/9] format --- docs/api/paddle/audio/Overview_cn.rst | 12 ++++++------ .../audio/backends/get_current_audio_backend_cn.rst | 6 +++--- docs/api/paddle/audio/backends/info_cn.rst | 2 +- .../audio/backends/list_available_backends_cn.rst | 6 +++--- docs/api/paddle/audio/backends/load_cn.rst | 10 +++++----- docs/api/paddle/audio/backends/save_cn.rst | 8 ++++---- docs/api/paddle/audio/backends/set_backend_cn.rst | 8 ++++---- docs/api/paddle/audio/datasets/ESC50_cn.rst | 6 +++--- docs/api/paddle/audio/datasets/TESS_cn.rst | 10 +++++----- 9 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/api/paddle/audio/Overview_cn.rst b/docs/api/paddle/audio/Overview_cn.rst index 5b3016bf50a..1c0444fc93b 100644 --- a/docs/api/paddle/audio/Overview_cn.rst +++ b/docs/api/paddle/audio/Overview_cn.rst @@ -5,7 +5,7 @@ paddle.audio paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： -- :ref:`音频I/O相关 API ` +- :ref:`音频 I/O 相关 API ` - :ref:`语音数据集相关 API ` .. _about_backends: @@ -17,9 +17,9 @@ paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： :header: "API 名称", "API 功能" :widths: 10, 30 - " :ref:`get_current_audio_backend ` ", "获取现在的语音I/O后端" - " :ref:`list_available_backends ` ", "获取可设置得语音I/O后端" - " :ref:`set_backend ` ", "设置语音I/O后端" + " :ref:`get_current_audio_backend ` ", "获取现在的语音 I/O 后端" + " :ref:`list_available_backends ` ", "获取可设置得语音 I/O 后端" + " :ref:`set_backend ` ", "设置语音 I/O 后端" " :ref:`load ` ", "载入音频" " :ref:`info ` ", "查询音频信息" " :ref:`save ` ", "保存音频" @@ -33,5 +33,5 @@ paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： :header: "API 名称", "API 功能" :widths: 10, 30 - " :ref:`TESS ` ", "TESS数据集" - " :ref:`ESC50 ` ", "ESC50数据集" \ No newline at end of file + " :ref:`TESS ` ", "TESS 数据集" + " :ref:`ESC50 ` ", "ESC50 数据集" diff --git a/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst b/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst index d74e8e26df9..6725fd350de 100644 --- a/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst +++ b/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst @@ -5,7 +5,7 @@ get_current_audio_backend .. py:function:: paddle.audio.backends.get_current_audio_backend() -获取现在的处理语音I/O的后端名称。 +获取现在的处理语音 I/O 的后端名称。 参数 :::::::::::: @@ -13,9 +13,9 @@ get_current_audio_backend 返回 ::::::::: -``str``,语音I/O的后端名称。 +``str``,语音 I/O 的后端名称。 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.get_current_audio_backend \ No newline at end of file +COPY-FROM: paddle.audio.backends.get_current_audio_backend diff --git a/docs/api/paddle/audio/backends/info_cn.rst b/docs/api/paddle/audio/backends/info_cn.rst index a94a44b94fe..25835b5327d 100644 --- a/docs/api/paddle/audio/backends/info_cn.rst +++ b/docs/api/paddle/audio/backends/info_cn.rst @@ -19,4 +19,4 @@ info 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.info \ No newline at end of file +COPY-FROM: paddle.audio.backends.info diff --git a/docs/api/paddle/audio/backends/list_available_backends_cn.rst b/docs/api/paddle/audio/backends/list_available_backends_cn.rst index 1c8faf4d193..16ff216a564 100644 --- a/docs/api/paddle/audio/backends/list_available_backends_cn.rst +++ b/docs/api/paddle/audio/backends/list_available_backends_cn.rst @@ -5,7 +5,7 @@ list_available_backends .. py:function:: paddle.audio.backends.list_available_backends() -获取可用的音频I/O后端。 +获取可用的音频 I/O 后端。 参数 :::::::::::: @@ -13,9 +13,9 @@ list_available_backends 返回 ::::::::: -``List[str]``, 可用的音频I/O后端集合。 +``List[str]``, 可用的音频 I/O 后端集合。 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.list_available_backends \ No newline at end of file +COPY-FROM: paddle.audio.backends.list_available_backends diff --git a/docs/api/paddle/audio/backends/load_cn.rst b/docs/api/paddle/audio/backends/load_cn.rst index 917b49bea9d..03a0008aaca 100644 --- a/docs/api/paddle/audio/backends/load_cn.rst +++ b/docs/api/paddle/audio/backends/load_cn.rst @@ -11,10 +11,10 @@ load :::::::::::: - **filepath** (str 或者 Path) - 输入音频路径。 - - **frame_offset** (int) - 默认是0，开始读取音频起始帧。 - - **num_frames** (int) - 默认是-1，读取音频帧数, -1表示读取全部帧。 - - **normalize** (bool) - 默认是True。如果是True，返回是音频值被规整到[-1.0, 1.0]，如果是False，那么就返回原始值。 - - **channels_first** (bool) - 默认是True。如果是True，那么返回的形状是[channel，time]，如果是False，则是[time, channel]。 + - **frame_offset** (int) - 默认是 0，开始读取音频起始帧。 + - **num_frames** (int) - 默认是-1，读取音频帧数, -1 表示读取全部帧。 + - **normalize** (bool) - 默认是 True。如果是 True，返回是音频值被规整到[-1.0, 1.0]，如果是 False，那么就返回原始值。 + - **channels_first** (bool) - 默认是 True。如果是 True，那么返回的形状是[channel，time]，如果是 False，则是[time, channel]。 返回 ::::::::: @@ -23,4 +23,4 @@ load 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.load \ No newline at end of file +COPY-FROM: paddle.audio.backends.load diff --git a/docs/api/paddle/audio/backends/save_cn.rst b/docs/api/paddle/audio/backends/save_cn.rst index ebe75b1413b..6db05a4b571 100644 --- a/docs/api/paddle/audio/backends/save_cn.rst +++ b/docs/api/paddle/audio/backends/save_cn.rst @@ -13,13 +13,13 @@ save - **filepath** (str 或者 Path) - 保存音频路径。 - **src** (paddle.Tensor) - 音频数据。 - **sample_rate** (int) - 采样率。 - - **channels_first** (bool) - 如果是True，那么src的Tensor形状是[channel，time]，如果是False，则是[time, channel]。 - - **encoding** (Optional[str]) - 默认是None，编码信息。 - - **bits_per_sample** (Optional[int]) - 默认是16。编码位长。 + - **channels_first** (bool) - 如果是 True，那么 src 的 Tensor 形状是[channel，time]，如果是 False，则是[time, channel]。 + - **encoding** (Optional[str]) - 默认是 None，编码信息。 + - **bits_per_sample** (Optional[int]) - 默认是 16。编码位长。 返回 ::::::::: 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.save \ No newline at end of file +COPY-FROM: paddle.audio.backends.save diff --git a/docs/api/paddle/audio/backends/set_backend_cn.rst b/docs/api/paddle/audio/backends/set_backend_cn.rst index 49926fc2335..20baed8950f 100644 --- a/docs/api/paddle/audio/backends/set_backend_cn.rst +++ b/docs/api/paddle/audio/backends/set_backend_cn.rst @@ -5,17 +5,17 @@ set_backend .. py:function:: paddle.audio.backends.set_backend(backend_name: str) -设置处理语音I/O的后端。 +设置处理语音 I/O 的后端。 参数 :::::::::::: - - **backend_name** (str) - 语音I/O后端名称，现支持‘wave_backend’,如果安装了paddleaudio >=1.0.2,则也支持‘soundfile’。 - + - **backend_name** (str) - 语音 I/O 后端名称，现支持‘wave_backend’,如果安装了 paddleaudio >=1.0.2,则也支持‘soundfile’。 + 返回 ::::::::: 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.set_backend \ No newline at end of file +COPY-FROM: paddle.audio.backends.set_backend diff --git a/docs/api/paddle/audio/datasets/ESC50_cn.rst b/docs/api/paddle/audio/datasets/ESC50_cn.rst index bd9de5c6df9..aae7fcfe315 100644 --- a/docs/api/paddle/audio/datasets/ESC50_cn.rst +++ b/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 值。 返回 ::::::::: diff --git a/docs/api/paddle/audio/datasets/TESS_cn.rst b/docs/api/paddle/audio/datasets/TESS_cn.rst index ecd82ff82e2..203b4fe09e0 100644 --- a/docs/api/paddle/audio/datasets/TESS_cn.rst +++ b/docs/api/paddle/audio/datasets/TESS_cn.rst @@ -12,11 +12,11 @@ TESS ::::::::: - **mode** (str，可选) - ``'train'`` 或 ``'dev'`` 模式两者之一，默认值为 ``'train'``。 - - **seed** (int) - 默认是0，指定随机数来对数据进行重新排序。 - - **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值。 + - **seed** (int) - 默认是 0，指定随机数来对数据进行重新排序。 + - **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 值。 返回 ::::::::: From 0b08f858367ca75e4c2597d67afff7273f58a6b2 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Mon, 17 Oct 2022 16:12:24 +0800 Subject: [PATCH 4/9] fix function info --- docs/api/paddle/audio/backends/load_cn.rst | 2 +- docs/api/paddle/audio/backends/save_cn.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/audio/backends/load_cn.rst b/docs/api/paddle/audio/backends/load_cn.rst index 03a0008aaca..a72e9674f98 100644 --- a/docs/api/paddle/audio/backends/load_cn.rst +++ b/docs/api/paddle/audio/backends/load_cn.rst @@ -5,7 +5,7 @@ load .. py:function:: paddle.audio.backends.load(filepath: Union[str, Path], frame_offset: int = 0, num_frames: int = -1, normalize: bool = True, channels_first: bool = True) -获取音频的相关信息，如采用率，通道数等。 +获取音频数据。 参数 :::::::::::: diff --git a/docs/api/paddle/audio/backends/save_cn.rst b/docs/api/paddle/audio/backends/save_cn.rst index 6db05a4b571..ee2fca1e8e5 100644 --- a/docs/api/paddle/audio/backends/save_cn.rst +++ b/docs/api/paddle/audio/backends/save_cn.rst @@ -5,7 +5,7 @@ save .. py:function:: paddle.audio.backends.save(filepath: str, src: paddle.Tensor, sample_rate: int, channels_first: bool = True, encoding: Optional[str] = None, bits_per_sample: Optional[int] = 16) -获取音频的相关信息，如采用率，通道数等。 +保存音频数据。 参数 :::::::::::: From 2b643874ff79fd1727c1fa6dd03ac628cefdc464 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Tue, 18 Oct 2022 16:51:36 +0800 Subject: [PATCH 5/9] rm seed in TESS --- docs/api/paddle/audio/datasets/TESS_cn.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/api/paddle/audio/datasets/TESS_cn.rst b/docs/api/paddle/audio/datasets/TESS_cn.rst index 203b4fe09e0..258d390bd48 100644 --- a/docs/api/paddle/audio/datasets/TESS_cn.rst +++ b/docs/api/paddle/audio/datasets/TESS_cn.rst @@ -3,7 +3,7 @@ TESS ------------------------------- -.. py:class:: paddle.audio.datasets.TESS(mode: str = 'train', seed = 0, n_folds = 5, split = 1, feat_type = 'raw', archive=None, **kwargs) +.. py:class:: paddle.audio.datasets.TESS(mode: str = 'train', n_folds = 5, split = 1, feat_type = 'raw', archive=None, **kwargs) `TESS `_ 数据集的实现。 @@ -12,7 +12,6 @@ TESS ::::::::: - **mode** (str，可选) - ``'train'`` 或 ``'dev'`` 模式两者之一，默认值为 ``'train'``。 - - **seed** (int) - 默认是 0，指定随机数来对数据进行重新排序。 - **n_folds** (int) - 默认是 5，指定把数据集分为的文件夹数目， 1 个文件夹是 dev，其他是 train。 - **split** (int) - 默认是 1，指定 dev 的文件夹。 - **feat_type** (str) - 默认是 raw，raw 是原始语音，支持 mfcc，spectrogram，melspectrogram，logmelspectrogram。指定从音频提取的语音特征。 From 8381be5294227fce6769742309e0ba5625540f74 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Thu, 20 Oct 2022 14:27:41 +0800 Subject: [PATCH 6/9] rename some api --- docs/api/paddle/audio/Overview_cn.rst | 8 +++---- .../backends/get_current_audio_backend_cn.rst | 21 ------------------- .../audio/backends/get_current_backend_cn.rst | 21 +++++++++++++++++++ docs/api/paddle/audio/backends/info_cn.rst | 6 +++--- docs/api/paddle/audio/backends/load_cn.rst | 2 +- docs/api/paddle/audio/backends/save_cn.rst | 6 +++--- 6 files changed, 32 insertions(+), 32 deletions(-) delete mode 100644 docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst create mode 100644 docs/api/paddle/audio/backends/get_current_backend_cn.rst diff --git a/docs/api/paddle/audio/Overview_cn.rst b/docs/api/paddle/audio/Overview_cn.rst index 1c0444fc93b..9f279bf2d82 100644 --- a/docs/api/paddle/audio/Overview_cn.rst +++ b/docs/api/paddle/audio/Overview_cn.rst @@ -17,12 +17,12 @@ paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： :header: "API 名称", "API 功能" :widths: 10, 30 - " :ref:`get_current_audio_backend ` ", "获取现在的语音 I/O 后端" + " :ref:`get_current_backend ` ", "获取现在的语音 I/O 后端" " :ref:`list_available_backends ` ", "获取可设置得语音 I/O 后端" " :ref:`set_backend ` ", "设置语音 I/O 后端" - " :ref:`load ` ", "载入音频" - " :ref:`info ` ", "查询音频信息" - " :ref:`save ` ", "保存音频" + " :ref:`load ` ", "载入音频" + " :ref:`info ` ", "查询音频信息" + " :ref:`save ` ", "保存音频" .. _about_datasets: diff --git a/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst b/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst deleted file mode 100644 index 6725fd350de..00000000000 --- a/docs/api/paddle/audio/backends/get_current_audio_backend_cn.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _cn_api_audio_backends_get_current_audio_backend: - -get_current_audio_backend -------------------------------- - -.. py:function:: paddle.audio.backends.get_current_audio_backend() - -获取现在的处理语音 I/O 的后端名称。 - -参数 -:::::::::::: - -返回 -::::::::: - -``str``,语音 I/O 的后端名称。 - -代码示例 -::::::::: - -COPY-FROM: paddle.audio.backends.get_current_audio_backend diff --git a/docs/api/paddle/audio/backends/get_current_backend_cn.rst b/docs/api/paddle/audio/backends/get_current_backend_cn.rst new file mode 100644 index 00000000000..10cb4e7bebc --- /dev/null +++ b/docs/api/paddle/audio/backends/get_current_backend_cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_audio_backends_get_current_backend: + +get_current_backend +------------------------------- + +.. py:function:: paddle.audio.backends.get_current_backend() + +获取现在的处理语音 I/O 的后端名称。 + +参数 +:::::::::::: + +返回 +::::::::: + +``str``,语音 I/O 的后端名称。 + +代码示例 +::::::::: + +COPY-FROM: paddle.audio.backends.get_current_backend diff --git a/docs/api/paddle/audio/backends/info_cn.rst b/docs/api/paddle/audio/backends/info_cn.rst index 25835b5327d..05578856483 100644 --- a/docs/api/paddle/audio/backends/info_cn.rst +++ b/docs/api/paddle/audio/backends/info_cn.rst @@ -1,9 +1,9 @@ -.. _cn_api_audio_backends_info: +.. _cn_api_audio_info: info ------------------------------- -.. py:function:: paddle.audio.backends.info(filepath:str) +.. py:function:: paddle.audio.info(filepath:str) 获取音频的相关信息，如采用率，通道数等。 @@ -19,4 +19,4 @@ info 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.info +COPY-FROM: paddle.audio.info diff --git a/docs/api/paddle/audio/backends/load_cn.rst b/docs/api/paddle/audio/backends/load_cn.rst index a72e9674f98..5025d18f5cc 100644 --- a/docs/api/paddle/audio/backends/load_cn.rst +++ b/docs/api/paddle/audio/backends/load_cn.rst @@ -23,4 +23,4 @@ load 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.load +COPY-FROM: paddle.audio.load diff --git a/docs/api/paddle/audio/backends/save_cn.rst b/docs/api/paddle/audio/backends/save_cn.rst index ee2fca1e8e5..1ee8e0ba972 100644 --- a/docs/api/paddle/audio/backends/save_cn.rst +++ b/docs/api/paddle/audio/backends/save_cn.rst @@ -1,9 +1,9 @@ -.. _cn_api_audio_backends_save: +.. _cn_api_audio_save: save ------------------------------- -.. py:function:: paddle.audio.backends.save(filepath: str, src: paddle.Tensor, sample_rate: int, channels_first: bool = True, encoding: Optional[str] = None, bits_per_sample: Optional[int] = 16) +.. py:function:: paddle.audio.save(filepath: str, src: paddle.Tensor, sample_rate: int, channels_first: bool = True, encoding: Optional[str] = None, bits_per_sample: Optional[int] = 16) 保存音频数据。 @@ -22,4 +22,4 @@ save 代码示例 ::::::::: -COPY-FROM: paddle.audio.backends.save +COPY-FROM: paddle.audio.save From 44b22bf9f8f673df1a44629506308f3e50f1b76d Mon Sep 17 00:00:00 2001 From: YangZhou Date: Thu, 20 Oct 2022 15:37:45 +0800 Subject: [PATCH 7/9] fix load --- docs/api/paddle/audio/backends/load_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/audio/backends/load_cn.rst b/docs/api/paddle/audio/backends/load_cn.rst index 5025d18f5cc..e36c8fc7d5e 100644 --- a/docs/api/paddle/audio/backends/load_cn.rst +++ b/docs/api/paddle/audio/backends/load_cn.rst @@ -1,9 +1,9 @@ -.. _cn_api_audio_backends_load: +.. _cn_api_audio_load: load ------------------------------- -.. py:function:: paddle.audio.backends.load(filepath: Union[str, Path], frame_offset: int = 0, num_frames: int = -1, normalize: bool = True, channels_first: bool = True) +.. py:function:: paddle.audio.load(filepath: Union[str, Path], frame_offset: int = 0, num_frames: int = -1, normalize: bool = True, channels_first: bool = True) 获取音频数据。 From 05334fa8b87d4624d8dcb21ad0722371e1e1b364 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Thu, 20 Oct 2022 16:36:03 +0800 Subject: [PATCH 8/9] fix return --- docs/api/paddle/audio/backends/save_cn.rst | 1 + docs/api/paddle/audio/backends/set_backend_cn.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/api/paddle/audio/backends/save_cn.rst b/docs/api/paddle/audio/backends/save_cn.rst index 1ee8e0ba972..5e5ab04bce4 100644 --- a/docs/api/paddle/audio/backends/save_cn.rst +++ b/docs/api/paddle/audio/backends/save_cn.rst @@ -18,6 +18,7 @@ save - **bits_per_sample** (Optional[int]) - 默认是 16。编码位长。 返回 ::::::::: +无 代码示例 ::::::::: diff --git a/docs/api/paddle/audio/backends/set_backend_cn.rst b/docs/api/paddle/audio/backends/set_backend_cn.rst index 20baed8950f..9c02a40777d 100644 --- a/docs/api/paddle/audio/backends/set_backend_cn.rst +++ b/docs/api/paddle/audio/backends/set_backend_cn.rst @@ -14,6 +14,7 @@ set_backend 返回 ::::::::: +无 代码示例 ::::::::: From aabf77fa87a79323ea904d7abea6957aa82ea630 Mon Sep 17 00:00:00 2001 From: YangZhou Date: Mon, 24 Oct 2022 10:03:12 +0800 Subject: [PATCH 9/9] fix codestyle --- docs/api/paddle/audio/Overview_cn.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/paddle/audio/Overview_cn.rst b/docs/api/paddle/audio/Overview_cn.rst index d54504a771e..81e66a650ba 100644 --- a/docs/api/paddle/audio/Overview_cn.rst +++ b/docs/api/paddle/audio/Overview_cn.rst @@ -3,6 +3,7 @@ paddle.audio --------------------- + paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： - :ref:`音频特征相关 API ` @@ -44,7 +45,7 @@ paddle.audio 目录是飞桨在语音领域的高层 API。具体如下： .. _about_backends: -音频I/O相关 API +音频 I/O 相关 API :::::::::::::::::::: .. csv-table::