myanmar-ghost / model_card.md
amkyawdev's picture
Add docs
723f202 verified
|
Raw
History Blame Contribute Delete
2.25 kB
# Myanmar Ghost Model Card
## 🏷️ Model Overview
**Model Name**: Myanmar-Ghost-Instruct
**Model Type**: Text Classification (Sentiment Analysis)
**Language**: Myanmar (Burmese)
**Version**: 1.0.0
**Last Updated**: 2025
## πŸ“Š Model Description
Myanmar Ghost is an advanced sentiment analysis model for Myanmar language that classifies text into 4 sentiment categories with multi-modal capability (audio + text).
### Capabilities
- Myanmar text sentiment classification
- Multi-modal fusion (audio prosody + text)
- Explainable AI (SHAP, LIME)
- Privacy-preserving (Federated Learning ready)
### Limitations
- Best performance on formal Myanmar text
- May struggle with heavy use of emoji/emoticons
- Limited performance on code-mixed text
## πŸ“ˆ Training Data
- **Source**: Myanmar speech datasets
- **Size**: ~1M samples
- **Splits**: 80% train, 10% validation, 10% test
## βš™οΈ Model Architecture
```
Transformer (BERT-based multilingual)
β”œβ”€β”€ Hidden Size: 768
β”œβ”€β”€ Layers: 12
β”œβ”€β”€ Heads: 12
└── Classifier Head
└── 4-class output (negative, neutral, positive, sarcastic)
```
## πŸ“‰ Performance
| Metric | Score |
|--------|-------|
| Accuracy | ~92% |
| F1 (weighted) | ~91% |
| F1 (macro) | ~89% |
| Precision | ~91% |
| Recall | ~91% |
## πŸ”§ Usage
### Python
```python
from transformers import AutoModelForSequenceClassification, AutoTokenizer
model_name = "amkyawdev/Myanmar-Ghost-Instruct"
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForSequenceClassification.from_pretrained(model_name)
# Predict
text = "ကျေးဇူးပါ"
inputs = tokenizer(text, return_tensors="pt")
outputs = model(**inputs)
```
### API
```bash
curl -X POST http://localhost:8000/predict \
-H "Content-Type: application/json" \
-d '{"text": "ကျေးဇူးပါ"}'
```
## ⚠️ Ethical Considerations
- Model trained on publicly available Myanmar data
- No personally identifiable information used
- Regular evaluation for bias
## πŸ“ Citation
```
@software{myanmar_ghost,
title = {Myanmar Ghost},
author = {Aung Myo Kyaw},
url = {https://huggingface.co/amkyawdev/Myanmar-Ghost-Instruct},
year = {2025},
}
```
## 🀝 License
Apache 2.0