torch_geometric.transforms.Distance

class Distance(norm: bool = True, max_value: Optional[float] = None, cat: bool = True)[source]

Bases: BaseTransform

Saves the Euclidean distance of linked nodes in its edge attributes (functional name: distance).

Parameters

  • norm (bool, optional) – If set to False, the output will not be normalized to the interval \([0, 1]\). (default: True)

  • max_value (float, optional) – If set and norm=True, normalization will be performed based on this value instead of the maximum value found in the data. (default: None)

  • cat (bool, optional) – If set to False, all existing edge attributes will be replaced. (default: True)