CP

class CP(embedding_dim=64, rank=64, entity_initializer=None, entity_initializer_kwargs=None, entity_normalizer=None, entity_normalizer_kwargs=None, relation_initializer=None, relation_initializer_kwargs=None, **kwargs)[source]

Bases: ERModel

An implementation of CP as described in [lacroix2018] based on [hitchcock1927].

Initialize CP via the pykeen.nn.modules.CPInteraction interaction.

Parameters:

  • embedding_dim (int) – The entity embedding dimension \(d\).

  • rank (int) – The tensor decomposition rank \(k\).

  • entity_initializer (Union[str, Callable[[FloatTensor], FloatTensor], None]) – Entity initializer function. Defaults to None

  • entity_initializer_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to be used when calling the entity initializer

  • entity_normalizer (Union[str, Callable[[FloatTensor], FloatTensor], None]) – Entity normalizer function. Defaults to None

  • entity_normalizer_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to be used when calling the entity normalizer

  • relation_initializer (Union[str, Callable[[FloatTensor], FloatTensor], None]) – Relation initializer function. Defaults to None

  • relation_initializer_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to be used when calling the relation initializer

  • kwargs – Remaining keyword arguments passed through to pykeen.models.ERModel.

Attributes Summary

hpo_default

The default strategy for optimizing the model's hyper-parameters

Attributes Documentation

hpo_default: ClassVar[Mapping[str, Any]] = {'embedding_dim': {'high': 256, 'low': 16, 'q': 16, 'type': <class 'int'>}, 'rank': {'high': 2048, 'log': True, 'low': 2, 'type': <class 'int'>}}

The default strategy for optimizing the model’s hyper-parameters