Update README.md

README.md

@@ -57,42 +57,27 @@ We make available the models presented in our paper.
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+## Text Revision Task
+Given an edit instruction and an original text, our model can generate the edited version of the text.<br>
 
-### Direct Use
+![task_specs](https://huggingface.co/grammarly/coedit-xl/resolve/main/Screen%20Shot%202023-05-12%20at%203.36.37%20PM.png)
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+## Usage
+```python
+from transformers import AutoTokenizer, T5ForConditionalGeneration
 
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
+tokenizer = AutoTokenizer.from_pretrained("grammarly/coedit-xl")
+model = T5ForConditionalGeneration.from_pretrained("grammarly/coedit-xl")
+input_text = 
+input_ids = tokenizer(input_text, return_tensors="pt").input_ids
+outputs = model.generate(input_ids, max_length=256)
+edited_text = tokenizer.decode(outputs[0], skip_special_tokens=True)[0]
 
+before_input = 'Fix grammatical errors in this sentence: New kinds of vehicles will be invented with new technology than today.'
+model_input = tokenizer(before_input, return_tensors='pt')
+model_outputs = model.generate(**model_input, num_beams=8, max_length=1024)
+after_text = tokenizer.batch_decode(model_outputs, skip_special_tokens=True)[0]
+```
 
 
 #### Software
@@ -106,4 +91,4 @@ https://github.com/vipulraheja/coedit
 
 **APA:**
 
-[More Information Needed]
+[More Information Needed]