Skip to main content

Knowledge Graph Autoencoder Training Environment, bridging PyG encoders and TorchKGE decoders.

Project description

Knowledge Graph Autoencoder Training Environment (KGATE)

KGATE is a knowledge graph embedding library bridging the encoders from Pytorch Geometric and the decoders from TorchKGE.

This tool relies heavily on the performances of TorchKGE and its numerous implemented modules for link prediction, negative sampling and model evaluation. The main goal here is to address the lack of encoders in the original library, who is unfortunately not maintained anymore.

Installation

To join in the development, clone this repository and install Poetry:

pip install poetry

Install the dependencies with:

poetry install

Usage

KGATE is meant to be a self-sufficient training environment for knowledge graph embedding that requires very little code to work but can easily be expanded or modified. Everything stems from the Architect class, which holds all the necessary attributes and methods to fully train and test a KGE model following the autoencoder architecture, as well as run inference.

from kgate import Architect

config_path = "/path/to/your/config.toml"

architect = Architect(config = config_path)

# Train the model using KG and hyperparameters specified in the configuration
architect.train()

# Test the trained model, using the best checkpoint
architect.test()

# Run KG completion task, the empty list is the element that will be predicted
known_heads = []
known_relations = []
known_tails = []
architect.infer(known_heads, known_relations, known_tails)

For a more detailed example and specific methods that are available in the package, see the upcoming readthedocs documentation.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kgate-0.1.15.tar.gz (40.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kgate-0.1.15-py3-none-any.whl (45.7 kB view details)

Uploaded Python 3

File details

Details for the file kgate-0.1.15.tar.gz.

File metadata

  • Download URL: kgate-0.1.15.tar.gz
  • Upload date:
  • Size: 40.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.7 Windows/10

File hashes

Hashes for kgate-0.1.15.tar.gz
Algorithm Hash digest
SHA256 7b2eb865dd41f6111644f50cfc8cdd02d28c3ff24de7d5e212d8003f254d62dc
MD5 57efc0d592abbb3ab79717f7b29e7fd6
BLAKE2b-256 6b0799bf0b93063c174194559731f722e02f77915aa2eafcf5bac0739a7e6c13

See more details on using hashes here.

File details

Details for the file kgate-0.1.15-py3-none-any.whl.

File metadata

  • Download URL: kgate-0.1.15-py3-none-any.whl
  • Upload date:
  • Size: 45.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.7 Windows/10

File hashes

Hashes for kgate-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 e64e48155eb8e3278cd5b17f1aeb336b262caf1517ce2f92dae58a58ded63eb1
MD5 fb89e76c13eb6f2d14e05f00ccb82b76
BLAKE2b-256 f9254c13cfac5b81fe1d3d689bb23f955dc26bd37ad3087ceeeacee61769e1c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page