Skip to content

Add paddle.incubate.graph_send_recv API docs #4104

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 9 commits into from
Nov 23, 2021
Merged

Add paddle.incubate.graph_send_recv API docs #4104

merged 9 commits into from
Nov 23, 2021

Conversation

@DesmonDay
Copy link
Contributor

@DesmonDay DesmonDay commented Nov 17, 2021 •
edited
Loading

Add doc for paddle.incubate.graph_send_recv api.
The origin PR is Paddle PR 37205.

中文文档：
image

英文文档：
image

@paddle-bot-old
Copy link

paddle-bot-old bot commented Nov 17, 2021

Thanks for your contribution!

wawltor
wawltor reviewed Nov 17, 2021
View reviewed changes
docs/api/paddle/incubate/send_recv_cn.rst Outdated

.. py:function:: paddle.incubate.send_recv(x, src_index, dst_index, pool_type="sum", name=None)

此API主要应用于图领域，目的是为了减少在消息传递过程中带来的中间变量显存或内存的损耗。其中，``x``作为输入Tensor，首先利用``src_index``作为索引来gather出在``x``中相应位置的条目，随后再将gather出的结果利用``dst_index``来scatter到对应的输出结果中，其中``pool_type``表示scatter的不同处理方式，包括sum、mean、max、min共计4种处理模式。
Copy link
Contributor

@wawltor wawltor Nov 17, 2021

Choose a reason for hiding this comment

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

图领域->图学习领域，条目-> 数据

Copy link
Contributor Author

@DesmonDay DesmonDay Nov 17, 2021

Choose a reason for hiding this comment

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

done

wawltor
wawltor reviewed Nov 17, 2021
View reviewed changes
docs/api/paddle/incubate/send_recv_cn.rst Outdated
.. code-block:: python

import paddle
import numpy as np
Copy link
Contributor

@wawltor wawltor Nov 17, 2021

Choose a reason for hiding this comment

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

numpy提前

在import后面留一个空行

Copy link
Contributor Author

@DesmonDay DesmonDay Nov 17, 2021

Choose a reason for hiding this comment

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

done

Copy link
Contributor Author

@DesmonDay DesmonDay Nov 18, 2021

Choose a reason for hiding this comment

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

已删除 numpy

@CLAassistant
Copy link

CLAassistant commented Nov 18, 2021 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@DesmonDay DesmonDay changed the title Add paddle.incubate.send_recv API docs Add paddle.incubate.graph_send_recv API docs Nov 18, 2021
wawltor
wawltor approved these changes Nov 19, 2021
View reviewed changes
Copy link
Contributor

@wawltor wawltor left a comment

Choose a reason for hiding this comment

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

LGTM

@DesmonDay DesmonDay mentioned this pull request Nov 22, 2021
Merged
@wawltor wawltor merged commit 79874e0 into PaddlePaddle:develop Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TCChenlong TCChenlong TCChenlong approved these changes

@wawltor wawltor wawltor approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@DesmonDay @CLAassistant @TCChenlong @wawltor