Wenda Xu commited on
Commit ·
3752a16
1
Parent(s): e31eb42
updates readme
Browse files- README.md +26 -0
- requirements.txt +16 -0
README.md
CHANGED
|
@@ -1,3 +1,29 @@
|
|
| 1 |
---
|
| 2 |
license: cc
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: cc
|
| 3 |
---
|
| 4 |
+
|
| 5 |
+
# InstructScore (SEScore3)
|
| 6 |
+
|
| 7 |
+
An amazing explanation metric (diagnostic report) for text generation evaluation
|
| 8 |
+
|
| 9 |
+
First step, you may download all required dependencies through: pip3 install -r requirements.txt
|
| 10 |
+
|
| 11 |
+
<div align="center">
|
| 12 |
+
<img src="figs/InstructScore_teaser.jpg" width=400px>
|
| 13 |
+
</div>
|
| 14 |
+
|
| 15 |
+
To run our metric, you only need five lines
|
| 16 |
+
|
| 17 |
+
````
|
| 18 |
+
```
|
| 19 |
+
from InstructScore import *
|
| 20 |
+
refs = ["Normally the administration office downstairs would call me when there’s a delivery."]
|
| 21 |
+
outs = ["Usually when there is takeaway, the management office downstairs will call."]
|
| 22 |
+
scorer = InstructScore()
|
| 23 |
+
batch_outputs, scores_ls = scorer.score(refs, outs)
|
| 24 |
+
```
|
| 25 |
+
````
|
| 26 |
+
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
|
requirements.txt
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
sentencepiece
|
| 2 |
+
torch
|
| 3 |
+
pandas
|
| 4 |
+
matplotlib
|
| 5 |
+
sklearn
|
| 6 |
+
wandb
|
| 7 |
+
datasets
|
| 8 |
+
numpy
|
| 9 |
+
wandb
|
| 10 |
+
deepspeed
|
| 11 |
+
flask
|
| 12 |
+
flask_cors
|
| 13 |
+
daal
|
| 14 |
+
fire
|
| 15 |
+
tokenizers
|
| 16 |
+
git+https://github.com/huggingface/transformers@c612628045822f909020f7eb6784c79700813eda
|