PyKEEN Files

PyKEEN 1.11 has a lot of nice fixes from the last year of work, as well as a few bigger (potentially breaking) changes, see the last heading below. Big thanks to our five new contributors, and lots of great discussions on the issue tracker.

Enhancements

• EarlyStopper: show progress bar by @lorenzobalzani in https://github.com/pykeen/pykeen/pull/1377
• ⚙️🧮 Update generate_triples to ensure correct num_entities by @mberr in https://github.com/pykeen/pykeen/pull/1460
• ⛏️🗄️ Add method to restrict a dataset by @mberr in https://github.com/pykeen/pykeen/pull/1436
• 🔥🧮 Torch tensor typing by @mberr in https://github.com/pykeen/pykeen/pull/1439
• 🔓📊 Relax type hint of RankBasedEvaluator's metrics/metrics_kwargs parameter pair to match make_many by @mberr in https://github.com/pykeen/pykeen/pull/1383
• 🚨🏭 Warn about evaluation factory with inverse triples by @mberr in https://github.com/pykeen/pykeen/pull/1347
• 🏋️🤙 Training callback infrastructure to save checkpoints by @mberr in https://github.com/pykeen/pykeen/pull/1430

Bug Fixes

• Fix keyword argument in using_wandb.rst by @LuisaWerner in https://github.com/pykeen/pykeen/pull/1345
• 💾🕹️ Fix storing for custom datasets for ablation_pipeline by @mberr in https://github.com/pykeen/pykeen/pull/1374
• 🔄🙃 Fix nguyen2018_transe_wn18rr reproduction config by @mberr in https://github.com/pykeen/pykeen/pull/1373
• ⌛📋 Fix (Re-)Instantiation of LR-Schedule by @mberr in https://github.com/pykeen/pykeen/pull/1386
• Fix bug that still shows tqdm when use_tqdm=False in Evaluator by @nomisto in https://github.com/pykeen/pykeen/pull/1391
• 📜🔧 Fix example for LabelBasedInitializer by @mberr in https://github.com/pykeen/pykeen/pull/1403
• fix issue of 'Full Inductive LP Example' by @mohmehmo in https://github.com/pykeen/pykeen/pull/1405
• 🤖🔥 Fix automatic memory optimization and improve documentation by @mberr in https://github.com/pykeen/pykeen/pull/1428
• 🔙⛽ Fix class docstring of BackfillRepresentation by @mberr in https://github.com/pykeen/pykeen/pull/1437
• 🔧🥇 Fix BestKeeper and add tests for checkpoint schedules by @mberr in https://github.com/pykeen/pykeen/pull/1433
• 🩹🛁 Fix backfill representation by @mberr in https://github.com/pykeen/pykeen/pull/1440
• 🚨🦺 Fix fast tests not running by @mberr in https://github.com/pykeen/pykeen/pull/1458
• 🧼🫧 Fix shape handling in Interaction by @mberr in https://github.com/pykeen/pykeen/pull/1459
• 🏎️🧑‍🔧 Fix device errors & mypy by @mberr in https://github.com/pykeen/pykeen/pull/1461

Removals

• 🔪💨 Remove slicability annotations by @cthoyt in https://github.com/pykeen/pykeen/pull/1465
• 🧪💨 Remove tests that never run by @cthoyt in https://github.com/pykeen/pykeen/pull/1466
• Remove create_inverse_triples from init call to superclass by @nomisto in https://github.com/pykeen/pykeen/pull/1393

Docs

• 🗞️📖 Update docs by @cthoyt in https://github.com/pykeen/pykeen/pull/1473
• 🦚🪻 Improve Documentation for pykeen.triples by @mberr in https://github.com/pykeen/pykeen/pull/1366
• Improve documentation by @cthoyt in https://github.com/pykeen/pykeen/pull/1429
• ✨🧑‍🏫 Improve Splitting Documentation by @mberr in https://github.com/pykeen/pykeen/pull/1411
• Fixed some typos in the Documentation by @feldnerd in https://github.com/pykeen/pykeen/pull/1422
• ✨📖 Update understanding evaluation doc by @mberr in https://github.com/pykeen/pykeen/pull/1424
• Fix class inheritance diagram in docs by @mberr in https://github.com/pykeen/pykeen/pull/1426
• 🐈👩 Increase maximum sphinx version by @mberr in https://github.com/pykeen/pykeen/pull/1453
• 🐈👩 Increase maximum sphinx version by @mberr in https://github.com/pykeen/pykeen/pull/1431
• 🦟📚 Extract more documentation code examples into individual files by @mberr in https://github.com/pykeen/pykeen/pull/1432

