updates readme

README.md

@@ -1,3 +1,29 @@
 ---
 license: cc
 ---
+
+# InstructScore (SEScore3)
+
+An amazing explanation metric (diagnostic report) for text generation evaluation
+
+First step, you may download all required dependencies through: pip3 install -r requirements.txt
+
+<div  align="center"> 
+<img src="figs/InstructScore_teaser.jpg" width=400px>
+</div>
+
+To run our metric, you only need five lines
+
+````
+```
+from InstructScore import *
+refs = ["Normally the administration office downstairs would call me when there’s a delivery."]
+outs = ["Usually when there is takeaway, the management office downstairs will call."]
+scorer = InstructScore()
+batch_outputs, scores_ls = scorer.score(refs, outs)
+```
+````
+
+![Overview](figs/InstructScore.jpg)
+
+

requirements.txt

@@ -0,0 +1,16 @@
+sentencepiece
+torch
+pandas
+matplotlib
+sklearn
+wandb
+datasets
+numpy
+wandb
+deepspeed
+flask
+flask_cors
+daal
+fire
+tokenizers
+git+https://github.com/huggingface/transformers@c612628045822f909020f7eb6784c79700813eda