Skip to content

GitLab

"...en/git@developer.sourcefind.cn:renzhc/diffusers_dcu.git" did not exist on "537891e6938257b11611fc2cbd08f1255423987b"
Unverified Commit 08c50eb7 authored by czkkkkkk's avatar czkkkkkk Committed by GitHub
Browse files

[Subgraph] State in the docstring that nodes cannot have any duplicate value... 

[Subgraph] State in the docstring that nodes cannot have any duplicate value when inducing a subgraph (#4637)
parent 544a2cd1
Show whitespace changes
Inline Side-by-side
Showing with 10 additions and 5 deletions
python/dgl/subgraph.py
View file @ 08c50eb7
...@@ -34,7 +34,8 @@ def node_subgraph(graph, nodes, *, relabel_nodes=True, store_ids=True, output_de ...@@ -34,7 +34,8 @@ def node_subgraph(graph, nodes, *, relabel_nodes=True, store_ids=True, output_de
graph : DGLGraph graph : DGLGraph
The graph to extract subgraphs from. The graph to extract subgraphs from.
nodes : nodes or dict[str, nodes] nodes : nodes or dict[str, nodes]
The nodes to form the subgraph. The allowed nodes formats are: The nodes to form the subgraph, which cannot have any duplicate value. The result
will be undefined otherwise. The allowed nodes formats are:
* Int Tensor: Each element is a node ID. The tensor must have the same device type * Int Tensor: Each element is a node ID. The tensor must have the same device type
and ID data type as the graph's. and ID data type as the graph's.
...@@ -333,7 +334,8 @@ def in_subgraph(graph, nodes, *, relabel_nodes=False, store_ids=True, output_dev ...@@ -333,7 +334,8 @@ def in_subgraph(graph, nodes, *, relabel_nodes=False, store_ids=True, output_dev
graph : DGLGraph graph : DGLGraph
The input graph. The input graph.
nodes : nodes or dict[str, nodes] nodes : nodes or dict[str, nodes]
The nodes to form the subgraph. The allowed nodes formats are: The nodes to form the subgraph, which cannot have any duplicate value. The result
will be undefined otherwise. The allowed nodes formats are:
* Int Tensor: Each element is a node ID. The tensor must have the same device type * Int Tensor: Each element is a node ID. The tensor must have the same device type
and ID data type as the graph's. and ID data type as the graph's.
...@@ -460,7 +462,8 @@ def out_subgraph(graph, nodes, *, relabel_nodes=False, store_ids=True, output_de ...@@ -460,7 +462,8 @@ def out_subgraph(graph, nodes, *, relabel_nodes=False, store_ids=True, output_de
graph : DGLGraph graph : DGLGraph
The input graph. The input graph.
nodes : nodes or dict[str, nodes] nodes : nodes or dict[str, nodes]
The nodes to form the subgraph. The allowed nodes formats are: The nodes to form the subgraph, which cannot have any duplicate value. The result
will be undefined otherwise. The allowed nodes formats are:
* Int Tensor: Each element is a node ID. The tensor must have the same device type * Int Tensor: Each element is a node ID. The tensor must have the same device type
and ID data type as the graph's. and ID data type as the graph's.
...@@ -588,7 +591,8 @@ def khop_in_subgraph(graph, nodes, k, *, relabel_nodes=True, store_ids=True, out ...@@ -588,7 +591,8 @@ def khop_in_subgraph(graph, nodes, k, *, relabel_nodes=True, store_ids=True, out
graph : DGLGraph graph : DGLGraph
The input graph. The input graph.
nodes : nodes or dict[str, nodes] nodes : nodes or dict[str, nodes]
The starting node(s) to expand. The allowed formats are: The starting node(s) to expand, which cannot have any duplicate value. The result
will be undefined otherwise. The allowed formats are:
* Int: ID of a single node. * Int: ID of a single node.
* Int Tensor: Each element is a node ID. The tensor must have the same device * Int Tensor: Each element is a node ID. The tensor must have the same device
...@@ -749,7 +753,8 @@ def khop_out_subgraph(graph, nodes, k, *, relabel_nodes=True, store_ids=True, ou ...@@ -749,7 +753,8 @@ def khop_out_subgraph(graph, nodes, k, *, relabel_nodes=True, store_ids=True, ou
graph : DGLGraph graph : DGLGraph
The input graph. The input graph.
nodes : nodes or dict[str, nodes] nodes : nodes or dict[str, nodes]
The starting node(s) to expand. The allowed formats are: The starting node(s) to expand, which cannot have any duplicate value. The result
will be undefined otherwise. The allowed formats are:
* Int: ID of a single node. * Int: ID of a single node.
* Int Tensor: Each element is a node ID. The tensor must have the same device * Int Tensor: Each element is a node ID. The tensor must have the same device
......
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