Skip to content

Commit 4dd01af

Browse files
authored
Update README_CN.md
1 parent bfe029d commit 4dd01af

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README_CN.md

+68
Original file line numberDiff line numberDiff line change
@@ -1 +1,69 @@
1+
<p align="left">
2+
中文</a>&nbsp | <a href="README.md">English</a>&nbsp
3+
</p>
4+
<br>
15

6+
# QUILL
7+
8+
## 网页与DEMO
9+
详细的QUILL网页与DEMO,请看这里: [QUILL website](https://gracexiaoo.github.io/quill.github.io/)
10+
11+
## 安装依赖项
12+
13+
```
14+
pip install -r requirements.txt
15+
```
16+
17+
## 注意!
18+
19+
在运行代码前,请先`sh app.sh`来保证计算ppl和提取引言的功能的正常运行 (同时请确认文件中的模型路径正确)
20+
```
21+
cd QUILL/
22+
CUDA_VISIBLE_DEVICES=0 python /code/app/ppl_compute.py
23+
CUDA_VISIBLE_DEVICES=0 python /code/app/quote_extract.py
24+
```
25+
26+
## 评估系统 (QG,Quote generation)
27+
28+
你可以通过运行脚本`naive.sh`,来评估任何一个模型在QG任务上的表现
29+
30+
```
31+
cd QUILL/
32+
model='llama2-70b-chat-hf'
33+
num=1
34+
memory=0.8
35+
prompt='0_shot_quote'
36+
CUDA_VISIBLE_DEVICES=0 python /code/naive_rewrite.py --model_name "$model" --file_name 'quote_author' --tensor_parallel_size "$num" --gpu_memory_utilization "$memory" --prompt "$prompt"
37+
CUDA_VISIBLE_DEVICES=0 python /code/naive_compute.py --model_name "$model" --prompt "$prompt"
38+
```
39+
40+
本文实验的所有模型结果在以下文件夹中: [data/eval](data/eval)
41+
42+
## 重排指标
43+
44+
你可以通过运行脚本`ablation.sh`,来计算各类重排方法的结果(包括我们所设计的重排方法与其他的主流方法):
45+
46+
```
47+
cd QUILL/
48+
#### QUILL's Reranker
49+
CUDA_VISIBLE_DEVICES=0 python /code/ablation.py --file_name 'quote_author' --rerank_fun 'avg_novelty'
50+
51+
#### Other Rerankers
52+
CUDA_VISIBLE_DEVICES=0 LINKER_TYPE="json" JSON_LINKER_PATH="JSON_LINKER.json" python /code/ablation.py --file_name 'quote_author' --rerank_fun 'bm25'
53+
```
54+
55+
本文所使用的所有重排器模型在以下文件夹中: [code/reranker](code/reranker)
56+
对于重排器的所有实验结果在以下文件夹中: [data/eval/ablation](data/eval/ablation)
57+
58+
## 数据
59+
60+
本文所收集的数据在以下文件夹中 [data/rag](data/rag)。 所有样本已做匿名处理。
61+
62+
## 引用
63+
```
64+
@article{xiao24quill
65+
author = {JinXiao, BoweiZhang, QianyuHe, JiaqingLiang, FengWei, JingleiChen, ZujieLiang, DeqingYang, YanghuaXiao},
66+
title = {QUILL: Quotation Generation Enhancement of Large Language Models},
67+
year = {2024},
68+
}
69+
```

0 commit comments

Comments
 (0)