Update README.md

README.md

@@ -1,3 +1,65 @@
 ---
-license: unknown
+language:
+- si
+metrics:
+- accuracy
+- bleu
+tags:
+- Romanized Sinhala
+- Sinhala
+- Transliteration
 ---
+
+---
+# Model Card for Model ID
+
+This Repo is about Romanized Sinhala to Sinhala Transliteration using the Ngram and Rule Base Model.
+
+
+### Model Description
+
+This dataset is capable of handling short-hand typing(Adhoc Transliteration).
+
+eg
+Input: khmda
+Output : කොහොමද
+
+
+If you are using this work:
+Kindly cite :
+T. G. D. K. Sumanathilaka, R. Weerasinghe and Y. H. P. P. Priyadarshana, "Swa-Bhasha: Romanized Sinhala to Sinhala Reverse Transliteration using a Hybrid Approach," 2023 3rd International Conference on Advanced Research in Computing (ICARC), Belihuloya, Sri Lanka, 2023, pp. 136-141, doi: 10.1109/ICARC57651.2023.10145648. keywords: {Terminology;Social networking (online);Computational modeling;Knowledge based systems;Message services;Data structures;Data models;Romanized Sinhala;Transliteration;Tri-gram;Rule-based;Prediction;Suggestion},
+
+The datasets used can be accessed Through :
+https://github.com/Sumanathilaka/Swa-Bhasha-Sinhala-Singlish-Dataset
+
+- **Developed by:** Deshan sumanathilaka
+- **Model type:** Ngram Model
+- **Language(s) (NLP):** Python
+- **License:** IEEE
+
+
+- **Paper [optional]:** 
+T. G. D. K. Sumanathilaka, R. Weerasinghe and Y. H. P. P. Priyadarshana, "Swa-Bhasha: Romanized Sinhala to Sinhala Reverse Transliteration using a Hybrid Approach," 2023 3rd International Conference on Advanced Research in Computing (ICARC), Belihuloya, Sri Lanka, 2023, pp. 136-141, doi: 10.1109/ICARC57651.2023.10145648. keywords: {Terminology;Social networking (online);Computational modeling;Knowledge based systems;Message services;Data structures;Data models;Romanized Sinhala;Transliteration;Tri-gram;Rule-based;Prediction;Suggestion},
+
+- **Demo [optional]:** https://youtu.be/w6kdIDzoov4
+
+## Uses
+
+Romanized Sinhala to Sinhala Transliteration
+
+
+
+## How to Get Started with the Model
+
+Download all the files from the repo.
+You can open Transliterator.py file
+Call the function triGramTranslate(inputStr) with an input String in Romanized Sinhala.
+
+
+## Model Card Authors [optional]
+
+Deshan Sumanathilaka
+
+## Model Card Contact
+
+[email protected]