CircularCorrelationCompositionModule

class CircularCorrelationCompositionModule(*args, **kwargs)

Bases: FunctionalCompositionModule

Composition by circular correlation via pykeen.nn.functional.circular_correlation().

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Methods Summary

func(b)

Compute the circular correlation between to vectors.

Methods Documentation

func(b: Tensor) → Tensor

Compute the circular correlation between to vectors.

Note

The implementation uses FFT.

Parameters:

• a (Tensor) – shape: s_1 The tensor with the first vectors.

• b (Tensor) – The tensor with the second vectors.

Returns:

The circular correlation between the vectors.

Return type:

Tensor