Skip to content

Comments

Polish documentation#11354

Merged
reyoung merged 8 commits intoPaddlePaddle:developfrom
reyoung:feature/polish_doc
Jun 15, 2018
Merged

Polish documentation#11354
reyoung merged 8 commits intoPaddlePaddle:developfrom
reyoung:feature/polish_doc

Conversation

@reyoung
Copy link
Collaborator

@reyoung reyoung commented Jun 11, 2018

* row_conv
* uniform_random
* layer_norm
* create_parameter
* hard_shrink
* ssd_loss
@reyoung reyoung requested a review from shanyi15 June 11, 2018 07:34
@reyoung
Copy link
Collaborator Author

reyoung commented Jun 11, 2018

@skylarch Please review the polishment of APIs.

reyoung added 2 commits June 12, 2018 17:54
* less_than
* cumsum
* multiplex
* open_recordio_file
Copy link
Collaborator

@skylarch skylarch left a comment

Choose a reason for hiding this comment

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

@reyoung

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:

@reyoung
Copy link
Collaborator Author

reyoung commented Jun 13, 2018

@skylarch

○ [Name][Shape]:cumsum不需首字母大写

Done.

其他的看起来都没有问题。

@skylarch
Copy link
Collaborator

skylarch commented Jun 13, 2018

@reyoung
comment已根据最新标准更新,可以开始做修改。

	a. Function Description标题:
		i. 缺少:cumsum
		ii. 多余:less_than 
	○ Formula:(如果有API没有formula,可不做修改)multiplex "For i-th row of the output tensor"后的公式生成错误

@reyoung
Copy link
Collaborator Author

reyoung commented Jun 14, 2018

@skylarch Done and add more documentation ^v^

@skylarch
Copy link
Collaborator

skylarch commented Jun 15, 2018

DynamicRNN:
例子的格式和其他API例子不统一
lod_tensor最好用超链接
screen shot 2018-06-15 at 11 34 56 am

shrink_memory
如果有相关文档,DynamicRNN的implementation可用超链接
screen shot 2018-06-15 at 11 38 36 am

cumsum:
缺标题

@reyoung reyoung merged commit 745ea4d into PaddlePaddle:develop Jun 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants