Update README.md
Browse files
README.md
CHANGED
|
@@ -1,67 +1,66 @@
|
|
| 1 |
-
---
|
| 2 |
-
language:
|
| 3 |
-
- en
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
-
|
| 8 |
-
- ibani
|
| 9 |
-
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
- **
|
| 45 |
-
- **
|
| 46 |
-
- **
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
-
|
| 52 |
-
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
```
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- en
|
| 4 |
+
license: apache-2.0
|
| 5 |
+
tags:
|
| 6 |
+
- translation
|
| 7 |
+
- ibani
|
| 8 |
+
- english-to-ibani
|
| 9 |
+
- low-resource
|
| 10 |
+
library_name: transformers
|
| 11 |
+
pipeline_tag: translation
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# English to Ibani Translation Model
|
| 15 |
+
|
| 16 |
+
This model translates English text to Ibani language. It's fine-tuned from Helsinki-NLP/opus-mt-en-mul.
|
| 17 |
+
|
| 18 |
+
## Usage
|
| 19 |
+
|
| 20 |
+
```python
|
| 21 |
+
from transformers import MarianMTModel, MarianTokenizer
|
| 22 |
+
|
| 23 |
+
model = MarianMTModel.from_pretrained("your-username/ibani-translator")
|
| 24 |
+
tokenizer = MarianTokenizer.from_pretrained("your-username/ibani-translator")
|
| 25 |
+
|
| 26 |
+
text = "I eat fish"
|
| 27 |
+
inputs = tokenizer(text, return_tensors="pt")
|
| 28 |
+
outputs = model.generate(**inputs)
|
| 29 |
+
translation = tokenizer.decode(outputs[0], skip_special_tokens=True)
|
| 30 |
+
print(translation)
|
| 31 |
+
```
|
| 32 |
+
|
| 33 |
+
## Training Data
|
| 34 |
+
|
| 35 |
+
Trained on English-Ibani parallel sentences from the ibani_eng dataset.
|
| 36 |
+
|
| 37 |
+
## Performance
|
| 38 |
+
|
| 39 |
+
[Add your evaluation metrics here]
|
| 40 |
+
|
| 41 |
+
## Model Details
|
| 42 |
+
|
| 43 |
+
- **Base Model**: Helsinki-NLP/opus-mt-en-mul
|
| 44 |
+
- **Language Pair**: English → Ibani
|
| 45 |
+
- **Task**: Machine Translation
|
| 46 |
+
- **Framework**: Hugging Face Transformers
|
| 47 |
+
|
| 48 |
+
## Limitations
|
| 49 |
+
|
| 50 |
+
- This is a low-resource language model
|
| 51 |
+
- Performance may vary with complex sentence structures
|
| 52 |
+
- Best results with simple to moderate complexity sentences
|
| 53 |
+
|
| 54 |
+
## Citation
|
| 55 |
+
|
| 56 |
+
If you use this model, please cite:
|
| 57 |
+
|
| 58 |
+
```bibtex
|
| 59 |
+
@misc{ibani-translator,
|
| 60 |
+
author = {Your Name},
|
| 61 |
+
title = {English to Ibani Translation Model},
|
| 62 |
+
year = {2025},
|
| 63 |
+
publisher = {Hugging Face},
|
| 64 |
+
howpublished = {\url{https://huggingface.co/your-username/ibani-translator}}
|
| 65 |
+
}
|
| 66 |
+
```
|
|
|