Update README.md

README.md

@@ -7,7 +7,6 @@ tags:
 - transformers
 language:
 - bn
-- en
 metrics:
 - chrf
 - bleu
@@ -26,156 +25,111 @@ Translate Bangla sentences to Bangla Sign Language(BdSL) gloss with a lightweigh
 <!-- Provide a longer summary of what this model is. -->
 
 
-- **Developed by:** [Sharif Mohammad Abdullah]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** Sharif Mohammad Abdullah
+<!-- - **Shared by [optional]:** [More Information Needed] -->
+<!-- - **Model type:** [More Information Needed] -->
+- **Language(s) (NLP):** Bangla to Bangla Gloss
+<!-- - **License:** [More Information Needed] -->
+- **Finetuned from model:** mbart-large-50
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+<!-- - **Repository:** [More Information Needed] -->
+- **Paper [optional]:** https://arxiv.org/abs/2504.02293
 
 ## 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
+You can use the following snippet to do a test run for a sample sentence:
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+```
+from transformers import MBartForConditionalGeneration, AutoTokenizer
+from peft import PeftModel
 
-[More Information Needed]
+model_path = "ayhay/BanglaText2Gloss" 
+base_id = "facebook/mbart-large-50"
 
-### Downstream Use [optional]
+# 1. Load Tokenizer & Model with Adapters
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+base_model = MBartForConditionalGeneration.from_pretrained(base_id)
+model = PeftModel.from_pretrained(base_model, model_path)
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+# 2. Run Translation
+text = "আপনি কেমন আছেন?" 
+inputs = tokenizer(text, return_tensors="pt")
 
-[More Information Needed]
+output_tokens = model.generate(**inputs, max_new_tokens=50)
+gloss = tokenizer.batch_decode(output_tokens, skip_special_tokens=True)
+
+print(f"Bangla: {text}")
+print(f"Sign Gloss: {gloss[0]}")
+```
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+The model will not work for any languages other than Bangla.
 
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
+<!-- ## Bias, Risks, and Limitations
+ -->
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+<!-- [More Information Needed] -->
 
-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
-
-Use the code below to get started with the model.
-
-[More Information Needed]
+<!-- ## Training Details -->
 
-## Training Details
-
-### Training Data
+<!-- ### Training Data -->
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Training Procedure
+<!-- ### Training Procedure -->
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
-
-[More Information Needed]
-
+<!-- #### Preprocessing [optional] -->
 
-#### Training Hyperparameters
+<!-- [More Information Needed] -->
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
-#### Speeds, Sizes, Times [optional]
+<!-- #### Training Hyperparameters -->
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+<!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> -->
 
-[More Information Needed]
 
-## Evaluation
+<!-- ## Evaluation -->
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics -->
 
-#### Testing Data
+<!-- #### Testing Data -->
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+<!-- [More Information Needed] -->
 
-[More Information Needed]
-
-#### Metrics
+<!-- #### Metrics -->
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 
 ## Citation [optional]
 
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+If you use this model in your works, pleasae cite using the following bibtex format:
 
 **BibTeX:**
 
 [More Information Needed]
 
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
 ### Framework versions
 
 - PEFT 0.18.0