Update README.md

README.md

@@ -733,3 +733,84 @@ seg test report:
 ```
   
 </details>
+
+
+
+# Acronyms, abbreviations, and bi-capitalized words
+
+This section briefly demonstrates the models behavior when presented with the following:
+
+1. Acronyms: "NATO"
+2. Fake acronyms: "NHTG" in place of "NATO"
+3. Ambigous term which could be an acronym or proper noun: "Tuny"
+3. Bi-capitalized words: "McDavid"
+4. Intialisms: "p.m."
+
+<details open>
+
+  <summary>Acronyms, etc. inputs</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 = [
+    "the us is a nato member as a nato member the country enjoys security guarantees notably article 5",
+    "the us is a nhtg member as a nhtg member the country enjoys security guarantees notably article 5",
+    "the us is a tuny member as a tuny member the country enjoys security guarantees notably article 5",
+    "connor andrew mcdavid is a canadian professional ice hockey centre and captain of the edmonton oilers of the national hockey league the oilers selected him first overall in the 2015 nhl entry draft mcdavid spent his childhood playing ice hockey against older children",
+    "please rsvp for the party asap preferably before 8 pm tonight",
+]
+
+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>
+  
+```python
+Input: the us is a nato member as a nato member the country enjoys security guarantees notably article 5
+Outputs:
+	The U.S. is a NATO member.
+	As a NATO member, the country enjoys security guarantees, notably Article 5.
+
+Input: the us is a nhtg member as a nhtg member the country enjoys security guarantees notably article 5
+Outputs:
+	The U.S. is a NHTG member.
+	As a NHTG member, the country enjoys security guarantees, notably Article 5.
+
+Input: the us is a tuny member as a tuny member the country enjoys security guarantees notably article 5
+Outputs:
+	The U.S. is a Tuny member.
+	As a Tuny member, the country enjoys security guarantees, notably Article 5.
+
+Input: connor andrew mcdavid is a canadian professional ice hockey centre and captain of the edmonton oilers of the national hockey league the oilers selected him first overall in the 2015 nhl entry draft mcdavid spent his childhood playing ice hockey against older children
+Outputs:
+	Connor Andrew McDavid is a Canadian professional ice hockey centre and captain of the Edmonton Oilers of the National Hockey League.
+	The Oilers selected him first overall in the 2015 NHL entry draft.
+	McDavid spent his childhood playing ice hockey against older children.
+
+Input: please rsvp for the party asap preferably before 8 pm tonight
+Outputs:
+	Please RSVP for the party ASAP, preferably before 8 p.m. tonight.
+```
+
+</details>