[GraphBolt][Doc] Clarify gb.fused_csc_sampling_graph type_per_edge arg. (#7771)

This commit is contained in:
Muhammed Fatih BALIN
2024-09-04 01:27:50 -04:00
committed by GitHub
parent b60ad557f5
commit 8fd6c68031

View File

@@ -1589,7 +1589,11 @@ def fused_csc_sampling_graph(
node_type_offset : Optional[torch.tensor], optional
Offset of node types in the graph, by default None.
type_per_edge : Optional[torch.tensor], optional
Type ids of each edge in the graph, by default None.
Type ids of each edge in the graph, by default None. If provided, it is
required that the edge types in each vertex neighborhood are in sorted
order. To be more precise, For each i in [0, csc_indptr.size(0) - 1),
`type_per_edge[indptr[i]: indptr[i + 1]]` is expected to be
monotonically nondecreasing.
node_type_to_id : Optional[Dict[str, int]], optional
Map node types to ids, by default None.
edge_type_to_id : Optional[Dict[str, int]], optional