A package for training and evaluating knowledge graph embeddings
Project description
PyKEEN (Python KnowlEdge EmbeddiNgs) is a package for training and evaluating knowledge graph embeddings. Currently, it provides implementations of 10 knowledge graph emebddings models, and can be run in training mode in which users provide their own set of hyper-parameter values, or in hyper-parameter optimization mode to find suitable hyper-parameter values from set of user defined values. PyKEEN can also be run without having experience in programing by using its interactive command line interface that can be started with the command pykeen from a terminal.
Citation
If you find PyKEEN useful in your work, please consider citing:
Installation
pykeen can be installed on any system running Python 3.6+ with the following command:
pip install pykeen
Alternatively, it can be installed from the source for development with:
$ git clone https://github.com/SmartDataAnalytics/PyKEEN.git pykeen
$ cd pykeen
$ pip install -e .
However, GPU acceleration is limited to Linux systems with the appropriate graphics cards as described in the PyTorch documentation.
Usage
Code examples can be found in the notebooks directory.
CLI Usage - Set Up Your Experiment within 60 seconds
To start the PyKEEN CLI, run the following command:
pykeen
then the command line interface will assist you to configure your experiments.
To start PyKEEN with an existing configuration file, run:
pykeen -c /path/to/config.json
then the command line interface won’t be called, instead the pipeline will be started immediately.
Starting the Prediction Pipeline
To make prediction based on a trained model, run:
pykeen-predict -m /path/to/model/directory -d /path/to/data/directory
Summarize the Results of All Experiments
To summarize the results of all experiments, run:
pykeen-summarize -d /path/to/experiments/directory -o /path/to/output/file.csv
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pykeen-0.0.20.dev0-py36-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e5829973f330a0b0e654759a8135be2d04aced74ec8aae2e9aba566885835a5 |
|
MD5 | e381378466e7083f3b9c817c04a3ae05 |
|
BLAKE2b-256 | afe5a2e429b5367b4a40a361d46f194952012ef72460ac66e3c68697d5777dab |