Update README.md

README.md

@@ -61,6 +61,86 @@ language:
 This is an `xlm-roberta` fine-tuned to restore punctuation, true-case (capitalize), 
 and detect sentence boundaries (full stops) in 47 languages.
 
+# Usage
+
+The easiest way to use this model is to install [punctuators](https://github.com/1-800-BAD-CODE/punctuators):
+
+```bash
+$ pip install punctuators
+```
+
+Though this is just an ONNX and SentencePiece model, so you may run it as you wish.
+
+<details open>
+
+  <summary>Example Usage</summary>
+  
+```python
+
+from typing import List
+
+from punctuators.models import PunctCapSegModelONNX
+
+m: PunctCapSegModelONNX = PunctCapSegModelONNX.from_pretrained(
+    "1-800-BAD-CODE/xlm-roberta_punctuation_fullstop_truecase"
+)
+
+input_texts: List[str] = [
+    # "hello world how's it going did you see the game last night my favorite team was playing and i got to go to "
+    # "the game it went into overtime and i got home late i like most sports but some are kind of boring especially "
+    # "baseball most of the time they aren't really playing they're just standing around waiting for something to "
+    # "happen i wish it were more exiting like football or hockey in those sports you have practically non stop play "
+    # "and everyone is involved in the game at all times unlike in baseball where it's only one person at a time",
+    # "hola mundo cómo estás estamos bajo el sol y hace mucho calor santa coloma abre los huertos urbanos a las escuelas "
+    # "de la ciudad",
+    "hello friend how's it going it's snowing outside right now in connecticut a large storm is moving in",
+    # "未來疫苗將有望覆蓋3歲以上全年齡段美國與北約軍隊已全部撤離還有鐵路公路在內的各項基建的來源都將枯竭",
+    # "በባለፈው ሳምንት ኢትዮጵያ ከሶማሊያ 3 ሺህ ወታደሮቿንም እንዳስወጣች የሶማሊያው ዳልሳን ሬድዮ ዘግቦ ነበር ጸጥታ ሃይሉና ህዝቡ ተቀናጅቶ "
+    # "በመስራቱ በመዲናዋ ላይ የታቀደው የጥፋት ሴራ ከሽፏል",
+    # "all human beings are born free and equal in dignity and rights they are endowed with reason and conscience and "
+    # "should act towards one another in a spirit of brotherhood",
+    # "सभी मनुष्य जन्म से मर्यादा और अधिकारों में स्वतंत्र और समान होते हैं वे तर्क और विवेक से संपन्न हैं तथा उन्हें भ्रातृत्व की भावना से परस्पर के प्रति कार्य करना चाहिए",
+    # "wszyscy ludzie rodzą się wolni i równi pod względem swej godności i swych praw są oni obdarzeni rozumem i "
+    # "sumieniem i powinni postępować wobec innych w duchu braterstwa",
+    # "tous les êtres humains naissent libres et égaux en dignité et en droits ils sont doués de raison et de conscience "
+    # "et doivent agir les uns envers les autres dans un esprit de fraternité",
+]
+input_texts: List[str] = [
+    "hola mundo cómo estás estamos bajo el sol y hace mucho calor santa coloma abre los huertos urbanos a las escuelas de la ciudad",
+    "hello friend how's it going it's snowing outside right now in connecticut a large storm is moving in",
+    "未來疫苗將有望覆蓋3歲以上全年齡段美國與北約軍隊已全部撤離還有鐵路公路在內的各項基建的來源都將枯竭",
+    "በባለፈው ሳምንት ኢትዮጵያ ከሶማሊያ 3 ሺህ ወታደሮቿንም እንዳስወጣች የሶማሊያው ዳልሳን ሬድዮ ዘግቦ ነበር ጸጥታ ሃይሉና ህዝቡ ተቀናጅቶ በመስራቱ በመዲናዋ ላይ የታቀደው የጥፋት ሴራ ከሽፏል",
+    "all human beings are born free and equal in dignity and rights they are endowed with reason and conscience and should act towards one another in a spirit of brotherhood",
+    "सभी मनुष्य जन्म से मर्यादा और अधिकारों में स्वतंत्र और समान होते हैं वे तर्क और विवेक से संपन्न हैं तथा उन्हें भ्रातृत्व की भावना से परस्पर के प्रति कार्य करना चाहिए",
+    "wszyscy ludzie rodzą się wolni i równi pod względem swej godności i swych praw są oni obdarzeni rozumem i sumieniem i powinni postępować wobec innych w duchu braterstwa",
+    "tous les êtres humains naissent libres et égaux en dignité et en droits ils sont doués de raison et de conscience et doivent agir les uns envers les autres dans un esprit de fraternité",
+]
+
+results: List[List[str]] = m.infer(
+    texts=input_texts, apply_sbd=True,
+)
+for input_text, output_texts in zip(input_texts, results):
+    print(f"Input: {input_text}")
+    print(f"Outputs:")
+    for text in output_texts:
+        print(f"\t{text}")
+    print()
+
+```
+
+</details>
+
+
+<details open>
+
+  <summary>Expected output</summary>
+
+```text
+
+```
+
+</details>
+
 # Model Architecture
 This model implements the following graph, which allows punctuation, true-casing, and fullstop prediction 
 in every language without language-specific behavior: