Unverified Commit d3176272 authored by yxy235's avatar yxy235 Committed by GitHub
Browse files

[GraphBolt] Update docstring of sampled subgraph. (#6998)


Co-authored-by: default avatarUbuntu <ubuntu@ip-172-31-0-133.us-west-2.compute.internal>
Co-authored-by: default avatarHongzhi (Steve), Chen <chenhongzhi.nkcs@gmail.com>
parent 56b6a4eb
...@@ -30,9 +30,10 @@ class SampledSubgraph: ...@@ -30,9 +30,10 @@ class SampledSubgraph:
self, self,
) -> Union[CSCFormatBase, Dict[str, CSCFormatBase],]: ) -> Union[CSCFormatBase, Dict[str, CSCFormatBase],]:
"""Returns the node pairs representing edges in csc format. """Returns the node pairs representing edges in csc format.
- If `sampled_csc` is a CSCFormatBase: It should be in the csc format. - If `sampled_csc` is a CSCFormatBase: It should be in the csc
`indptr` stores the index in the data array where each column format. `indptr` stores the index in the data array where each
starts. `indices` stores the row indices of the non-zero elements. column starts. `indices` stores the row indices of the non-zero
elements.
- If `sampled_csc` is a dictionary: The keys should be edge type and - If `sampled_csc` is a dictionary: The keys should be edge type and
the values should be corresponding node pairs. The ids inside is the values should be corresponding node pairs. The ids inside is
heterogeneous ids. heterogeneous ids.
...@@ -40,6 +41,7 @@ class SampledSubgraph: ...@@ -40,6 +41,7 @@ class SampledSubgraph:
Examples Examples
-------- --------
1. Homogeneous graph. 1. Homogeneous graph.
>>> import dgl.graphbolt as gb >>> import dgl.graphbolt as gb
>>> import torch >>> import torch
>>> sampled_csc = gb.CSCFormatBase( >>> sampled_csc = gb.CSCFormatBase(
...@@ -51,6 +53,7 @@ class SampledSubgraph: ...@@ -51,6 +53,7 @@ class SampledSubgraph:
) )
2. Heterogeneous graph. 2. Heterogeneous graph.
sampled_csc = {"A:relation:B": gb.CSCFormatBase( sampled_csc = {"A:relation:B": gb.CSCFormatBase(
... indptr=torch.tensor([0, 1, 2, 3]), ... indptr=torch.tensor([0, 1, 2, 3]),
... indices=torch.tensor([0, 1, 2]))} ... indices=torch.tensor([0, 1, 2]))}
...@@ -69,8 +72,8 @@ class SampledSubgraph: ...@@ -69,8 +72,8 @@ class SampledSubgraph:
Column's reverse node ids in the original graph. A graph structure Column's reverse node ids in the original graph. A graph structure
can be treated as a coordinated row and column pair, and this is can be treated as a coordinated row and column pair, and this is
the mapped ids of the column. the mapped ids of the column.
- If `original_column_node_ids` is a tensor: It represents the original - If `original_column_node_ids` is a tensor: It represents the
node ids. original node ids.
- If `original_column_node_ids` is a dictionary: The keys should be - If `original_column_node_ids` is a dictionary: The keys should be
node type and the values should be corresponding original node type and the values should be corresponding original
heterogeneous node ids. heterogeneous node ids.
...@@ -103,9 +106,9 @@ class SampledSubgraph: ...@@ -103,9 +106,9 @@ class SampledSubgraph:
features are needed. features are needed.
- If `original_edge_ids` is a tensor: It represents the original edge - If `original_edge_ids` is a tensor: It represents the original edge
ids. ids.
- If `original_edge_ids` is a dictionary: The keys should be edge type - If `original_edge_ids` is a dictionary: The keys should be edge
and the values should be corresponding original heterogeneous edge type and the values should be corresponding original heterogeneous
ids. edge ids.
""" """
return None return None
...@@ -119,10 +122,10 @@ class SampledSubgraph: ...@@ -119,10 +122,10 @@ class SampledSubgraph:
): ):
r"""Exclude edges from the sampled subgraph. r"""Exclude edges from the sampled subgraph.
This function can be used with sampled subgraphs, regardless of whether they This function can be used with sampled subgraphs, regardless of
have compacted row/column nodes or not. If the original subgraph has whether they have compacted row/column nodes or not. If the original
compacted row or column nodes, the corresponding row or column nodes in the subgraph has compacted row or column nodes, the corresponding row or
returned subgraph will also be compacted. column nodes in the returned subgraph will also be compacted.
Parameters Parameters
---------- ----------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment