Awesome

DeepKE is a knowledge extraction toolkit for knowledge graph construction supporting cnSchema，low-resource, document-level and multimodal scenarios for entity, relation and attribute extraction. We provide documents, online demo, paper, slides and poster for beginners.

• ❗Want to use Large Language Models with DeepKE? Try DeepKE-LLM and OneKE, have fun!
• ❗Want to train supervised models? Try Quick Start, we provide the NER models (e.g, LightNER(COLING'22), W2NER(AAAI'22)), relation extraction models (e.g., KnowPrompt(WWW'22)), relational triple extraction models (e.g., ASP(EMNLP'22), PRGC(ACL'21), PURE(NAACL'21)), and release off-the-shelf models at DeepKE-cnSchema, have fun!
• We recommend using Linux; if using Windows, please use \\ in file paths;
• If HuggingFace is inaccessible, please consider using wisemodel or modescape.

If you encounter any issues during the installation of DeepKE and DeepKE-LLM, please check Tips or promptly submit an issue, and we will assist you with resolving the problem!

Table of Contents

• Table of Contents
• What's New
• Prediction Demo
• Model Framework
• Quick Start
  • DeepKE-LLM
  • DeepKE
    • 🔧Manual Environment Configuration
    • 🐳Building With Docker Images
  • Requirements
    • DeepKE
  • Introduction of Three Functions
    • 1. Named Entity Recognition
    • 2. Relation Extraction
    • 3. Attribute Extraction
    • 4. Event Extraction
• Tips
• To do
• Reading Materials
• Related Toolkit
• Citation
• Contributors
• Other Knowledge Extraction Open-Source Projects

What's New

• April, 2024 We release a new bilingual (Chinese and English) schema-based information extraction model called OneKE based on Chinese-Alpaca-2-13B.
• Feb, 2024 We release a large-scale (0.32B tokens) high-quality bilingual (Chinese and English) Information Extraction (IE) instruction dataset named IEPile, along with two models trained with IEPile, baichuan2-13b-iepile-lora and llama2-13b-iepile-lora.
• Sep 2023 a bilingual Chinese English Information Extraction (IE) instruction dataset called InstructIE was released for the Instruction based Knowledge Graph Construction Task (Instruction based KGC), as detailed in here.
• June, 2023 We update DeepKE-LLM to support knowledge extraction with KnowLM, ChatGLM, LLaMA-series, GPT-series etc.
• Apr, 2023 We have added new models, including CP-NER(IJCAI'23), ASP(EMNLP'22), PRGC(ACL'21), PURE(NAACL'21), provided event extraction capabilities (Chinese and English), and offered compatibility with higher versions of Python packages (e.g., Transformers).
• Feb, 2023 We have supported using LLM (GPT-3) with in-context learning (based on EasyInstruct) & data generation, added a NER model W2NER(AAAI'22).

• Nov, 2022 Add data annotation instructions for entity recognition and relation extraction, automatic labelling of weakly supervised data (entity extraction and relation extraction), and optimize multi-GPU training.

• Sept, 2022 The paper DeepKE: A Deep Learning Based Knowledge Extraction Toolkit for Knowledge Base Population has been accepted by the EMNLP 2022 System Demonstration Track.

• Aug, 2022 We have added data augmentation (Chinese, English) support for low-resource relation extraction.

• June, 2022 We have added multimodal support for entity and relation extraction.

• May, 2022 We have released DeepKE-cnschema with off-the-shelf knowledge extraction models.

• Jan, 2022 We have released a paper DeepKE: A Deep Learning Based Knowledge Extraction Toolkit for Knowledge Base Population

• Dec, 2021 We have added dockerfile to create the enviroment automatically.

• Nov, 2021 The demo of DeepKE, supporting real-time extration without deploying and training, has been released.

• The documentation of DeepKE, containing the details of DeepKE such as source codes and datasets, has been released.

• Oct, 2021 pip install deepke

• The codes of deepke-v2.0 have been released.

• Aug, 2019 The codes of deepke-v1.0 have been released.

• Aug, 2018 The project DeepKE startup and codes of deepke-v0.1 have been released.

Prediction Demo

There is a demonstration of prediction. The GIF file is created by Terminalizer. Get the code. <img src="pics/demo.gif" width="636" height="494" align=center>

Model Framework

• DeepKE contains a unified framework for named entity recognition, relation extraction and attribute extraction, the three knowledge extraction functions.
• Each task can be implemented in different scenarios. For example, we can achieve relation extraction in standard, low-resource (few-shot), document-level and multimodal settings.
• Each application scenario comprises of three components: Data including Tokenizer, Preprocessor and Loader, Model including Module, Encoder and Forwarder, Core including Training, Evaluation and Prediction.

Quick Start

DeepKE-LLM

In the era of large models, DeepKE-LLM utilizes a completely new environment dependency.

conda create -n deepke-llm python=3.9
conda activate deepke-llm

cd example/llm
pip install -r requirements.txt

Please note that the requirements.txt file is located in the example/llm folder.

DeepKE

• DeepKE supports pip install deepke. <br>Take the fully supervised relation extraction for example.
• DeepKE supports both manual and docker image environment configuration, you can choose the appropriate way to build.
• Highly recommended to install deepke in a Linux environment.

🔧Manual Environment Configuration

Step1 Download the basic code

git clone --depth 1 https://github.com/zjunlp/DeepKE.git

Step2 Create a virtual environment using Anaconda and enter it.<br>

conda create -n deepke python=3.8

conda activate deepke

1. Install DeepKE with source code

   pip install -r requirements.txt
   
   python setup.py install
   
   python setup.py develop
   

2. Install DeepKE with pip (NOT recommended!)

   pip install deepke
   

Step3 Enter the task directory

cd DeepKE/example/re/standard

Step4 Download the dataset, or follow the annotation instructions to obtain data

wget 120.27.214.45/Data/re/standard/data.tar.gz

tar -xzvf data.tar.gz

Many types of data formats are supported,and details are in each part.

Step5 Training (Parameters for training can be changed in the conf folder)

We support visual parameter tuning by using wandb.

python run.py

Step6 Prediction (Parameters for prediction can be changed in the conf folder)

Modify the path of the trained model in predict.yaml.The absolute path of the model needs to be used，such as xxx/checkpoints/2019-12-03_ 17-35-30/cnn_ epoch21.pth.

python predict.py

• ❗NOTE: if you encounter any errors, please refer to the Tips or submit a GitHub issue.

🐳Building With Docker Images

Step1 Install the Docker client

Install Docker and start the Docker service.

Step2 Pull the docker image and run the container

docker pull zjunlp/deepke:latest
docker run -it zjunlp/deepke:latest /bin/bash

The remaining steps are the same as Step 3 and onwards in Manual Environment Configuration.

• ❗NOTE: You can refer to the Tips to speed up installation

Requirements

DeepKE

python == 3.8

• torch>=1.5,<=1.11
• hydra-core==1.0.6
• tensorboard==2.4.1
• matplotlib==3.4.1
• transformers==4.26.0
• jieba==0.42.1
• scikit-learn==0.24.1
• seqeval==1.2.2
• opt-einsum==3.3.0
• wandb==0.12.7
• ujson==5.6.0
• huggingface_hub==0.11.0
• tensorboardX==2.5.1
• nltk==3.8
• protobuf==3.20.1
• numpy==1.21.0
• ipdb==0.13.11
• pytorch-crf==0.7.2
• tqdm==4.66.1
• openai==0.28.0
• Jinja2==3.1.2
• datasets==2.13.2
• pyhocon==0.3.60

Introduction of Three Functions

1. Named Entity Recognition

• Named entity recognition seeks to locate and classify named entities mentioned in unstructured text into pre-defined categories such as person names, organizations, locations, organizations, etc.

• The data is stored in .txt files. Some instances as following (Users can label data based on the tools Doccano, MarkTool, or they can use the Weak Supervision with DeepKE to obtain data automatically):

  Sentence	Person	Location	Organization
  本报北京9月4日讯记者杨涌报道：部分省区人民日报宣传发行工作座谈会9月3日在4日在京举行。	杨涌	北京	人民日报
  《红楼梦》由王扶林导演，周汝昌、王蒙、周岭等多位专家参与制作。	王扶林，周汝昌，王蒙，周岭
  秦始皇兵马俑位于陕西省西安市,是世界八大奇迹之一。	秦始皇	陕西省，西安市

• Read the detailed process in specific README

  • STANDARD (Fully Supervised)

    We support LLM and provide the off-the-shelf model, DeepKE-cnSchema-NER, which will extract entities in cnSchema without training.

    Step1 Enter DeepKE/example/ner/standard. Download the dataset.

    wget 120.27.214.45/Data/ner/standard/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step2 Training<br>

    The dataset and parameters can be customized in the data folder and conf folder respectively.

    python run.py
    

    Step3 Prediction

    python predict.py
    

  • FEW-SHOT

    Step1 Enter DeepKE/example/ner/few-shot. Download the dataset.

    wget 120.27.214.45/Data/ner/few_shot/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step2 Training in the low-resouce setting <br>

    The directory where the model is loaded and saved and the configuration parameters can be cusomized in the conf folder.

    python run.py +train=few_shot
    

    Users can modify load_path in conf/train/few_shot.yaml to use existing loaded model.<br>

    Step3 Add - predict to conf/config.yaml, modify loda_path as the model path and write_path as the path where the predicted results are saved in conf/predict.yaml, and then run python predict.py

    python predict.py
    

  • MULTIMODAL

    Step1 Enter DeepKE/example/ner/multimodal. Download the dataset.

    wget 120.27.214.45/Data/ner/multimodal/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    We use RCNN detected objects and visual grounding objects from original images as visual local information, where RCNN via faster_rcnn and visual grounding via onestage_grounding.

    Step2 Training in the multimodal setting <br>

    • The dataset and parameters can be customized in the data folder and conf folder respectively.
    • Start with the model trained last time: modify load_path in conf/train.yamlas the path where the model trained last time was saved. And the path saving logs generated in training can be customized by log_dir.

    python run.py
    

    Step3 Prediction

    python predict.py
    

2. Relation Extraction

• Relationship extraction is the task of extracting semantic relations between entities from a unstructured text.

• The data is stored in .csv files. Some instances as following (Users can label data based on the tools Doccano, MarkTool, or they can use the Weak Supervision with DeepKE to obtain data automatically):

  Sentence	Relation	Head	Head_offset	Tail	Tail_offset
  《岳父也是爹》是王军执导的电视剧，由马恩然、范明主演。	导演	岳父也是爹	1	王军	8
  《九玄珠》是在纵横中文网连载的一部小说，作者是龙马。	连载网站	九玄珠	1	纵横中文网	7
  提起杭州的美景，西湖总是第一个映入脑海的词语。	所在城市	西湖	8	杭州	2

• !NOTE: If there are multiple entity types for one relation, entity types can be prefixed with the relation as inputs.

• Read the detailed process in specific README

  • STANDARD (Fully Supervised)

    We support LLM and provide the off-the-shelf model, DeepKE-cnSchema-RE, which will extract relations in cnSchema without training.

    Step1 Enter the DeepKE/example/re/standard folder. Download the dataset.

    wget 120.27.214.45/Data/re/standard/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step2 Training<br>

    The dataset and parameters can be customized in the data folder and conf folder respectively.

    python run.py
    

    Step3 Prediction

    python predict.py
    

  • FEW-SHOT

    Step1 Enter DeepKE/example/re/few-shot. Download the dataset.

    wget 120.27.214.45/Data/re/few_shot/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step 2 Training<br>

    • The dataset and parameters can be customized in the data folder and conf folder respectively.
    • Start with the model trained last time: modify train_from_saved_model in conf/train.yamlas the path where the model trained last time was saved. And the path saving logs generated in training can be customized by log_dir.

    python run.py
    

    Step3 Prediction

    python predict.py
    

  • DOCUMENT<br>

    Step1 Enter DeepKE/example/re/document. Download the dataset.

    wget 120.27.214.45/Data/re/document/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step2 Training<br>

    • The dataset and parameters can be customized in the data folder and conf folder respectively.
    • Start with the model trained last time: modify train_from_saved_model in conf/train.yamlas the path where the model trained last time was saved. And the path saving logs generated in training can be customized by log_dir.

    python run.py
    

    Step3 Prediction

    python predict.py
    

  • MULTIMODAL

    Step1 Enter DeepKE/example/re/multimodal. Download the dataset.

    wget 120.27.214.45/Data/re/multimodal/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    We use RCNN detected objects and visual grounding objects from original images as visual local information, where RCNN via faster_rcnn and visual grounding via onestage_grounding.

    Step2 Training<br>

    • The dataset and parameters can be customized in the data folder and conf folder respectively.
    • Start with the model trained last time: modify load_path in conf/train.yamlas the path where the model trained last time was saved. And the path saving logs generated in training can be customized by log_dir.

    python run.py
    

    Step3 Prediction

    python predict.py
    

3. Attribute Extraction

• Attribute extraction is to extract attributes for entities in a unstructed text.

• The data is stored in .csv files. Some instances as following:

  Sentence	Att	Ent	Ent_offset	Val	Val_offset
  张冬梅，女，汉族，1968年2月生，河南淇县人	民族	张冬梅	0	汉族	6
  诸葛亮，字孔明，三国时期杰出的军事家、文学家、发明家。	朝代	诸葛亮	0	三国时期	8
  2014年10月1日许鞍华执导的电影《黄金时代》上映	上映时间	黄金时代	19	2014年10月1日	0

• Read the detailed process in specific README

  • STANDARD (Fully Supervised)

    Step1 Enter the DeepKE/example/ae/standard folder. Download the dataset.

    wget 120.27.214.45/Data/ae/standard/data.tar.gz
    
    tar -xzvf data.tar.gz
    

    Step2 Training<br>

    The dataset and parameters can be customized in the data folder and conf folder respectively.

    python run.py
    

    Step3 Prediction

    python predict.py
    

4. Event Extraction

• Event extraction is the task to extract event type, event trigger words, event arguments from a unstructed text.
• The data is stored in .tsv files, some instances are as follows:

• Read the detailed process in specific README

  • STANDARD(Fully Supervised)

    Step1 Enter the DeepKE/example/ee/standard folder. Download the dataset.

    wget 120.27.214.45/Data/ee/DuEE.zip
    unzip DuEE.zip
    

    Step 2 Training

    The dataset and parameters can be customized in the data folder and conf folder respectively.

    python run.py
    

    Step 3 Prediction

    python predict.py
    

Tips

1.Using nearest mirror, THU in China, will speed up the installation of Anaconda; aliyun in China, will speed up pip install XXX.

2.When encountering ModuleNotFoundError: No module named 'past'，run pip install future .

3.It's slow to install the pretrained language models online. Recommend download pretrained models before use and save them in the pretrained folder. Read README.md in every task directory to check the specific requirement for saving pretrained models.

4.The old version of DeepKE is in the deepke-v1.0 branch. Users can change the branch to use the old version. The old version has been totally transfered to the standard relation extraction (example/re/standard).

5.If you want to modify the source code, it's recommended to install DeepKE with source codes. If not, the modification will not work. See issue

6.More related low-resource knowledge extraction works can be found in Knowledge Extraction in Low-Resource Scenarios: Survey and Perspective.

7.Make sure the exact versions of requirements in requirements.txt.

To do

In next version, we plan to release a stronger LLM for KE.

Meanwhile, we will offer long-term maintenance to fix bugs, solve issues and meet new requests. So if you have any problems, please put issues to us.

Reading Materials

Data-Efficient Knowledge Graph Construction, 高效知识图谱构建 (Tutorial on CCKS 2022) [slides]

Efficient and Robust Knowledge Graph Construction (Tutorial on AACL-IJCNLP 2022) [slides]

PromptKG Family: a Gallery of Prompt Learning & KG-related Research Works, Toolkits, and Paper-list [Resources]

Knowledge Extraction in Low-Resource Scenarios: Survey and Perspective [Survey][Paper-list]

Related Toolkit

Doccano、MarkTool、LabelStudio: Data Annotation Toolkits

LambdaKG: A library and benchmark for PLM-based KG embeddings

EasyInstruct: An easy-to-use framework to instruct Large Language Models

Reading Materials:

Data-Efficient Knowledge Graph Construction, 高效知识图谱构建 (Tutorial on CCKS 2022) [slides]

Efficient and Robust Knowledge Graph Construction (Tutorial on AACL-IJCNLP 2022) [slides]

PromptKG Family: a Gallery of Prompt Learning & KG-related Research Works, Toolkits, and Paper-list [Resources]

Knowledge Extraction in Low-Resource Scenarios: Survey and Perspective [Survey][Paper-list]

Related Toolkit:

Doccano、MarkTool、LabelStudio: Data Annotation Toolkits

LambdaKG: A library and benchmark for PLM-based KG embeddings

EasyInstruct: An easy-to-use framework to instruct Large Language Models

Citation

Please cite our paper if you use DeepKE in your work

@inproceedings{EMNLP2022_Demo_DeepKE,
  author    = {Ningyu Zhang and
               Xin Xu and
               Liankuan Tao and
               Haiyang Yu and
               Hongbin Ye and
               Shuofei Qiao and
               Xin Xie and
               Xiang Chen and
               Zhoubo Li and
               Lei Li},
  editor    = {Wanxiang Che and
               Ekaterina Shutova},
  title     = {DeepKE: {A} Deep Learning Based Knowledge Extraction Toolkit for Knowledge Base Population},
  booktitle = {{EMNLP} (Demos)},
  pages     = {98--108},
  publisher = {Association for Computational Linguistics},
  year      = {2022},
  url       = {https://aclanthology.org/2022.emnlp-demos.10}
}

Contributors

Ningyu Zhang, Haofen Wang, Fei Huang, Feiyu Xiong, Liankuan Tao, Xin Xu, Honghao Gui, Zhenru Zhang, Chuanqi Tan, Qiang Chen, Xiaohan Wang, Zekun Xi, Xinrong Li, Haiyang Yu, Hongbin Ye, Shuofei Qiao, Peng Wang, Yuqi Zhu, Xin Xie, Xiang Chen, Zhoubo Li, Lei Li, Xiaozhuan Liang, Yunzhi Yao, Jing Chen, Yuqi Zhu, Shumin Deng, Wen Zhang, Guozhou Zheng, Huajun Chen

Community Contributors: thredreams, eltociear, Ziwen Xu, Rui Huang, Xiaolong Weng

Other Knowledge Extraction Open-Source Projects

• CogIE
• OpenNRE
• OmniEvent
• OpenUE
• OpenIE
• RESIN
• ZShot
• ZS4IE
• OmniEvent