Skip to content

refine docs of elementwise_op etc. #11369

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 12, 2018
Merged

refine docs of elementwise_op etc. #11369

merged 3 commits into from
Jun 12, 2018

Conversation

@luotao1
Copy link
Contributor

@luotao1 luotao1 commented Jun 11, 2018 •
edited
Loading

fix #9188

  1. refine the format and docs of elementwise_xxx_op.
    image
    image

  2. fix typo of sequence_first/last_step.
@luotao1 luotao1 requested review from gongweibao and shanyi15 June 11, 2018 12:15
@luotao1
Copy link
Contributor Author

luotao1 commented Jun 11, 2018

@skylarch
gongweibao
gongweibao requested changes Jun 11, 2018
View reviewed changes
python/paddle/fluid/layers/nn.py Outdated
def sequence_first_step(input):
"""
This funciton get the first step of sequence.
This function get the first step of sequence.
Copy link
Contributor

Choose a reason for hiding this comment

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

get->gets
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done
python/paddle/fluid/layers/nn.py Outdated
def sequence_last_step(input):
"""
This funciton get the last step of sequence.
This function get the last step of sequence.
Copy link
Contributor

Choose a reason for hiding this comment

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

gets
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done
gongweibao
gongweibao reviewed Jun 11, 2018
View reviewed changes
paddle/fluid/operators/elementwise_op.h
set to index of the start dimension to broadcast $Y$ onto $X$.
1. Broadcast $Y$ to match the shape of $X$, where $axis$ is the start dimension index
for broadcasting $Y$ onto $X$.
2. If $axis$ is -1 (default), $axis = rank(X) - rank(Y)$.
Copy link
Contributor

@gongweibao gongweibao Jun 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Need an example when axis=-1?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done
gongweibao
gongweibao previously approved these changes Jun 11, 2018
View reviewed changes
Copy link
Contributor

@gongweibao gongweibao left a comment

Choose a reason for hiding this comment

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

LGTM
@skylarch
Copy link
Collaborator

格式范例：https://github.com/PaddlePaddle/Paddle/blob/develop/doc/fluid/dev/src/fc.py
line 1: extra space before "elementwise_add";
line 2: no period after "Operator"
line 5: please make changes on the format of the clarification of the equation's variables according to the above example.
Missing intro to the function's arguments. For clarity and consistency, please modify the "Parameters" part to match the format of the example above.
@shanyi15 shanyi15 requested a review from skylarch June 12, 2018 03:33
@luotao1
Copy link
Contributor Author

luotao1 commented Jun 12, 2018 •
edited
Loading

@skylarch
line 1. 所有的由C++转过去的，都有空格，需要统一改。
其余已改。效果图：
image
@luotao1 luotao1 merged commit ca4d528 into PaddlePaddle:develop Jun 12, 2018
@luotao1 luotao1 deleted the refine_doc branch June 12, 2018 04:15
@skylarch skylarch requested a review from reyoung June 13, 2018 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PythonAPI

3 participants

@luotao1 @skylarch @gongweibao