dgl.DGLGraph.edges

property DGLGraph.edges

返回一个边的视图

可以使用它来:

  1. 获取单一类型的边。在这种情况下,它可以接受以下可选参数:

    • formstr, optional

      返回形式,可以是以下之一:

      • 'uv' (默认): 返回的结果是一个包含两个一维张量的元组 \((U, V)\),表示所有边的源节点和目标节点。 对于每个 \(i\)\((U[i], V[i])\) 形成一条边。

      • 'eid': 返回结果是一个一维张量 \(EID\),表示所有边的ID。

      • 'all': 返回的结果是一个包含三个一维张量的元组 \((U, V, EID)\), 分别表示所有边的源节点、目标节点和边的ID。 对于每个 \(i\)\((U[i], V[i])\) 形成一个边,其ID为 \(EID[i]\)

    • orderstr, optional

      返回边的顺序,可以是以下之一:

      • 'eid' (默认): 边按其ID排序。

      • 'srcdst': 边首先按其源节点ID排序,然后按其目标节点ID排序以打破平局。

    • etypestr or tuple of str, optional

      查询的边类型,可以是边类型(str)或规范边类型(3元组的str)。当一个边类型出现在多个规范边类型中时,必须使用规范边类型。如果图有多个边类型,则必须指定该参数。否则,可以省略。

  2. 为单一类型的边设置/获取特征。要在图g中为类型为etype的边设置/获取特征feat,可以使用g.edges[etype].data[feat]

示例

以下示例使用PyTorch后端。

>>> import dgl
>>> import torch

获取单一边缘类型的边缘

创建一个具有单一边类型的图。

>>> g = dgl.graph((torch.tensor([1, 0, 0]), torch.tensor([1, 1, 0])))
>>> g.edges()
(tensor([1, 0, 0]), tensor([1, 1, 0]))

formorder指定不同的值。

>>> g.edges(form='all', order='srcdst')
(tensor([0, 0, 1]), tensor([0, 1, 1]), tensor([2, 1, 0]))

对于具有多种边类型的图,需要在查询中指定边类型。

>>> hg = dgl.heterograph({
...     ('user', 'follows', 'user'): (torch.tensor([0, 1]), torch.tensor([1, 2])),
...     ('user', 'plays', 'game'): (torch.tensor([3, 4]), torch.tensor([5, 6]))
... })
>>> hg.edges(etype='plays')
(tensor([3, 4]), tensor([5, 6]))

为单一类型的边设置/获取所有边的特征

创建一个包含两种边类型的异构图。

>>> hg = dgl.heterograph({
...     ('user', 'follows', 'user'): (torch.tensor([0, 1]), torch.tensor([1, 2])),
...     ('user', 'plays', 'game'): (torch.tensor([3, 4]), torch.tensor([5, 6]))
... })

为异构图中的单一类型的所有边设置并获取特征‘h’。

>>> hg.edges['follows'].data['h'] = torch.ones(2, 1)
>>> hg.edges['follows'].data['h']
tensor([[1.], [1.]])

要为具有单一边缘类型的图设置边缘特征,请使用 DGLGraph.edata()

另请参阅

edata