Update README.md

README.md

@@ -1,61 +1,73 @@
 ---
 license: apache-2.0
-base_model: Helsinki-NLP/opus-mt-en-inc
-tags:
-- generated_from_trainer
+datasets:
+- opus100
+language:
+- bn
+- en
 metrics:
-- bleu
+- sacrebleu
+pipeline_tag: translation
+widget:
+- text: "Will you come home tonight?"
+  example_title: "Example 1"
+- text: "I am so sorry this is a day late, guys. Unfortunately, my internet was down so it was out of my control."
+  example_title: "Example 2"
 model-index:
-- name: opus-mt-en-inc-finetuned-en-to-bn-fp16
-  results: []
+- name: shhossain/opus-mt-en-to-bn
+  results:
+  - task:
+      type: translation
+      name: Translation
+    dataset:
+      type: opus100
+      name: opus100
+      split: validation       
+    metrics:
+      - type: Bleu
+        value: 12.537400
+      - type: Validation Loss
+        value: 2.120669
+      - type: Training Loss
+        value: 1.771200
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# English-Bengali Translation Model
+This model is finetuned on `Helsinki-NLP/opus-mt-en-inc` for English to Bangla Translation.
 
-# opus-mt-en-inc-finetuned-en-to-bn-fp16
+- **Developed by:** [shhossain](https://github.com/shhossain)
+- **Model type:** [transformer-align]
+- **Language(s) (NLP):** [English, Bengali]
+- **License:** [apache-2.0]
+- **Finetuned from model [Helsinki-NLP/opus-mt-en-inc]:** [Helsinki-NLP/opus-mt-en-inc](Helsinki-NLP/opus-mt-en-inc)
 
-This model is a fine-tuned version of [Helsinki-NLP/opus-mt-en-inc](https://huggingface.co/Helsinki-NLP/opus-mt-en-inc) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 1.8782
-- Bleu: 21.613
-- Gen Len: 21.9459
+## Use with transformers
+```python
+from transformers import pipeline
 
-## Model description
+pipe = pipeline("translation", model="shhossain/opus-mt-en-to-bn")
+```
 
-More information needed
+## Use with BanglaTranslationKit
 
-## Intended uses & limitations
+BanglaTranslationKit is an open-source translation package for offline conversion between both Bengali and English languages (English to Bangla and Bangla to English)
 
-More information needed
+### Installation
 
-## Training and evaluation data
+```bash
+pip install bntrans
+```
 
-More information needed
+### Usage
 
-## Training procedure
+You can use this package to translate any Bangla to English or English to Bangla.
 
-### Training hyperparameters
+```python
+from bntrans import Translator
 
-The following hyperparameters were used during training:
-- learning_rate: 1e-05
-- train_batch_size: 16
-- eval_batch_size: 16
-- seed: 42
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- num_epochs: 1
+translator = Translator(src="en", dest="bn")
+translation = translator.translate("Hello world!")  #  ্যালো বিশ্ব!
+print(translation)
+```
 
-### Training results
-
-| Training Loss | Epoch | Step   | Validation Loss | Bleu   | Gen Len |
-|:-------------:|:-----:|:------:|:---------------:|:------:|:-------:|
-| 1.9652        | 1.0   | 171895 | 1.8782          | 21.613 | 21.9459 |
-
-
-### Framework versions
-
-- Transformers 4.32.1
-- Pytorch 2.0.1+cu118
-- Datasets 2.14.4
-- Tokenizers 0.13.3
+More info on [BanglaTranslationKit](https://github.com/shhossain/BanglaTranslationKit)