35b9bcc0af | ||
---|---|---|
.github/workflows | ||
config | ||
data | ||
kge | ||
local | ||
transformers@4ecc61246c | ||
.gitignore | ||
.gitmodules | ||
CODE_OF_CONDUCT.md | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
SUPPORT.md | ||
ThirdPartyNotices.txt | ||
azure-pipelines.yml | ||
dockerfile | ||
hitter-bert.py | ||
requirements.txt | ||
setup.cfg | ||
setup.py |
README.md
HittER
Hierarchical Transformers for Knowledge Graph Embeddings
HittER generates embeddings for knowledge graphs and performs link prediction using a hierarchical Transformer model. It will appear in EMNLP 2021 (arXiv version).
Installation
The repo requires python>=3.7, anaconda and a new env is recommended.
conda create -n hitter python=3.7 -y # optional
conda activate hitter # optional
git clone git@github.com:microsoft/HittER.git
cd HittER
pip install -e .
Data
First download the standard benchmark datasets using the commands below. Thanks LibKGE for providing the preprocessing scripts and hosting the data.
cd data
sh download_standard.sh
Training
Configurations for the experiments are in the /config
folder.
python -m kge start config/trmeh-fb15k237-best.yaml
The training process uses DataParallel in all visible GPUs by default, which can be overrode by appending --job.device cpu
to the command above.
Evaluation
You can evaluate the trained models on dev/test set using the following commands.
python -m kge eval <saved_dir>
python -m kge test <saved_dir>
Pretrained models are also released for reproducibility.
HittER-BERT QA experiments
QA experiment-related data can be downloaded from the release.
git submodule update --init
cd transformers
pip install -e .
Run experiments
> python hitter-bert.py --help
usage: hitter-bert.py [-h] [--dataset {fbqa,webqsp}] [--filtered] [--hitter]
[--seed SEED]
[exp_name]
positional arguments:
exp_name Name of the experiment
optional arguments:
-h, --help show this help message and exit
--dataset {fbqa,webqsp}
fbqa or webqsp
--filtered Filtered or not
--hitter Use pretrained HittER or not
--seed SEED Seed number
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
Citation
@inproceedings{chen-etal-2021-hitter,
title = "HittER: Hierarchical Transformers for Knowledge Graph Embeddings",
author = "Chen, Sanxing and Liu, Xiaodong and Gao, Jianfeng and Jiao, Jian and Zhang, Ruofei and Ji, Yangfeng",
booktitle = "Proceedings of the 2021 Conference on Empirical Methods in Natural Language Processing (EMNLP)",
month = nov,
year = "2021",
publisher = "Association for Computational Linguistics"
}