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.18.tar.gz (41.1 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.18-py3-none-any.whl (47.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kgate-0.1.18.tar.gz
  • Upload date:
  • Size: 41.1 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.18.tar.gz
Algorithm Hash digest
SHA256 c42bb8125aa4594773a9e6073536e6477cffa9d246a0a2e64c9fe39d66659797
MD5 7941b1806b25eb4ad3d6fb6c31d3e8ba
BLAKE2b-256 bd240d212ea04bbd6c0240924f4d0ad623615cafbaefff2ef8e790492856e708

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kgate-0.1.18-py3-none-any.whl
  • Upload date:
  • Size: 47.1 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.18-py3-none-any.whl
Algorithm Hash digest
SHA256 d28dab23e2f2f46beb5247bd90c58535f663a44d7f0cc214b601e4626c690d3a
MD5 8cc8c9fa9c35595191dc9aeed216e2e7
BLAKE2b-256 153bf38e1829803226829ea8fdb55e1ea75797a48659389c83d2bacf6f90c57f

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