Stateful Interaction Modules

Stateful interaction functions.

Classes

Interaction()

Base class for interaction functions.

FunctionalInteraction()

Base class for interaction functions.

LiteralInteraction(base, combination[, …])

The interaction function shared by literal-containing interactions.

TranslationalInteraction(p[, power_norm])

The translational interaction function shared by the TransE, TransR, TransH, and other Trans<X> models.

MonotonicAffineTransformationInteraction(base)

An adapter of interaction functions which adds a scalar (trainable) monotonic affine transformation of the score.

ComplExInteraction()

A module wrapper for the stateless ComplEx interaction function.

ConvEInteraction([input_channels, …])

A stateful module for the ConvE interaction function.

ConvKBInteraction([hidden_dropout_rate, …])

A stateful module for the ConvKB interaction function.

CrossEInteraction([embedding_dim, …])

A module wrapper for the CrossE interaction function.

DistMultInteraction()

A module wrapper for the stateless DistMult interaction function.

DistMAInteraction()

A module wrapper for the stateless DistMA interaction function.

ERMLPInteraction(embedding_dim, hidden_dim)

A stateful module for the ER-MLP interaction.

ERMLPEInteraction([hidden_dim, …])

A stateful module for the ER-MLP (E) interaction function.

HolEInteraction()

A module wrapper for the stateless HolE interaction function.

KG2EInteraction([similarity, exact])

A stateful module for the KG2E interaction function.

MuREInteraction(p[, power_norm])

A stateful module for the MuRE interaction function from [balazevic2019b].

NTNInteraction([activation, activation_kwargs])

A stateful module for the NTN interaction function.

PairREInteraction(p[, power_norm])

A stateful module for the PairRE interaction function.

ProjEInteraction([embedding_dim, …])

A stateful module for the ProjE interaction function.

RESCALInteraction()

A module wrapper for the stateless RESCAL interaction function.

RotatEInteraction()

A module wrapper for the stateless RotatE interaction function.

SimplEInteraction([clamp_score])

A module wrapper for the SimplE interaction function.

StructuredEmbeddingInteraction(p[, power_norm])

A stateful module for the Structured Embedding (SE) interaction function.

TorusEInteraction([p, power_norm])

A stateful module for the TorusE interaction function.

TransDInteraction([p, power_norm])

A stateful module for the TransD interaction function.

TransEInteraction(p[, power_norm])

A stateful module for the TransE interaction function.

TransFInteraction()

A stateless module for the TransF interaction function.

TransHInteraction(p[, power_norm])

A stateful module for the TransH interaction function.

TransRInteraction(p[, power_norm])

A stateful module for the TransR interaction function.

TuckerInteraction([embedding_dim, …])

A stateful module for the stateless Tucker interaction function.

UnstructuredModelInteraction(p[, power_norm])

A stateful module for the UnstructuredModel interaction function.

Class Inheritance Diagram

Inheritance diagram of pykeen.nn.modules.Interaction, pykeen.nn.modules.FunctionalInteraction, pykeen.nn.modules.LiteralInteraction, pykeen.nn.modules.TranslationalInteraction, pykeen.nn.modules.MonotonicAffineTransformationInteraction, pykeen.nn.modules.ComplExInteraction, pykeen.nn.modules.ConvEInteraction, pykeen.nn.modules.ConvKBInteraction, pykeen.nn.modules.CrossEInteraction, pykeen.nn.modules.DistMultInteraction, pykeen.nn.modules.DistMAInteraction, pykeen.nn.modules.ERMLPInteraction, pykeen.nn.modules.ERMLPEInteraction, pykeen.nn.modules.HolEInteraction, pykeen.nn.modules.KG2EInteraction, pykeen.nn.modules.MuREInteraction, pykeen.nn.modules.NTNInteraction, pykeen.nn.modules.PairREInteraction, pykeen.nn.modules.ProjEInteraction, pykeen.nn.modules.RESCALInteraction, pykeen.nn.modules.RotatEInteraction, pykeen.nn.modules.SimplEInteraction, pykeen.nn.modules.StructuredEmbeddingInteraction, pykeen.nn.modules.TorusEInteraction, pykeen.nn.modules.TransDInteraction, pykeen.nn.modules.TransEInteraction, pykeen.nn.modules.TransFInteraction, pykeen.nn.modules.TransHInteraction, pykeen.nn.modules.TransRInteraction, pykeen.nn.modules.TuckerInteraction, pykeen.nn.modules.UnstructuredModelInteraction