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

[audio] fix optional in audio doc #5609

Merged
merged 13 commits into from
Feb 17, 2023
Merged

Conversation

SmileGoat
Copy link
Contributor

@SmileGoat SmileGoat commented Feb 8, 2023

fix optional in audio doc

@paddle-bot
Copy link

paddle-bot bot commented Feb 8, 2023

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

@paddle-bot
Copy link

paddle-bot bot commented Feb 8, 2023

❌ The PR's message can't be empty.

- **htk** (bool) -是否使用 htk 缩放。
- **norm** (Union[str,float]) -norm 的类型,默认是'slaney'。
- **dtype** (str) - 返回矩阵的数据类型,默认'float32'。
- **n_mels** (float,可选) - mels bins 的数目。
Copy link
Collaborator

Choose a reason for hiding this comment

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

可选参数是不是需要注明默认值?

@@ -12,8 +12,8 @@ create_dct

- **n_mfcc** (float) - mel 倒谱系数数目。
- **n_mels** (int) - mel 的 fliterbank 数。
- **norm** (float) - 正则化类型, 默认值是'ortho'。
- **dtype** (str) - 默认'float32'。
- **norm** (float,可选) - 正则化类型, 默认值是'ortho'。
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
- **norm** (float,可选) - 正则化类型, 默认值是'ortho'。
- **norm** (float,可选) - 正则化类型默认值是'ortho'。

@@ -12,8 +12,8 @@ get_window

- **window** (str 或者 Tuple[str, float]) - 窗函数类型,或者(窗参数类型, 窗函数参数), 支持的窗函数类型'hamming', 'hann', 'gaussian', 'general_gaussian', 'exponential', 'triang', 'bohman', 'blackman', 'cosine', 'tukey', 'taylor'。
- **win_length** (int) - 采样点数。
- **fftbins** (bool) - 如果是 True,给出一个周期性的窗, 如果是 False 给出一个对称性的窗,默认是 True。
- **dtype** (str) - 默认'float64'。
- **fftbins** (bool,可选) - 如果是 True,给出一个周期性的窗, 如果是 False 给出一个对称性的窗,默认是 True。
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
- **fftbins** (bool,可选) - 如果是 True,给出一个周期性的窗, 如果是 False 给出一个对称性的窗,默认是 True。
- **fftbins** (bool,可选) - 如果是 True给出一个周期性的窗如果是 False 给出一个对称性的窗默认是 True。

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.

LGTM for docs

@luotao1 luotao1 merged commit 88caecb into PaddlePaddle:develop Feb 17, 2023
SmileGoat added a commit to SmileGoat/paddlepaddle_docs that referenced this pull request Feb 20, 2023
---------

Co-authored-by: Ligoml <39876205+Ligoml@users.noreply.github.com>
dingjiaweiww pushed a commit that referenced this pull request Feb 23, 2023
* add audio doc (#5299)

* 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 (#5363)

* update audio datasets && backend

* add overview

* format

* fix function info

* rm seed in TESS

* rename some api

* fix load

* fix return

* fix codestyle

* [audio] add general_gaussian, rm kaiser in get_window doc (#5378)

* add general_gaussian in get_window doc

* rm kaiser window

* audio backends fix (#5445)

* [audio] fix optional in audio doc (#5609)

---------

Co-authored-by: Ligoml <39876205+Ligoml@users.noreply.github.com>

---------

Co-authored-by: Ligoml <39876205+Ligoml@users.noreply.github.com>
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