Skip to content
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

[Docathon][Add CN Doc No.13] #6366

Merged
merged 5 commits into from
Jan 15, 2024
Merged

[Docathon][Add CN Doc No.13] #6366

merged 5 commits into from
Jan 15, 2024

Conversation

zade23
Copy link
Contributor

@zade23 zade23 commented Dec 8, 2023

PR types

Others

PR changes

Docs

Description

中文文档添加任务

#6193

新增中文文档:

  • paddle.geometric.weighted_sample_neighbors

英文文档链接:

序号 API名称 英文文档地址
13 paddle.geometric.weighted_sample_neighbors https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/geometric/weighted_sample_neighbors_en.html

包含修改 Overview

@DesmonDay @sunzhongkai588

Copy link

paddle-bot bot commented Dec 8, 2023

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


.. py:function:: paddle.geometric.weighted_sample_neighbors(row, colptr, edge_weight, input_nodes, sample_size=- 1, eids=None, return_eids=False, name=None)

此 API 主要用于图学习领域,其主要目的是提供图加权采样方法的高性能。例如,我们获取输入图边缘的 CSC(Compressed Sparse Column,压缩列信息),分别对应 ``row`` 和 ``colptr``,从而将图转换为适用于邻居采样的格式,并且输入的 ``edge_weight`` 也应该与 CSC 格式匹配。
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. 提供图加权采样方法的高性能 -> 提供高性能图加权邻居采样方法;2. 图边缘,边缘两字去掉。

Copy link
Contributor Author

@zade23 zade23 Jan 8, 2024

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

Choose a reason for hiding this comment

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

ok。另外应该回复 done 才对 ^^

@@ -30,6 +30,7 @@ paddle.geometric 目录下包含飞桨框架支持的图领域的相关 API。
:header: "API 名称", "API 功能"

" :ref:`paddle.geometric.sample_neighbors <cn_api_paddle_geometric_sample_neighbors>` ", "无权重邻居采样"
" :ref:`paddle.geometric.weighted_sample_neighbors <cn_api_paddle_geometric_weighted_sample_neighbors>` ", "加权近邻采样"
Copy link
Contributor

Choose a reason for hiding this comment

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

加权邻居采样

Copy link
Contributor Author

@zade23 zade23 Jan 8, 2024

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@DesmonDay DesmonDay left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@sunzhongkai588 sunzhongkai588 left a comment

Choose a reason for hiding this comment

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

LGTM

@luotao1 luotao1 merged commit c77c33f into PaddlePaddle:develop Jan 15, 2024
2 checks passed
@zade23 zade23 deleted the en_doc_13 branch January 15, 2024 05:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants