# OpenKS

**Repository Path**: zhushunyi/OpenKS

## Basic Information

- **Project Name**: OpenKS
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-04-25
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenKS（知目）——领域可泛化的知识学习与计算引擎

## 平台支持功能
| 基础能力 | 领域泛化能力 | 跨领域能力 | 现实问题解决能力 | 开放服务使用能力 |
| :----: | :----: | :----: | :----: | :----: |
| 知识图谱载入与构建 | 领域启发式知识表示处理与推理应用 | 跨领域知识融合表示学习与推理（待支持） | 大规模高效率知识图谱学习与推理 | 前沿算法集成与高性能模型调用 |
| 知识图谱表示与学习 | 通用分布式知识表示学习与推理应用 | 跨模态知识统一表示学习与推理（待支持） | 隐私安全知识图谱联合学习与推理 | 典型知识图谱应用系统开发使用 |
| 知识图谱推理与应用 |  |  |  | 领域场景高质量开放数据集提供 |

## 模块架构
![architect](./docs/pics/architect.jpg)

## 环境要求
### 各模块及其依赖第三方库如下
| 模块 | 依赖 |
| :----: | :----: |
| all | Python 3.7 / NumPy - 1.18.1 (https://github.com/numpy/numpy) / NetworkX - 2.4 (https://github.com/networkx/networkx) |
| models | scikit-learn - 0.22.1 (https://github.com/scikit-learn/scikit-learn) |
| distributed | PGL - 1.0.1 (https://github.com/PaddlePaddle/PGL) / Paddle - 1.7.1 (https://github.com/paddlepaddle/paddle) |
| models.paddle | Paddle - 1.7.1 (https://github.com/paddlepaddle/paddle) |
| models.pytorch | PyTorch - 1.4.0 (https://github.com/pytorch/pytorch) |
| models.tensorflow | TensorFlow - 2.2.1 (https://github.com/tensorflow/tensorflow) |
| models.pytorch.kg_learn_dist | Ray - 1.0.0 (https://github.com/ray-project/ray) |
| models.mllib | gensim - 4.0.0 (https://github.com/RaRe-Technologies/gensim) / jieba - 0.42.1 (https://github.com/fxsjy/jieba) |

## 快速上手
### 知识图谱问答
```
python -m examples.kg_qa.py
```

### 文本信息抽取训练
```
python -m examples.text_entity.py

python -m examples.text_keyphrase.py
```

### 知识图谱表示学习训练
```
python -m examples.kg_learn.py
```

### 分布式图表示模型训练(Ray)
```
python -m examples.kg_dist_learn.py
```

### 分布式图表示模型训练(Fleet)
```
python openks/distributed/openKS_launcher.py --mode cpu --worker_num 2 --server_num 2 main_dist.py
```

### 使用说明
1. 图谱数据载入与图谱结构生成
```
from openks.loaders import loader_config, SourceType, FileType, GraphLoader

# 使用loader_config配置数据载入参数，包括数据来源（本地文件/图数据库）、数据文件格式类型（OpenKS格式/压缩目录）、文件路径、数据集名称等
loader_config.source_type = SourceType.LOCAL_FILE
loader_config.file_type = FileType.OPENKS
loader_config.source_uris = 'openks/data/medical'
loader_config.data_name = 'test-data-set'
```
```
# 数据文件载入为内存数据集格式，并进行数据集信息展示
loader = Loader(loader_config)
dataset = loader.dataset
dataset.info_display()
```
```
# 知识图谱数据内存数据格式载入，并进行图谱信息展示（可以不进行数据集载入而直接进行图谱载入）
graph_loader = GraphLoader(loader_config)
graph = graph_loader.graph
graph.info_display()
```
```
from py2neo import Graph

# 可以将内存图谱数据写入neo4j图数据库中用于下游任务
graph_db = Graph(host='127.0.0.1', http_port=7474, user='neo4j', password='123456')
graph_loader.graph2neo(graph, graph_db, clean=False) # clean为False表示不进行清空，True为清空并重新导入
```
2. 图谱表示学习模型训练
```
from openks.models import OpenKSModel

# 列出已注册的所有算法模型
OpenKSModel.list_modules()
```
```
# 算法模型选择配置，包括框架选择、模型大类选择、算法选择等
platform = 'Paddle'
model_type = 'KGLearn'
model = 'TransE'
```
```
# 算法模型加载与训练（如需要分布式训练，需配置run方法的参数，如run(dist=True)）
model_type = OpenKSModel.get_module(platform, model_type)
kgmodel = model_type(graph=graph, model=OpenKSModel.get_module(platform, model), args=None)
kgmodel.run(dist=False)
```
3. 知识图谱问答
```
from openks.apps.qa import RuleParserMedical, AnswerFetcher

# 选择自定义的问题解析类并进行规则和模型预加载
parser = RuleParserMedical(graph)
```
```
# 输入问题并对问题进行结构化解析
question = input("输入问题：")
struc_q = parser.parse(question)
```
```
# 根据结构化问题获取答案，支持直接内存数据匹配、外部数据库查询、图谱向量表示计算等方式
fetcher = AnswerFetcher(struc_q, graph)
print(fetcher.fetch_by_db_query(graph_db))
```

## 系统运行逻辑
![pipeline](./docs/pics/running_steps.jpg)

## 团队
### 主要成员：
- 学生：宗畅、倪子煊、慕宗燊、叶钰楠、张凤达、常嘉乐、李星晨、王晓强、李俊成、李嘉成、沈锴、戴光裕、陈董、丁亚东、黄成越、唐作其、李佳晖、肖少宁、高凯锋、胡一帆、周宇航、叶寅
- 教师：庄越挺、汤斯亮、肖俊、吴超、鲁伟明、张寅、杨易、杨洋、况琨

### 参与单位：
浙江大学、北京大学、北京航空航天大学、哈尔滨工业大学、西北工业大学、之江实验室、百度、海康威视、同盾科技、科大讯飞、量知数据