Add paddle.geometric docs #5292

DesmonDay · 2022-09-20T16:21:56Z

Add docs for paddle.geometric APIs.

paddle-bot · 2022-09-20T16:22:00Z

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

momozi1996 · 2022-09-21T09:31:41Z

docs/api/paddle/geometric/segment_max_cn.rst

+
+.. math::
+
+    out_i = \max_{j \in \{segment\_ids_j == i \} } data_{j}


公式预览是这样，是否有问题？

这个没有问题，确实是这样

momozi1996 · 2022-09-21T09:32:51Z

docs/api/paddle/geometric/segment_max_cn.rst

+参数
+:::::::::
+    - **data** (Tensor) - 张量，数据类型为 float32、float64。
+    - **segment_ids** (Tensor) - 一维张量，与输入数据`data`的第一维大小相同，表示`data`分段位置，单调非减。合法的数据类型为 int32、int64。


data 这里，或许是 data

``双引号

momozi1996 · 2022-09-21T09:41:34Z

docs/api/paddle/geometric/segment_mean_cn.rst

+
+.. math::
+
+    out_i = \mathop{mean}_{j \in \{segment\_ids_j == i \} } data_{j}


同，公式有问题不？

momozi1996 · 2022-09-21T09:41:57Z

docs/api/paddle/geometric/segment_mean_cn.rst

+参数
+:::::::::
+    - **data** (Tensor) - 张量，数据类型为 float32、float64。
+    - **segment_ids** (Tensor) - 一维张量，与输入数据`data`的第一维大小相同，表示`data`分段位置，单调非减。合法的数据类型为 int32、int64。


momozi1996 · 2022-09-21T09:43:06Z

docs/api/paddle/geometric/segment_min_cn.rst

+
+.. math::
+
+    out_i = \min_{j \in \{segment\_ids_j == i \} } data_{j}


同公式，下标太长，有点

momozi1996 · 2022-09-21T09:45:48Z

docs/api/paddle/geometric/send_uv_cn.rst

+
+参数
+:::::::::
+    - x (Tensor) - 输入的节点特征Tensor，数据类型为：float32、float64、int32、int64。另外，我们在 GPU 计算中支持 float16。


** 加粗，前4个参数

momozi1996 · 2022-09-21T09:46:09Z

docs/api/paddle/geometric/send_ue_recv_cn.rst

+
+参数
+:::::::::
+    - x (Tensor) - 输入的节点特征Tensor，数据类型为：float32、float64、int32、int64。另外，我们在 GPU 计算中支持 float16。


momozi1996 · 2022-09-21T09:46:22Z

docs/api/paddle/geometric/send_uv_cn.rst

+:::::::::
+    - x (Tensor) - 输入的节点特征Tensor，数据类型为：float32、float64、int32、int64。另外，我们在 GPU 计算中支持 float16。
+    - src_index (Tensor) - 1-D Tensor，数据类型为：int32、int64。
+    - dst_index (Tensor) - 1-D Tensor，数据类型为：int32、int64。注意：``dst_index`` 的形状应当与 ``src_index`` 一致。


momozi1996 · 2022-09-21T09:46:59Z

docs/api/paddle/geometric/reindex_graph_cn.rst

+
+参数
+:::::::::
+    - x (Tensor) - 输入的中心节点原始编号，数据类型为：int32、int64。


参数这里，都加粗一下～

momozi1996

一点点小问题

DesmonDay · 2022-09-22T06:50:07Z

除公式问题不做修改外，其余均已修改。

wawltor · 2022-09-23T02:33:45Z

docs/api/paddle/geometric/Overview_cn.rst

+
+    " :ref:`paddle.geometric.send_u_recv <cn_api_paddle_geometric_send_u_recv>` ", "源节点特征消息传递"
+    " :ref:`paddle.geometric.send_ue_recv <cn_api_paddle_geometric_send_ue_recv>` ", "节点融合边特征消息传递"
+    " :ref:`paddle.geometric.send_uv <cn_api_paddle_geometric_send_uv>` ", "节点特征消息发送"


这里和上面源节点特征消息传递的区别没有特别说清楚

momozi1996

LGTM

Ligoml · 2022-10-11T02:47:23Z

docs/api/paddle/geometric/reindex_graph_cn.rst

+
+主要应用于图学习领域，需要与图采样相关的 API 配合使用，主要处理同构图场景。其主要目的是对输入的中心节点信息和邻居信息进行从 0 开始的重新编号，以方便后续的图模型子图训练。
+
+**注意**：输入 ``x`` 中的元素需保证是独有的，否则可能会带来一些潜在的错误。输入的节点将会和邻居节点一同从0进行编号。


使用可解析的note格式吧，参考：https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/dev_guides/api_contributing_guides/api_docs_guidelines_cn.html#zhujie

* add paddle.geometric

* Add paddle.geometric docs (#5292) * add paddle.geometric * [geometric] delete sampling and message_passing directory (#5427)

add paddle.geometric

aa20a24

DesmonDay added 2 commits September 21, 2022 00:27

fix bug

fbc91f4

fix doc

de59764

momozi1996 reviewed Sep 21, 2022

View reviewed changes

DesmonDay added 2 commits September 21, 2022 13:55

add overview

a11a3c8

fix format

f6ac6ef

wawltor reviewed Sep 23, 2022

View reviewed changes

update overview

3f51ac8

momozi1996 approved these changes Sep 28, 2022

View reviewed changes

Ligoml reviewed Oct 11, 2022

View reviewed changes

DesmonDay added 2 commits October 11, 2022 02:54

fix code style

4b377ca

add note

c2e4e53

DesmonDay merged commit fab7bcb into PaddlePaddle:develop Oct 11, 2022

DesmonDay added a commit to DesmonDay/docs that referenced this pull request Oct 11, 2022

Add paddle.geometric docs (PaddlePaddle#5292)

c866cd7

* add paddle.geometric

DesmonDay mentioned this pull request Oct 11, 2022

Add paddle.geometric docs (#5292) #5344

Merged

jzhang533 pushed a commit that referenced this pull request Oct 25, 2022

Add paddle.geometric docs (#5292) (#5344)

7914d20

* add paddle.geometric

jzhang533 pushed a commit that referenced this pull request Nov 21, 2022

[cherry-pick] Delete geometric api release 2.4 (#5435)

084af18

* Add paddle.geometric docs (#5292) * add paddle.geometric * [geometric] delete sampling and message_passing directory (#5427)


		.. math::

		out_i = \max_{j \in \{segment\_ids_j == i \} } data_{j}


		.. math::

		out_i = \mathop{mean}_{j \in \{segment\_ids_j == i \} } data_{j}


		.. math::

		out_i = \min_{j \in \{segment\_ids_j == i \} } data_{j}


		主要应用于图学习领域，需要与图采样相关的 API 配合使用，主要处理同构图场景。其主要目的是对输入的中心节点信息和邻居信息进行从 0 开始的重新编号，以方便后续的图模型子图训练。

		注意：输入 ``x`` 中的元素需保证是独有的，否则可能会带来一些潜在的错误。输入的节点将会和邻居节点一同从0进行编号。

Add paddle.geometric docs #5292

Add paddle.geometric docs #5292

Uh oh!

Conversation

DesmonDay commented Sep 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

paddle-bot bot commented Sep 20, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

momozi1996 left a comment

Choose a reason for hiding this comment

Uh oh!

DesmonDay commented Sep 22, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

momozi1996 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DesmonDay commented Sep 20, 2022 •

edited

Loading