SimplEInteraction

class SimplEInteraction(clamp_score=None)[source]

Bases: FunctionalInteraction[Tuple[FloatTensor, FloatTensor], Tuple[FloatTensor, FloatTensor], Tuple[FloatTensor, FloatTensor]]

A module wrapper for the SimplE interaction function.

Initialize the interaction module.

Parameters:

clamp_score (Union[None, float, Tuple[float, float]]) – whether to clamp scores into a fixed interval

Attributes Summary

entity_shape

The symbolic shapes for entity representations

relation_shape

The symbolic shapes for relation representations

Methods Summary

func(r, t, h_inv, r_inv, t_inv[, clamp])

Evaluate the SimplE interaction function.

Attributes Documentation

entity_shape: Sequence[str] = ('d', 'd')

The symbolic shapes for entity representations

relation_shape: Sequence[str] = ('d', 'd')

The symbolic shapes for relation representations

Methods Documentation

func(r, t, h_inv, r_inv, t_inv, clamp=None)

Evaluate the SimplE interaction function.

Parameters:
  • h (FloatTensor) – shape: (*batch_dims, dim) The head representations.

  • r (FloatTensor) – shape: (*batch_dims, dim, dim) The relation representations.

  • t (FloatTensor) – shape: (*batch_dims, dim) The tail representations.

  • h_inv (FloatTensor) – shape: (*batch_dims, dim) The inverse head representations.

  • r_inv (FloatTensor) – shape: (*batch_dims, dim, dim) The relation representations.

  • t_inv (FloatTensor) – shape: (*batch_dims, dim) The tail representations.

  • clamp (Optional[Tuple[float, float]]) – Clamp the scores to the given range.

Return type:

FloatTensor

Returns:

shape: batch_dims The scores.