Packaging, Project Management, and Testing

• Bump minimum Python version to 3.9 by @cthoyt in https://github.com/pykeen/pykeen/pull/1419
• 🔥🔓 Relax pytorch & numpy requirement by @mberr in https://github.com/pykeen/pykeen/pull/1475
• 📛📋 Update Badges in README by @mberr in https://github.com/pykeen/pykeen/pull/1425
• Improve project skeleton by @cthoyt in https://github.com/pykeen/pykeen/pull/1418
• Modernize extension loading by @cthoyt in https://github.com/pykeen/pykeen/pull/1421
• Add Ruff cleanup by @cthoyt in https://github.com/pykeen/pykeen/pull/1420
• 🧹⚙️ Update GHA by @mberr in https://github.com/pykeen/pykeen/pull/1415
• 🤖🧼 GitHub Action Cleanup by @mberr in https://github.com/pykeen/pykeen/pull/1378
• 🚫🔥 Block doc8=1.1.2 due to false positives by @mberr in https://github.com/pykeen/pykeen/pull/1438
• ✨🕵️ Fix mypy by @mberr in https://github.com/pykeen/pykeen/pull/1387

Merging Functional Forms

We did some pretty big breaking changes in this release - there is no longer a pykeen.nn.functional module. All of the functional forms are now part of the nn.Module classes in pykeen.nn.modules for interaction models. This was tracked and discussed in https://github.com/pykeen/pykeen/issues/1102

• ↔️❌ Merge CrossE by @mberr in https://github.com/pykeen/pykeen/pull/1447
• ↔️🟦 Merge CP by @mberr in https://github.com/pykeen/pykeen/pull/1446
• ↔️👓 Merge ConvE by @mberr in https://github.com/pykeen/pykeen/pull/1443
• ↔️📡 Merge ConvKB by @mberr in https://github.com/pykeen/pykeen/pull/1444
• ↔️📏 Merge DistMA by @mberr in https://github.com/pykeen/pykeen/pull/1445
• ↔️✖️ Merge DistMult by @mberr in https://github.com/pykeen/pykeen/pull/1448
• ↔️🦿 Merge ER-MLP by @mberr in https://github.com/pykeen/pykeen/pull/1449
• ↔️🦾 Merge ER-MLP-E by @mberr in https://github.com/pykeen/pykeen/pull/1450
• ↔️🐇 Merge HolE by @mberr in https://github.com/pykeen/pykeen/pull/1451
• ↔️🦎 Merge KG2E by @mberr in https://github.com/pykeen/pykeen/pull/1452
• ↔️🇫 Merge TransF by @mberr in https://github.com/pykeen/pykeen/pull/1462
• ↔️🚆 Merge NormBasedInteraction by @mberr in https://github.com/pykeen/pykeen/pull/1456
• ↔️🧮 Merge NTN by @mberr in https://github.com/pykeen/pykeen/pull/1463
• ↔️📽️ Merge ProjE by @mberr in https://github.com/pykeen/pykeen/pull/1464
• ↔️❇️ Merge RESCAL by @mberr in https://github.com/pykeen/pykeen/pull/1468
• ↔️🧷 Merge TuckER by @mberr in https://github.com/pykeen/pykeen/pull/1469
• ↔️💭 Merge SimplE by @mberr in https://github.com/pykeen/pykeen/pull/1470
• ↔️🚚 Merge TransformerInteraction by @mberr in https://github.com/pykeen/pykeen/pull/1471
• ↔️🎱 Merge QuatE by @cthoyt in https://github.com/pykeen/pykeen/pull/1472

While we were at it, we also did some more big refactoring:

• ✨✂️ Refactor utilities and nn modules by @cthoyt in https://github.com/pykeen/pykeen/pull/1467

Semantic versioning is a lie. We hope you enjoy pykeen v1.11 :)

New Contributors

• @LuisaWerner made their first contribution in https://github.com/pykeen/pykeen/pull/1345
• @lorenzobalzani made their first contribution in https://github.com/pykeen/pykeen/pull/1377
• @nomisto made their first contribution in https://github.com/pykeen/pykeen/pull/1391
• @mohmehmo made their first contribution in https://github.com/pykeen/pykeen/pull/1405
• @feldnerd made their first contribution in https://github.com/pykeen/pykeen/pull/1422

Full Changelog: https://github.com/pykeen/pykeen/compare/v1.10.2...v1.11.0