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

[Docathon] Fix save API Docs #6457

Merged
merged 2 commits into from
Jan 18, 2024
Merged

[Docathon] Fix save API Docs #6457

merged 2 commits into from
Jan 18, 2024

Conversation

Turingg
Copy link
Contributor

@Turingg Turingg commented Jan 9, 2024

PR types
Bug fixes

PR changes
Docs

Description
Issue from:#6187

涉及到的 API 有:paddle\jit\save_cn.rst

@sunzhongkai588

中英文档 input_spec 参数 描述表达不一致,中文需要补充“支持的参数类型”
Copy link

paddle-bot bot commented Jan 9, 2024

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

@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Jan 10, 2024
@@ -24,7 +24,7 @@ save
:::::::::
- **layer** (Layer|function) - 需要存储的 ``Layer`` 对象或者 ``function``。
- **path** (str) - 存储模型的路径前缀。格式为 ``dirname/file_prefix`` 或者 ``file_prefix`` 。
- **input_spec** (list[InputSpec|Tensor],可选) - 描述存储模型 forward 方法的输入,可以通过 InputSpec 或者示例 Tensor 进行描述。如果为 ``None``,所有原 ``Layer`` forward 方法的输入变量将都会被配置为存储模型的输入变量。默认为 ``None``。
- **input_spec** (list or tuple[InputSpec|Tensor|Python built-in variable], 可选) - 描述存储模型 forward 方法的输入,可以通过 InputSpec 或者示例 Tensor 进行描述。此外,我们还支持指定非张量类型的参数,比如 int、float、string,或者这些类型的列表/字典。如果为 ``None``,所有原 ``Layer`` forward 方法的输入变量将都会被配置为存储模型的输入变量。默认为 ``None``。
Copy link
Member

Choose a reason for hiding this comment

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

确认下,这里其他「可选」前面用的是英文逗号么?我咋记得是中文逗号?

Copy link
Member

@SigureMo SigureMo left a comment

Choose a reason for hiding this comment

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

LGTMeow

@luotao1 luotao1 merged commit 8622004 into PaddlePaddle:develop Jan 18, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants