update readme

example/re/regular/README.md

@@ -1,30 +1,46 @@
 ## 快速上手
 
+### 环境依赖
+
+> python == 3.8
+
+- torch == 1.5
+- hydra-core == 1.0.6
+- tensorboard == 2.4.1
+- matplotlib == 3.4.1
+- scikit-learn == 0.24.1
+- transformers == 4.5.0
+- jieba == 0.42.1
+- deepke 
+
 ### 克隆代码
 ```
 git clone git@github.com:zjunlp/DeepKE.git
 ```
 ### 使用pip安装
 
-首先创建python虚拟环境，再进入虚拟环境
+首先创建python虚拟环境，再进入虚拟环境,然
 
-然后DeepKE可以依此安装：
+- 安装依赖: ```pip install -r requirements.txt```
 
-```
-pip install deepke
-```
+-存放数据：在 `data/origin` 文件夹下存放训练数据。训练文件主要有三个文件。
 
-### 使用工具
-先进行训练(训练所用到参数都在conf文件夹中，修改即可)
-```
-python run.py
-```
-再进行预测(需进入conf文件夹中predict.yaml修改使用模型路径)
-```
-python predict.py
-```
+  - `train.csv`：存放训练数据集
 
-## 模型架构
+  - `valid.csv`：存放验证数据集
+
+  - `test.csv`：存放测试数据集
+
+  - `relation.csv`：存放关系种类
+
+- 开始训练：```python run.py``` (训练所用到参数都在conf文件夹中，修改即可)
+
+- 每次训练的日志保存在 `logs` 文件夹内，模型结果保存在 `checkpoints` 文件夹内。
+
+- 进行预测 ```python predict.py```
+
+
+## 模型内容
 1、CNN
 
 2、RNN

example/re/regular/requirements.txt

@@ -1,4 +1,3 @@
-python == 3.8
 torch == 1.5
 hydra-core == 1.0.6
 tensorboard == 2.4.1