Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[cherry-pick] add audio doc(#5299 #5363 #5378 #5445#5609) #5608

Merged
merged 5 commits into from
Feb 23, 2023

Conversation

SmileGoat
Copy link
Contributor

add audio doc in release2.4

* add audio doc

* fix typo

* fix code link && punctuation

* fix typo

* fix features overivew link

* add example

* fix mfcc doc

* add get_window

* update code example

* rm example

* format

* rm code example in cn
* update audio datasets && backend

* add overview

* format

* fix function info

* rm seed in TESS

* rename some api

* fix load

* fix return

* fix codestyle
…le#5378)

* add general_gaussian in get_window doc

* rm kaiser window
@paddle-bot
Copy link

paddle-bot bot commented Feb 8, 2023

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-5608.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明,请参考:飞桨文档预览工具

@jeff41404 jeff41404 requested a review from Ligoml February 8, 2023 03:11
:::::::::

- **mode** (str,可选) - ``'train'`` 或 ``'dev'`` 模式两者之一,默认值为 ``'train'``。
- **split** (int) - 默认是 1,指定 dev 的文件夹。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

有默认值的应该是可选参数吧~

:::::::::

- **mode** (str,可选) - ``'train'`` 或 ``'dev'`` 模式两者之一,默认值为 ``'train'``。
- **split** (int) - 默认是 1,指定 dev 的文件夹。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **split** (int) - 默认是 1,指定 dev 的文件夹。
- **split** (int,可选) - 默认是 1,指定 dev 的文件夹。

参数
::::::::::::

- **backend_name** (str) - 语音 I/O 后端名称,现支持‘wave_backend’,如果安装了 paddleaudio >=1.0.2,则也支持‘soundfile’。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **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 link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 中英文标点符号不要乱用
  • 如果需要对代码或参数做特殊提示,需要使用``包裹

Copy link
Collaborator

@Ligoml Ligoml left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

抱歉点错了,这个pr暂停合入

---------

Co-authored-by: Ligoml <39876205+Ligoml@users.noreply.github.com>
@SmileGoat SmileGoat changed the title [cherry-pick] add audio doc(#5299 #5363 #5378 #5445) [cherry-pick] add audio doc(#5299 #5363 #5378 #5445#5609) Feb 20, 2023
@dingjiaweiww dingjiaweiww merged commit 10844b7 into PaddlePaddle:release/2.4 Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants