Go to file

tlk-dsg d88a5f16e0 add docker		2021-11-27 14:46:51 +08:00
.github	move to .github	2019-12-04 10:42:55 +08:00
docker	add docker	2021-11-27 14:46:51 +08:00
example	Update README.md	2021-11-23 16:32:51 +08:00
pics	replace architectures pic	2021-11-27 14:42:14 +08:00
pretrained	update readme	2019-12-03 22:59:23 +08:00
src/deepke	fix weight init bug	2021-11-25 20:19:22 +08:00
tutorial-notebooks	Update tutorial	2021-11-22 12:18:55 +00:00
.gitignore	Update .gitignore	2019-12-06 12:43:45 +08:00
LICENSE	Create LICENSE	2021-10-09 14:41:07 +08:00
README.md	add docker	2021-11-27 14:46:51 +08:00
README_ENGLISH.md	Update README_ENGLISH.md	2021-11-22 20:38:09 +08:00
setup.py	fix bug	2021-11-16 15:57:42 +08:00

README.md

简体中文 | English

基于深度学习的开源中文知识图谱抽取框架

DeepKE 是一个支持低资源、长篇章的知识抽取工具，可以基于PyTorch实现命名实体识别、关系抽取和属性抽取功能。

进行预测

下面使用一个demo展示预测过程

模型架构

Deepke的架构图如下所示

DeepKE包括了三个模块，可以进行命名实体识别、关系抽取以及属性抽取任务，在各个模块下包括各自的子模块。其中关系抽取模块就有常规模块、文档级抽取模块以及低资源少样本模块。在每一个子模块中，包含实现分词、预处理等功能的一个工具集合，以及编码、训练和预测部分。

快速上手

DeepKE支持pip安装使用，以常规全监督设定关系抽取为例，经过以下五个步骤就可以实现一个常规关系抽取模型

Step 1 下载代码 git clone https://github.com/zjunlp/DeepKE.git（别忘记star和fork哈！！！）

Step 2 使用anaconda创建虚拟环境，进入虚拟环境(提供Dockerfile源码可自行创建镜像，位于docker文件夹中)

conda create -n deepke python=3.8

conda activate deepke

1）基于pip安装，直接使用

pip install deepke

2）基于源码安装

python setup.py install

python setup.py develop

Step 3 进入任务文件夹，以常规关系抽取为例

cd DeepKE/example/re/standard

Step 4 模型训练，训练用到的参数可在conf文件夹内修改

python run.py

Step 5 模型预测。预测用到的参数可在conf文件夹内修改

python predict.py

环境依赖

python == 3.8

torch == 1.5
hydra-core == 1.0.6
tensorboard == 2.4.1
matplotlib == 3.4.1
transformers == 3.4.0
jieba == 0.42.1
scikit-learn == 0.24.1
pytorch-transformers == 1.2.0
seqeval == 1.2.2
tqdm == 4.60.0
opt-einsum==3.3.0
ujson

具体功能介绍

1. 命名实体识别NER

命名实体识别是从非结构化的文本中识别出实体和其类型。数据为txt文件，样式范例为：

Sentence	Person	Location	Organization
本报北京9月4日讯记者杨涌报道：部分省区人民日报宣传发行工作座谈会9月3日在4日在京举行。	杨涌	北京	人民日报
《红楼梦》是中央电视台和中国电视剧制作中心根据中国古典文学名著《红楼梦》摄制于1987年的一部古装连续剧，由王扶林导演，周汝昌、王蒙、周岭等多位红学家参与制作。	王扶林，周汝昌，王蒙，周岭	中国	中央电视台，中国电视剧制作中心
秦始皇兵马俑位于陕西省西安市，1961年被国务院公布为第一批全国重点文物保护单位，是世界八大奇迹之一。	秦始皇	陕西省，西安市	国务院

具体流程请进入详细的README中
- 常规全监督STANDARD
  
  Step1: 进入DeepKE/example/ner/standard，数据集和参数配置可以分别在data和conf文件夹中修改；
  
  Step2: 模型训练
```
python run.py
```
  Step3: 模型预测
```
python predict.py
```
- 少样本FEW-SHOT
  
  Step1: 进入DeepKE/example/ner/few-shot，模型加载和保存位置以及参数配置可以在conf文件夹中修改；
  
  Step2：模型训练，默认使用CoNLL-2003数据集进行训练
```
python run.py +train=few_shot
```
  若要加载模型，修改few_shot.yaml中的load_path；
  
  Step3：在config.yaml中追加- predict，predict.yaml中修改load_path为模型路径以及write_path为预测结果的保存路径，完成修改后使用
```
python predict.py
```

2. 关系抽取RE

关系抽取是从非结构化的文本中抽取出实体之间的关系，以下为几个样式范例，数据为csv文件：

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

具体流程请进入详细的README中，RE包括了以下三个子功能
- 常规全监督STANDARD
  
  Step1：进入DeepKE/example/re/standard，数据集和参数配置可以分别进入data和conf文件夹中修改；
  
  Step2：模型训练
```
python run.py
```
  Step3：模型预测
```
python predict.py
```
- 少样本FEW-SHOT
  
  Step1：进入DeepKE/example/re/few-shot，数据集和参数配置可以分别进入data和conf文件夹中修改；
  
  Step2：模型训练，如需从上次训练的模型开始训练：设置conf/train.yaml中的train_from_saved_model为上次保存模型的路径，每次训练的日志默认保存在根目录，可用log_dir来配置；
```
python run.py
```
  Step3：模型预测
```
python predict.py
```
- 文档级DOCUMENT
  train_distant.json由于文件太大，请自行从Google Drive上下载到data/目录下；
  
  Step1：进入DeepKE/example/re/document，数据集和参数配置可以分别进入data和conf文件夹中修改；
  
  Step2：模型训练，如需从上次训练的模型开始训练：设置conf/train.yaml中的train_from_saved_model为上次保存模型的路径，每次训练的日志默认保存在根目录，可用log_dir来配置；
```
python run.py
```
  Step3：模型预测
```
python predict.py
```

3. 属性抽取AE

数据为csv文件，样式范例为：

Sentence	Att	Ent	Ent_offset	Val	Val_offset
张冬梅，女，汉族，1968年2月生，河南淇县人	民族	张冬梅	0	汉族	6
杨缨，字绵公，号钓溪，松溪县人，祖籍将乐，是北宋理学家杨时的七世孙	朝代	杨缨	0	北宋	22
2014年10月1日许鞍华执导的电影《黄金时代》上映	上映时间	黄金时代	19	2014年10月1日	0

具体流程请进入详细的README中
- 常规全监督STANDARD
  
  Step1：进入DeepKE/example/re/standard，数据集和参数配置可以分别进入data和conf文件夹中修改；
  
  Step2：模型训练
```
python run.py
```
  Step3：模型预测
```
python predict.py
```

Notebook教程

本工具提供了若干Notebook和Google Colab教程，用户可针对性调试学习。

常规设定：

命名实体识别Notebook

命名实体识别Colab

关系抽取Notebook

关系抽取Colab

属性抽取Notebook

属性抽取Colab
低资源：

命名实体识别Notebook

命名实体识别Colab

关系抽取Notebook

关系抽取Colab
篇章级：

关系抽取Notebook

关系抽取Colab

备注（常见问题）

使用 Anaconda 时，建议添加国内镜像，下载速度更快。如镜像。
使用 pip 时，建议使用国内镜像，下载速度更快，如阿里云镜像。
安装后提示 ModuleNotFoundError: No module named 'past'，输入命令 pip install future 即可解决。
使用语言预训练模型时，在线安装下载模型比较慢，更建议提前下载好，存放到 pretrained 文件夹内。具体存放文件要求见文件夹内的 README.md。
DeepKE老版本位于deepke-v1.0分支，用户可切换分支使用老版本，老版本的能力已全部迁移到标准设定关系抽取(example/re/standard)中。

项目成员

浙江大学：张宁豫、陶联宽、余海洋、陈想、徐欣、田玺、李磊、黎洲波、邓淑敏、姚云志、叶宏彬、谢辛、郑国轴、陈华钧

达摩院：谭传奇、陈漠沙、黄非

README.md Unescape Escape