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.0.tar.gz (32.9 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.0-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kgate-0.1.0.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.5 Linux/6.10.7-arch1-1

File hashes

Hashes for kgate-0.1.0.tar.gz
Algorithm Hash digest
SHA256 659cd2648cfa498622f41cab8118f9b3a237dcece28bbbbff7dfa888f334b0ef
MD5 e386106ad8bce558a0ac86ce9b9c5492
BLAKE2b-256 1ec832b495b9d16a1414acff58272a82e34221ee3b9a85707cc95920f78fb8b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kgate-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.5 Linux/6.10.7-arch1-1

File hashes

Hashes for kgate-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7da0018da84f0ffbbaed462ca20e8973eaae7ab7d7b3f578e6a204944d21bbe0
MD5 08e8783265d54f5c4b7128b9f83580c6
BLAKE2b-256 40a12e0a0217f3880e01a6b25a46b22d5489c0f110b9c27d59b855d98d39ce47

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