dgl.topk_edges

dgl.topk_edges(graph, feat, k, *, descending=True, sortby=None, etype=None)[源码]

通过对 graph 中的边特征 feat 按索引 sortby 进行图范围的 top-k 操作，返回图级别的表示。

如果 descending 设置为 False，则返回 k 个最小元素。

如果 sortby 设置为 None，函数将独立地对所有维度执行 top-k 操作，相当于调用 torch.topk(graph.edata[feat], dim=0)。

参数:

graph (DGLGraph) – 输入图。
feat (str) – 特征字段名。
k (int) – “top-k” 中的 k。
descending (bool) – 控制返回最大元素还是最小元素。
sortby (int, 可选) – 根据哪个特征进行排序。如果为 None，则所有特征独立排序。
etype (str, typle of str, 可选) – 边类型。如果图中只有一种边类型，则可以省略。

返回值:

sorted_feat (Tensor) – 一个形状为 \((B, K, D)\) 的张量，其中 \(B\) 是输入图的批次大小。
sorted_idx (Tensor) – 一个形状为 \((B, K)`(:math:`(B, K, D)\) (如果 sortby 设置为 None) 的张量，其中 \(B\) 是输入图的批次大小，\(D\) 是特征大小。

说明

如果一个示例有 \(n\) 个节点且 \(n<k\)，则 sorted_feat 张量将把从 \(n+1\) 到 \(k\) 行用零填充；

示例

>>> import dgl
>>> import torch as th

创建两个 DGLGraph 对象并初始化它们的边特征。

>>> g1 = dgl.graph(([0, 1, 2, 3], [1, 2, 3, 0]))         # Graph 1
>>> g1.edata['h'] = th.rand(4, 5)
>>> g1.edata['h']
tensor([[0.0297, 0.8307, 0.9140, 0.6702, 0.3346],
        [0.5901, 0.3030, 0.9280, 0.6893, 0.7997],
        [0.0880, 0.6515, 0.4451, 0.7507, 0.5297],
        [0.5171, 0.6379, 0.2695, 0.8954, 0.5197]])

>>> g2 = dgl.graph(([0, 1, 2, 3, 4], [1, 2, 3, 4, 0]))   # Graph 2
>>> g2.edata['h'] = th.rand(5, 5)
>>> g2.edata['h']
tensor([[0.3168, 0.3174, 0.5303, 0.0804, 0.3808],
        [0.1323, 0.2766, 0.4318, 0.6114, 0.1458],
        [0.1752, 0.9105, 0.5692, 0.8489, 0.0539],
        [0.1931, 0.4954, 0.3455, 0.3934, 0.0857],
        [0.5065, 0.5182, 0.5418, 0.1520, 0.3872]])

在批处理图中对边属性 h 进行 Top-k 操作。

>>> bg = dgl.batch([g1, g2], edata=['h'])
>>> dgl.topk_edges(bg, 'h', 3)
(tensor([[[0.5901, 0.8307, 0.9280, 0.8954, 0.7997],
          [0.5171, 0.6515, 0.9140, 0.7507, 0.5297],
          [0.0880, 0.6379, 0.4451, 0.6893, 0.5197]],
         [[0.5065, 0.9105, 0.5692, 0.8489, 0.3872],
          [0.3168, 0.5182, 0.5418, 0.6114, 0.3808],
          [0.1931, 0.4954, 0.5303, 0.3934, 0.1458]]]), tensor([[[1, 0, 1, 3, 1],
          [3, 2, 0, 2, 2],
          [2, 3, 2, 1, 3]],
         [[4, 2, 2, 2, 4],
          [0, 4, 4, 1, 0],
          [3, 3, 0, 3, 1]]]))

在批处理图中沿索引 -1 对边属性 h 进行 Top-k 操作。（用于 SortPooling）

>>> dgl.topk_edges(bg, 'h', 3, sortby=-1)
(tensor([[[0.5901, 0.3030, 0.9280, 0.6893, 0.7997],
          [0.0880, 0.6515, 0.4451, 0.7507, 0.5297],
          [0.5171, 0.6379, 0.2695, 0.8954, 0.5197]],
         [[0.5065, 0.5182, 0.5418, 0.1520, 0.3872],
          [0.3168, 0.3174, 0.5303, 0.0804, 0.3808],
          [0.1323, 0.2766, 0.4318, 0.6114, 0.1458]]]), tensor([[1, 2, 3],
         [4, 0, 1]]))

在单个图中对边属性 h 进行 Top-k 操作。

>>> dgl.topk_edges(g1, 'h', 3)
(tensor([[[0.5901, 0.8307, 0.9280, 0.8954, 0.7997],
          [0.5171, 0.6515, 0.9140, 0.7507, 0.5297],
          [0.0880, 0.6379, 0.4451, 0.6893, 0.5197]]]), tensor([[[1, 0, 1, 3, 1],
          [3, 2, 0, 2, 2],
          [2, 3, 2, 1, 3]]]))