MyanmarGPT-Chat

README.md

@@ -0,0 +1,126 @@
+---
+license: creativeml-openrail-m
+language:
+- my
+- en
+library_name: transformers
+tags:
+- chat
+- myanmar
+- burmese
+- llm
+widget:
+  - text: "User: မြန်မာနိုင်ငံအကြောင်းရှင်းပြပါ။\n Assistant: "
+    example_title: Example 1
+  - text: "User: ရုရှားနိုင်ငံအကြောင်းပြောပြပါ\n Assistant: "
+    example_title: Example 2
+  - text: "User: ကွန်မြူနစ်ဆိုတာဘာလဲ\n Assistant: "
+    example_title: Example 3
+---
+
+# MyanmarGPT-Chat
+
+
+MyanmarGPT-Chat is a question answering model available in Burmese language. It is fine-tuned via the foundational model called [MyanmarGPT](https://huggingface.co/jojo-ai-mst/MyanmarGPT).
+
+Dataset used is called "A Brief History of the World" curated by the creator, Min Si Thu.
+It can answer general knowledge about world history.
+
+
+## Model Details
+
+MyanmarGPT-Chat is based on MyanmarGPT model. 
+As MyanmarGPT is a frontier model for Burmese language and it is getting used by lots of people around Myanmar,
+MyanmarGPT-Chat is required to build as a foundational model for question-answering language model.
+
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+
+
+- **Developed by:** [Min Si Thu](https://huggingface.co/jojo-ai-mst)
+- **Funded by [self]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Model type:** GPT2
+- **Language(s) (NLP):** Burmese, English
+- **License:** CreativeML OpenRAIL-M
+- **Finetuned from model [MyanmarGPT]:** [MyanmarGPT](https://huggingface.co/jojo-ai-mst/MyanmarGPT)
+
+### Model Sources [optional]
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [https://github.com/MinSiThu/MyanmarGPT]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+
+### Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+Originally crafted for text completion in Burmese, this model functions as a fundamental asset for various Natural Language Processing (NLP) tasks. Although its primary role is presently centered on aiding in text generation and completion, it harbors considerable potential for broader applications. Researchers and developers have the option to refine this model using specialized datasets, thereby expanding its utility to other NLP domains, including summarization and instruction-based tasks. Nevertheless, it is crucial to acknowledge that when dealing with high-stakes decisions or comprehending domain-specific terminology, additional specialized training for the model is advised to ensure optimal accuracy and reliability.
+
+### Out-of-Scope Use
+
+Users need to recognize the inherent limitations and biases present in language models. Responsible usage is crucial, particularly in sensitive contexts, as this model is not designed to generate misleading or harmful content.
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+While the MyanmarGPT-Chat excels in handling general Burmese text about history of countires around the world, its effectiveness might be limited when dealing with daily-life spoken burmese words. Users are encouraged to perform comprehensive testing tailored to their specific use cases.
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+
+## How to Get Started with the Model
+
+```shell
+!pip install transformers
+```
+
+```python
+from transformers import GPT2LMHeadModel, GPT2Tokenizer
+
+# Load MyanmarGPT-Chat model and tokenizer
+model = GPT2LMHeadModel.from_pretrained("jojo-ai-mst/MyanmarGPT")
+tokenizer = GPT2Tokenizer.from_pretrained("jojo-ai-mst/MyanmarGPT")
+
+def generate_text(prompt, max_length=300, temperature=0.8, top_k=50):
+    input_ids = tokenizer.encode(prompt, return_tensors="pt").cuda() # remove .cude() if only cpu
+    output = model.generate(
+        input_ids,
+        max_length=max_length,
+        temperature=temperature,
+        top_k=top_k,
+        pad_token_id=tokenizer.eos_token_id,
+        do_sample=True
+    )
+    for result in output:
+      generated_text = tokenizer.decode(result, skip_special_tokens=True)
+      print(generated_text)
+
+generate_text("User: မြန်မာနိုင်ငံအကြောင်းရှင်းပြပါ။\n Assistant: ")
+
+```
+
+
+
+## Citation [optional]
+
+- MinSithu, MyanmarGPT, https://huggingface.co/jojo-ai-mst/MyanmarGPT, 1.1-SweptWood
+
+## Model Card Contact
+
+[More Information Needed]