After training, the interaction model (e.g., TransE, ConvE, RotatE) can assign a score to an arbitrary triple, whether it appeared during training, testing, or not. In PyKEEN, each is implemented such that the higher the score (or less negative the score), the more likely a triple is to be true.
However, for most models, these scores do not have obvious statistical interpretations. This has two main consequences:
- The score for a triple from one model can not be compared to the score for that triple from another model
- There is no a priori minimum score for a triple to be labeled as true, so predictions must be given as a prioritization by sorting a set of triples by their respective scores.
After training a model, there are three high-level interfaces for making predictions:
pykeen.models.base.Model.predict_tails
for a given head/relation pairpykeen.models.base.Model.predict_heads
for a given relation/tail pairpykeen.models.base.Model.score_all_triples
for prioritizing links
Scientifically, pykeen.models.base.Model.score_all_triples
is the most interesting in a scenario where predictions could be tested and validated experimentally.
This example shows using the pykeen.pipeline.pipeline
to train a model which will already be in memory.
from pykeen.pipeline import pipeline
pipeline_result = pipeline(dataset='Nations', model='RotatE')
model = pipeline_result.model
# Predict tails
predicted_tails_df = model.predict_tails('brazil', 'intergovorgs')
# Predict heads
predicted_heads_df = model.predict_heads('conferences', 'brazil')
# Score All triples
predictions_df = model.score_all_triples()
# save the model
pipeline_result.save_to_directory('nations_rotate')
This example shows how to reload a previously trained model. The pykeen.pipeline.PipelineResult.save_to_directory
function makes a file named trained_model.pkl
, so we will use the one from the previous example.
import torch
model = torch.load('nations_rotate/trained_model.pkl')
# Predict tails
predicted_tails_df = model.predict_tails('brazil', 'intergovorgs')
# everything else is the same as above
There's an example model available at https://github.com/pykeen/pykeen/blob/master/notebooks/hello_world/nations_transe/trained_model.pkl from the "Hello World" notebook for you to try.
The model is trained on its ability to predict the appropriate tail for a given head/relation pair as well as its ability to predict the appropriate head for a given relation/tail pair. This means that while the model can technically predict relations between a given head/tail pair, it must be done with the caveat that it was not trained for this task.