Update README.md

README.md

@@ -11,7 +11,26 @@ tags:
 - trl
 ---
 
-# Uploaded  model
+# Finetuned phi-3 mini model for data extraction / pii redaction
+
+Trained using synthetic data, this model will provide a JSON output containing:
+
+With user input:
+`My order hasn't arrived, it's order number 123456 and my email is johnsmith@gmail.com, please can you provide an update! Thanks John.`
+
+The model will respond with:
+
+```
+{
+  "redacted_message": "My order hasn't arrived, it's order number {order_number} and my email is {email}, please can you provide an update! Thanks {name}.",
+  "data": {
+    "order_number": "123456",
+    "email": "johnsmith@gmail.com",
+    "name": "John",
+
+  }
+}
+```
 
 - **Developed by:** mattlanham
 - **License:** apache-2.0