Create README.md

README.md

@@ -0,0 +1,56 @@
+---
+license: creativeml-openrail-m
+language:
+- my
+tags:
+- Myanmar
+- Burmese
+- GPT2
+- MyanmarGPT
+- Nautral Language Processing
+---
+
+# Myanmar-GPT
+
+Myanmar GPT is a model trained on a private Myanmar language dataset made by MinSiThu.
+The project aims to make the Myanmar language available in the GPT2 Model.
+
+Fine-tuning the MyanmarGPT model makes it easier to build a custom Myanmar language model than using alternative language models.
+
+Reports on training the MyanmarGPT model are visualized at [MyanmarGPT Report](https://api.wandb.ai/links/minsithu/wn8yul90).
+
+## How to use in your project
+
+```
+!pip install transformers
+```
+
+```python
+from transformers import pipeline
+
+generator = pipeline(model="jojo-ai-mst/MyanmarGPT")
+outputs = generator("အီတလီ",do_sample=False)
+
+print(outputs)
+# [{'generated_text': 'အီတလီဘုရင့်နိုင်�'}]
+```
+
+
+## Here is the guideline for using the MyanmarGPT license,
+- MyanmarGPT is free to use for everyone,
+  
+- **Must Do**
+  - any project derived/finetuned from MyanmarGPT, used MyanmarGPT internally,
+  - or modified MyanmarGPT, related to MyanmarGPT **must mention the citation below** in the corresponding project's page.
+- the citation
+```latex
+@online{MyanmarGPT,
+  author = {MinSiThu},
+  title = {MyanmarGPT},
+  year = 2023,
+  url = {https://huggingface.co/jojo-ai-mst/MyanmarGPT},
+  urldate = {2023-12-14}
+}
+```
+
+For contact, reach me via [https://www.linkedin.com/in/min-si-thu/](https://www.linkedin.com/in/min-si-thu/)