Update README.md

README.md

@@ -30,4 +30,29 @@ model-index:
       type: pass@1
       value: 0.3696
       verified: false
----
+---
+EditCoder-6.7b (version 1) is a fine-tuned version of [DeepSeek Coder](deepseek-ai/deepseek-coder-6.7b-base) (base model, 6.7b parameters) for instructional code editing.
+We utilize [EditPackFT](https://huggingface.co/datasets/nuprl/EditPackFT) as our fine-tuning dataset, and we show state-of-the-art performance among non-distilled open source models
+for code editing, using the [CanItEdit](https://huggingface.co/datasets/nuprl/CanItEdit) benchmark.
+
+More information can be found on [our paper](https://federico.codes/assets/papers/canitedit.pdf).
+
+# Prompt
+The model has been trained on the following prompt format:
+```
+## Code Before:
+{before}
+## Instruction:
+{instruction}
+## Code After:
+{after}
+```
+
+Here is a python function that can be used for formatting the prompt correctly:
+```py
+def edit_prompt(old, instr):
+    before = f"""## Code Before:\n{old}\n"""
+    instr = f"""## Instruction:\n{instr}\n"""
+    after = f"""## Code After:\n"""
+    return before + instr + after
+```