Update README.md

README.md

@@ -3,4 +3,37 @@ license: agpl-3.0
 language:
 - en
 - cop
----
+---
+
+
+# How To Use This Model
+
+## Sahidic Example With No Confidence Score
+```
+from transformers import pipeline
+
+pipe = pipeline(model="megalaa/english-coptic-translator", trust_remote_code=True)
+
+output = pipe("Jesus Christ")
+print(output)
+# {'translation': 'ⲓⲏⲥⲟⲩⲥ ⲡⲉⲭⲣⲓⲥⲧⲟⲥ.'}
+
+```
+
+## Parameters
+By default, this models translates from English to Sahidic Coptic.
+
+Use `to_bohairic=True` if you are translating from English to Bohairic Coptic.
+
+Additionally, use `output_confidence=True` if you want to output the model confidence.
+
+## Bohairic Example With Confidence Score
+
+```
+from transformers import pipeline
+
+pipe = pipeline(model="megalaa/english-coptic-translator", trust_remote_code=True)
+output = pipe("Jesus Christ", to_bohairic=True, output_confidence=True)
+print(output)
+# {'translation': 'ⲓⲏⲥⲟⲩⲥ ⲡⲓⲭⲣⲓⲥⲧⲟⲥ', 'confidence': 0.9277395772214944}
+```