dgl.DGLGraph.in_degrees

DGLGraph.in_degrees(v='__ALL__', etype=None)[source]

返回给定节点的入度。

对于给定边类型,它计算节点的入度。

参数:
  • v (节点 ID) –

    节点 ID。允许的格式包括

    • int: 单个节点。

    • Int Tensor: 每个元素都是节点 ID。该张量必须与图具有相同的设备类型和 ID 数据类型。

    • iterable[int]: 每个元素都是节点 ID。

    如果未指定,则返回所有节点的入度。

  • etype (str or (str, str, str), 可选) –

    边类型名称。允许的类型名称格式包括

    • (str, str, str) 用于表示源节点类型、边类型和目标节点类型。

    • 或者一个 str 边类型名称,如果该名称可以唯一标识图中的三元组格式。

    如果图只有一种边类型,则可以省略。

返回:

节点的入度(一个或多个)以 Tensor 形式返回。第 i 个元素是第 i 个输入节点的入度。如果 v 是一个 int,则也返回一个 int

返回类型:

int 或 Tensor

示例

以下示例使用 PyTorch 后端。

>>> import dgl
>>> import torch

创建一个同构图。

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

查询所有节点。

>>> g.in_degrees()
tensor([0, 2, 1, 1])

查询节点 1 和 2。

>>> g.in_degrees(torch.tensor([1, 2]))
tensor([2, 1])

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

>>> 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.in_degrees(torch.tensor([1, 0]), etype='follows')
tensor([1, 0])

另请参阅

out_degrees