OpenNRE
This repository is a subproject of THU-OpenSK, and all subprojects of THU-OpenSK are as follows.
****** Update ******
We provide two distantly-supervised datasets with human-annotated test sets, NYT10m and Wiki20m. Check the datasets section for details.
****** Update ******
OpenNRE is an open-source and extensible toolkit that provides a unified framework to implement relation extraction models. This package is designed for the following groups:
- New to relation extraction: We have hand-by-hand tutorials and detailed documents that can not only enable you to use relation extraction tools, but also help you better understand the research progress in this field.
- Developers: Our easy-to-use interface and high-performance implementation can acclerate your deployment in the real-world applications. Besides, we provide several pretrained models which can be put into production without any training.
- Researchers: With our modular design, various task settings and metric tools, you can easily carry out experiments on your own models with only minor modification. We have also provided several most-used benchmarks for different settings of relation extraction.
- Anyone who need to submit an NLP homework to impress their professors: With state-of-the-art models, our package can definitely help you stand out among your classmates!
This package is mainly contributed by Tianyu Gao, Xu Han, Shulian Cao, Lumin Tang, Yankai Lin, Zhiyuan Liu
What is Relation Extraction
Relation extraction is a natural language processing (NLP) task aiming at extracting relations (e.g., founder of) between entities (e.g., Bill Gates and Microsoft). For example, from the sentence Bill Gates founded Microsoft, we can extract the relation triple (Bill Gates, founder of, Microsoft).
Relation extraction is a crucial technique in automatic knowledge graph construction. By using relation extraction, we can accumulatively extract new relation facts and expand the knowledge graph, which, as a way for machines to understand the human world, has many downstream applications like question answering, recommender system and search engine.
How to Cite
A good research work is always accompanied by a thorough and faithful reference. If you use or extend our work, please cite the following paper:
@inproceedings{han-etal-2019-opennre,
title = "{O}pen{NRE}: An Open and Extensible Toolkit for Neural Relation Extraction",
author = "Han, Xu and Gao, Tianyu and Yao, Yuan and Ye, Deming and Liu, Zhiyuan and Sun, Maosong",
booktitle = "Proceedings of EMNLP-IJCNLP: System Demonstrations",
year = "2019",
url = "https://www.aclweb.org/anthology/D19-3029",
doi = "10.18653/v1/D19-3029",
pages = "169--174"
}
It's our honor to help you better explore relation extraction with our OpenNRE toolkit!
Papers and Document
If you want to learn more about neural relation extraction, visit another project of ours (NREPapers).
You can refer to our document for more details about this project.
Install
Install as A Python Package
We are now working on deploy OpenNRE as a Python package. Coming soon!
Using Git Repository
Clone the repository from our github page (don't forget to star us!)
git clone https://github.com/thunlp/OpenNRE.gitIf it is too slow, you can try
git clone https://github.com/thunlp/OpenNRE.git --depth 1
Then install all the requirements:
pip install -r requirements.txt
Note: Please choose appropriate PyTorch version based on your machine (related to your CUDA version). For details, refer to https://pytorch.org/.
Then install the package with
python setup.py install
If you also want to modify the code, run this:
python setup.py develop
Note that we have excluded all data and pretrain files for fast deployment. You can manually download them by running scripts in the benchmark and pretrain folders. For example, if you want to download FewRel dataset, you can run
bash benchmark/download_fewrel.shEasy Start
Make sure you have installed OpenNRE as instructed above. Then import our package and load pre-trained models.
>>> import opennre
>>> model = opennre.get_model('wiki80_cnn_softmax')Note that it may take a few minutes to download checkpoint and data for the first time. Then use infer to do sentence-level relation extraction
>>> model.infer({'text': 'He was the son of Máel Dúin mac Máele Fithrich, and grandson of the high king Áed Uaridnach (died 612).', 'h': {'pos': (18, 46)}, 't': {'pos': (78, 91)}})
('father', 0.5108704566955566)You will get the relation result and its confidence score.
If you want to use the model on your GPU, just run
>>> model = model.cuda()before calling the inference function.
For now, we have the following available models:
wiki80_cnn_softmax: trained onwiki80dataset with a CNN encoder.wiki80_bert_softmax: trained onwiki80dataset with a BERT encoder.wiki80_bertentity_softmax: trained onwiki80dataset with a BERT encoder (using entity representation concatenation).tacred_bert_softmax: trained onTACREDdataset with a BERT encoder.tacred_bertentity_softmax: trained onTACREDdataset with a BERT encoder (using entity representation concatenation).
Datasets
You can go into the benchmark folder and download datasets using our scripts. We also list some of the information about the datasets in this document.
Training
You can train your own models on your own data with OpenNRE. In example folder we give example training codes for supervised RE models and bag-level RE models. You can either use our provided datasets or your own datasets. For example, you can use the following script to train a PCNN-ATT bag-level model on the NYT10 dataset with manual test set:
python example/train_bag_cnn.py \
--metric auc \
--dataset nyt10m \
--batch_size 160 \
--lr 0.1 \
--weight_decay 1e-5 \
--max_epoch 100 \
--max_length 128 \
--seed 42 \
--encoder pcnn \
--aggr attOr use the following script to train a BERT model on the Wiki80 dataset:
python example/train_supervised_bert.py \
--pretrain_path bert-base-uncased \
--dataset wiki80We provide many options in the example training code and you can check them out for detailed instructions.