-
Notifications
You must be signed in to change notification settings - Fork 5.6k
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
Polish documentation #11354
Merged
Merged
Polish documentation #11354
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
reyoung
commented
Jun 11, 2018
•
edited
Loading
edited
- row_conv
- uniform_random
- layer_norm
- create_parameter
- hard_shrink
- ssd_loss
- multiplex
- less_than
- open_recordio_file
- cumsum
- DynamicRNN
- shrink_memory
- double_buffer
- thresholded_relu
- bipartite_match
* row_conv * uniform_random * layer_norm * create_parameter * hard_shrink * ssd_loss
@skylarch Please review the polishment of APIs. |
* less_than * cumsum * multiplex * open_recordio_file
… feature/polish_doc
skylarch
requested changes
Jun 13, 2018
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. API Definition:
2. Function Description
a. Function Description:
i. 缺少标题:layer_norm, create_parameter, multiplex, open_recordio_file, cumsum
ii. 标题除介词外首字母大写,无句号,加粗:row_conv, uniform_random, hard_shrink, ssd_loss, less_than
○ Formula:(如果有API没有formula,可不做修改)row_conv的生成有点问题, ssd_loss, open_recordio_file
○ Symbols' Descriptions if necessary:
○ References if necessary:
• Args Description:生成的是中文,改为英文
○ [Arg’s Name]:
○ [(Data Type, Default Value)]:缺default:row_conv, layer_norm, create_parameter, open_recordio_file
○ [Description]:
• Returns:生成的是中文,改为英文; open_recordio_file’返回类型‘可标在‘返回’里
○ [Name][Shape]:cumsum不需首字母大写
○ Tuple逐个介绍各参数:
• Raises
○ [Exception Type][Condition]:
• Note分条列出:
• Examples:
Done. 其他的看起来都没有问题。 |
@reyoung
|
@skylarch Done and add more documentation ^v^ |
skylarch
approved these changes
Jun 15, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.