pykeen
v1.0.5
Getting Started
Installation
First Steps
Understanding the Evaluation
Toy Example with Translational Distance Models
Optimizing a Model
Running an Ablation Study
Bring Your Own Data
Trackers
Novel Link Prediction
Performance Tricks
Reference
Pipeline
Models
Datasets
Triples
Training
Stoppers
Loss Functions
Regularizers
Result Trackers
Evaluation
Negative Sampling
Hyper-parameter Optimization
Ablation
Lookup
Sealant
Appendix
References
pykeen
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
A
ablation_pipeline() (in module pykeen.ablation)
apply() (Sealant method)
apply_only_once (Regularizer attribute)
B
BasicNegativeSampler (class in pykeen.sampling)
batch_size_search() (LCWATrainingLoop method)
(SLCWATrainingLoop method)
(TrainingLoop method)
BCEAfterSigmoidLoss (class in pykeen.losses)
BCEWithLogitsLoss (class in pykeen.losses)
BernoulliNegativeSampler (class in pykeen.sampling)
best_epoch (EarlyStopper attribute)
best_metric (EarlyStopper attribute)
C
can_slice_h (Model attribute)
can_slice_r (Model attribute)
can_slice_t (Model attribute)
CombinedRegularizer (class in pykeen.regularizers)
ComplEx (class in pykeen.models)
ComplExLiteral (class in pykeen.models)
compute_label_loss() (Model method)
compute_mr_loss() (DistMultLiteral method)
(Model method)
compute_self_adversarial_negative_sampling_loss() (Model method)
continue_callbacks (EarlyStopper attribute)
ConvE (class in pykeen.models)
ConvKB (class in pykeen.models)
create_lcwa_instances() (TriplesFactory method)
(TriplesNumericLiteralsFactory method)
create_slcwa_instances() (TriplesFactory method)
(TriplesNumericLiteralsFactory method)
CrossEntropyLoss (class in pykeen.losses)
D
DataSet (class in pykeen.datasets.base)
datasets (in module pykeen.datasets)
device (LCWATrainingLoop property)
(SLCWATrainingLoop property)
(TrainingLoop property)
DistMult (class in pykeen.models)
DistMultLiteral (class in pykeen.models)
E
EagerDataset (class in pykeen.datasets.base)
EarlyStopper (class in pykeen.stoppers)
embedding_xavier_normal_() (in module pykeen.models.init)
embedding_xavier_uniform_() (in module pykeen.models.init)
end_run() (MLFlowResultTracker method)
(ResultTracker method)
entity_id_to_label (TriplesFactory property)
entity_to_id (DataSet attribute)
(Instances attribute)
(TriplesFactory attribute)
entity_word_cloud() (TriplesFactory method)
EntityEmbeddingModel (class in pykeen.models.base)
EntityRelationEmbeddingModel (class in pykeen.models.base)
ERMLP (class in pykeen.models)
ERMLPE (class in pykeen.models)
evaluate_seconds (PipelineResult attribute)
evaluation_batch_size (EarlyStopper attribute)
evaluation_slice_size (EarlyStopper attribute)
evaluation_triples_factory (EarlyStopper attribute)
evaluator (EarlyStopper attribute)
evaluators (in module pykeen.evaluation)
expected_likelihood() (KG2E static method)
F
FB15k (class in pykeen.datasets)
FB15k237 (class in pykeen.datasets)
forward() (BCEAfterSigmoidLoss method)
(CombinedRegularizer method)
(CrossEntropyLoss method)
(LpRegularizer method)
(NoRegularizer method)
(NSSALoss method)
(PowerSumRegularizer method)
(Regularizer method)
(SoftplusLoss method)
(TransHRegularizer method)
frequency (EarlyStopper attribute)
from_path() (DataSet class method)
from_tf() (DataSet static method)
G
get_candidate_duplicate_relations() (in module pykeen.triples.leakage)
get_candidate_inverse_relations() (in module pykeen.triples.leakage)
get_dataset() (in module pykeen.datasets)
get_duplicate_triples() (Sealant method)
get_grad_params() (Model method)
get_idx_for_entities() (TriplesFactory method)
get_idx_for_relations() (TriplesFactory method)
get_inverse_relation_id() (TriplesFactory method)
get_inverse_triples() (Sealant method)
get_loss_cls() (in module pykeen.losses)
get_model_cls() (in module pykeen.models)
get_most_frequent_relations() (TriplesFactory method)
get_negative_sampler_cls() (in module pykeen.sampling)
get_normalized_name() (DataSet class method)
(LCWATrainingLoop class method)
(Regularizer class method)
(SLCWATrainingLoop class method)
(TrainingLoop class method)
get_regularizer_cls() (in module pykeen.regularizers)
get_result_tracker_cls() (in module pykeen.trackers)
get_stopper_cls() (in module pykeen.stoppers)
get_summary_dict() (EarlyStopper method)
get_training_loop_cls() (in module pykeen.training)
get_triples_for_relations() (TriplesFactory method)
git_hash (PipelineResult attribute)
H
has_dataset() (in module pykeen.datasets)
head_column (PackedZipRemoteDataSet attribute)
header (PackedZipRemoteDataSet attribute)
Hetionet (class in pykeen.datasets)
HolE (class in pykeen.models)
hpo_default (BasicNegativeSampler attribute)
(BernoulliNegativeSampler attribute)
(ComplEx attribute)
(ComplExLiteral attribute)
(ConvE attribute)
(ConvKB attribute)
(DistMult attribute)
(DistMultLiteral attribute)
(ERMLP attribute)
(ERMLPE attribute)
(HolE attribute)
(KG2E attribute)
(LpRegularizer attribute)
(MarginRankingLoss attribute)
(NegativeSampler attribute)
(NoRegularizer attribute)
(NSSALoss attribute)
(NTN attribute)
(PowerSumRegularizer attribute)
(ProjE attribute)
(Regularizer attribute)
(RESCAL attribute)
(RGCN attribute)
(RotatE attribute)
(SimplE attribute)
(StructuredEmbedding attribute)
(TransD attribute)
(TransE attribute)
(TransH attribute)
(TransHRegularizer attribute)
(TransR attribute)
(TuckER attribute)
(UnstructuredModel attribute)
hpo_pipeline() (in module pykeen.hpo)
hpo_pipeline_from_config() (in module pykeen.hpo)
hpo_pipeline_from_path() (in module pykeen.hpo)
HpoPipelineResult (class in pykeen.hpo)
I
Instances (class in pykeen.triples)
interaction_function() (ComplEx static method)
(DistMult static method)
(HolE static method)
(RotatE static method)
(TransD static method)
(TransR static method)
K
KG2E (class in pykeen.models)
Kinships (class in pykeen.datasets)
kullback_leibler_similarity() (KG2E static method)
L
larger_is_better (EarlyStopper attribute)
LazyDataSet (class in pykeen.datasets.base)
LCWAInstances (class in pykeen.triples)
LCWATrainingLoop (class in pykeen.training)
load_state() (Model method)
load_triples() (in module pykeen.triples.utils)
log_metrics() (MLFlowResultTracker method)
(ResultTracker method)
(WANDBResultTracker method)
log_params() (MLFlowResultTracker method)
(ResultTracker method)
(WANDBResultTracker method)
loss_default_kwargs (ComplEx attribute)
(ComplExLiteral attribute)
(ConvE attribute)
(DistMultLiteral attribute)
(ERMLPE attribute)
(Model attribute)
(ProjE attribute)
(SimplE attribute)
(TuckER attribute)
losses (in module pykeen.losses)
(PipelineResult attribute)
LpRegularizer (class in pykeen.regularizers)
M
make_labeled_df() (Model method)
map_triples_to_id() (TriplesFactory method)
mapped_triples (Instances attribute)
(TriplesFactory attribute)
MarginRankingLoss (class in pykeen.losses)
metadata (PipelineResult attribute)
metric (EarlyStopper attribute)
metric_results (PipelineResult attribute)
metrics (in module pykeen.evaluation)
MLFlowResultTracker (class in pykeen.trackers)
Model (class in pykeen.models.base)
model (EarlyStopper attribute)
(PipelineResult attribute)
models (in module pykeen.models)
module
pykeen
pykeen.ablation
pykeen.datasets
pykeen.datasets.base
pykeen.evaluation
pykeen.evaluation.rank_based_evaluator
pykeen.evaluation.sklearn
pykeen.losses
pykeen.models
pykeen.models.base
pykeen.models.init
pykeen.models.multimodal
pykeen.models.unimodal
pykeen.pipeline
pykeen.regularizers
pykeen.sampling
pykeen.stoppers
pykeen.trackers
pykeen.triples
pykeen.triples.leakage
pykeen.triples.utils
modules_not_supporting_sub_batching (Model attribute)
MSELoss (class in pykeen.losses)
MultimodalInstances (class in pykeen.triples)
MultimodalLCWAInstances (class in pykeen.triples)
MultimodalModel (class in pykeen.models.base)
MultimodalSLCWAInstances (class in pykeen.triples)
N
Nations (class in pykeen.datasets)
negative_samplers (in module pykeen.sampling)
NegativeSampler (class in pykeen.sampling)
new_with_relations() (TriplesFactory method)
new_with_restriction() (TriplesFactory method)
new_without_duplicate_relations() (Sealant method)
new_without_inverse_relations() (Sealant method)
new_without_relations() (TriplesFactory method)
NopStopper (class in pykeen.stoppers)
NoRegularizer (class in pykeen.regularizers)
normalize (CombinedRegularizer attribute)
NSSALoss (class in pykeen.losses)
NTN (class in pykeen.models)
num_entities (DataSet attribute)
(Instances property)
(Model attribute)
(TriplesFactory property)
num_instances (Instances property)
num_negs_per_pos (SLCWATrainingLoop property)
num_parameter_bytes (Model attribute)
num_relations (DataSet attribute)
(Model attribute)
(TriplesFactory property)
num_triples (TriplesFactory property)
number_results (EarlyStopper property)
O
objective (HpoPipelineResult attribute)
OpenBioLink (class in pykeen.datasets)
OpenBioLinkF1 (class in pykeen.datasets)
OpenBioLinkF2 (class in pykeen.datasets)
OpenBioLinkLQ (class in pykeen.datasets)
optimizers (in module pykeen.optimizers)
P
PackedZipRemoteDataSet (class in pykeen.datasets.base)
PathDataSet (class in pykeen.datasets.base)
patience (EarlyStopper attribute)
pipeline() (in module pykeen.pipeline)
PipelineResult (class in pykeen.pipeline)
plot() (PipelineResult method)
plot_er() (PipelineResult method)
plot_losses() (PipelineResult method)
post_parameter_update() (DistMult method)
(HolE method)
(KG2E method)
(Model method)
(RGCN method)
(RotatE method)
(StructuredEmbedding method)
(TransD method)
(TransE method)
(TransH method)
(TransR method)
PowerSumRegularizer (class in pykeen.regularizers)
predict_heads() (Model method)
predict_scores() (Model method)
predict_scores_all_heads() (Model method)
predict_scores_all_relations() (Model method)
predict_scores_all_tails() (Model method)
predict_tails() (Model method)
prepare_ablation() (in module pykeen.ablation)
prepare_ablation_from_config() (in module pykeen.ablation)
ProjE (class in pykeen.models)
pruners (in module pykeen.hpo.pruners)
pykeen
module
pykeen.ablation
module
pykeen.datasets
module
pykeen.datasets.base
module
pykeen.evaluation
module
pykeen.evaluation.rank_based_evaluator
module
pykeen.evaluation.sklearn
module
pykeen.losses
module
pykeen.models
module
pykeen.models.base
module
pykeen.models.init
module
pykeen.models.multimodal
module
pykeen.models.unimodal
module
pykeen.pipeline
module
pykeen.regularizers
module
pykeen.sampling
module
pykeen.stoppers
module
pykeen.trackers
module
pykeen.triples
module
pykeen.triples.leakage
module
pykeen.triples.utils
module
R
random_seed (PipelineResult attribute)
RankBasedEvaluator (class in pykeen.evaluation)
RankBasedMetricResults (class in pykeen.evaluation)
ratios (SingleTabbedDataset attribute)
regularization_term (Regularizer attribute)
regularize_if_necessary() (Model method)
(TransH method)
Regularizer (class in pykeen.regularizers)
regularizer_default_kwargs (ComplEx attribute)
(ConvKB attribute)
(DistMult attribute)
(Model attribute)
(RESCAL attribute)
(SimplE attribute)
(TransH attribute)
regularizers (in module pykeen.regularizers)
reindex() (in module pykeen.triples.leakage)
relation_column (PackedZipRemoteDataSet attribute)
relation_id_to_label (TriplesFactory property)
relation_to_id (DataSet attribute)
(Instances attribute)
(TriplesFactory attribute)
relation_to_inverse (TriplesFactory attribute)
relation_word_cloud() (TriplesFactory method)
relations_to_delete (Sealant property)
relative_delta (EarlyStopper attribute)
remaining_patience (EarlyStopper attribute)
RemoteDataSet (class in pykeen.datasets.base)
replicate_best_pipeline() (HpoPipelineResult method)
RESCAL (class in pykeen.models)
reset() (Regularizer method)
reset_parameters_() (Model method)
result_callbacks (EarlyStopper attribute)
result_tracker (EarlyStopper attribute)
results (EarlyStopper attribute)
ResultTracker (class in pykeen.trackers)
RGCN (class in pykeen.models)
RotatE (class in pykeen.models)
S
sample() (BasicNegativeSampler method)
(BernoulliNegativeSampler method)
(NegativeSampler method)
samplers (in module pykeen.hpo.samplers)
save_model() (PipelineResult method)
save_state() (Model method)
save_to_directory() (HpoPipelineResult method)
(PipelineResult method)
save_to_ftp() (HpoPipelineResult method)
(PipelineResult method)
save_to_s3() (HpoPipelineResult method)
(PipelineResult method)
score_all_triples() (Model method)
score_h() (ConvE method)
(DistMult method)
(ERMLP method)
(ERMLPE method)
(HolE method)
(KG2E method)
(Model method)
(NTN method)
(ProjE method)
(RESCAL method)
(RotatE method)
(SimplE method)
(StructuredEmbedding method)
(TransD method)
(TransE method)
(TransH method)
(TransR method)
(TuckER method)
(UnstructuredModel method)
score_hrt() (ComplEx method)
(ConvE method)
(ConvKB method)
(DistMult method)
(ERMLP method)
(ERMLPE method)
(HolE method)
(KG2E method)
(Model method)
(NTN method)
(ProjE method)
(RESCAL method)
(RGCN method)
(RotatE method)
(SimplE method)
(StructuredEmbedding method)
(TransD method)
(TransE method)
(TransH method)
(TransR method)
(TuckER method)
(UnstructuredModel method)
score_r() (Model method)
score_t() (ComplExLiteral method)
(ConvE method)
(DistMult method)
(DistMultLiteral method)
(ERMLP method)
(ERMLPE method)
(HolE method)
(KG2E method)
(Model method)
(NTN method)
(ProjE method)
(RESCAL method)
(RotatE method)
(SimplE method)
(StructuredEmbedding method)
(TransD method)
(TransE method)
(TransH method)
(TransR method)
(TuckER method)
(UnstructuredModel method)
Sealant (class in pykeen.triples.leakage)
sep (PackedZipRemoteDataSet attribute)
should_evaluate() (EarlyStopper method)
(NopStopper method)
(Stopper method)
should_stop() (EarlyStopper method)
(NopStopper method)
(Stopper method)
SimplE (class in pykeen.models)
SingleTabbedDataset (class in pykeen.datasets.base)
SklearnEvaluator (class in pykeen.evaluation)
SklearnMetricResults (class in pykeen.evaluation)
SLCWAInstances (class in pykeen.triples)
SLCWATrainingLoop (class in pykeen.training)
SoftplusLoss (class in pykeen.losses)
split() (TriplesFactory method)
start_run() (MLFlowResultTracker method)
(ResultTracker method)
stopped (EarlyStopper attribute)
stopped_callbacks (EarlyStopper attribute)
Stopper (class in pykeen.stoppers)
stopper (PipelineResult attribute)
stoppers (in module pykeen.stoppers)
StructuredEmbedding (class in pykeen.models)
study (HpoPipelineResult attribute)
sub_batch_and_slice() (LCWATrainingLoop method)
(SLCWATrainingLoop method)
(TrainingLoop method)
summarize() (DataSet method)
(in module pykeen.triples.leakage)
summary_str() (DataSet method)
supports_subbatching (Model attribute)
synonyms (MarginRankingLoss attribute)
(MSELoss attribute)
(NSSALoss attribute)
T
tail_column (PackedZipRemoteDataSet attribute)
TarFileRemoteDataSet (class in pykeen.datasets.base)
tensor_to_df() (TriplesFactory method)
term (Regularizer property)
testing (LazyDataSet attribute)
title (PipelineResult property)
to_cpu_() (Model method)
to_device_() (Model method)
to_embeddingdb() (LCWATrainingLoop method)
(Model method)
(SLCWATrainingLoop method)
(TrainingLoop method)
to_gpu_() (Model method)
train() (LCWATrainingLoop method)
(SLCWATrainingLoop method)
(TrainingLoop method)
train_seconds (PipelineResult attribute)
training (LazyDataSet attribute)
training_loop (PipelineResult attribute)
training_loops (in module pykeen.training)
TrainingLoop (class in pykeen.training)
TransD (class in pykeen.models)
TransE (class in pykeen.models)
TransH (class in pykeen.models)
TransHRegularizer (class in pykeen.regularizers)
TransR (class in pykeen.models)
triples (TriplesFactory attribute)
triples_factory (LCWATrainingLoop property)
(SLCWATrainingLoop property)
(TrainingLoop property)
TriplesFactory (class in pykeen.triples)
TriplesNumericLiteralsFactory (class in pykeen.triples)
TuckER (class in pykeen.models)
U
UMLS (class in pykeen.datasets)
unleak() (in module pykeen.triples.leakage)
UnstructuredModel (class in pykeen.models)
update() (NoRegularizer method)
(Regularizer method)
(TransHRegularizer method)
V
validation (LazyDataSet attribute)
version (PipelineResult attribute)
W
WANDBResultTracker (class in pykeen.trackers)
weight (Regularizer attribute)
WN18 (class in pykeen.datasets)
WN18RR (class in pykeen.datasets)
Y
YAGO310 (class in pykeen.datasets)
Z
ZipFileRemoteDataSet (class in pykeen.datasets.base)
Read the Docs
v: v1.0.5
Versions
latest
stable
v1.5.0
v1.4.0
v1.3.0
v1.1.0
v1.0.5
v1.0.0
Downloads
On Read the Docs
Project Home
Builds