Update README.md

README.md

@@ -1,15 +1,29 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- nepali
+- roman english
+- translation
+- transliteration
+license: apache-2.0
+datasets:
+- syubraj/roman2nepali-transliteration
+language:
+- ne
+- en
+base_model:
+- google/mt5-small
+new_version: syubraj/romaneng2nep
+pipeline_tag: translation
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+Model Trained for 8500 steps on <110k dataset.
+
 
 
 
-## Model Details
 
 ### Model Description
 
@@ -17,13 +31,10 @@ tags: []
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **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]
+- **Model type:** (google/mt5-small)
+- **Language(s) (NLP, Nepali, English):** 
+- **License:** [Apache license 2.0]
+- **Finetuned from model [google/mt5-small]:** 
 
 ### Model Sources [optional]
 
@@ -33,167 +44,83 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 - **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. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## 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. -->
-
-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 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]
-
-### 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]
-
-
-#### Training Hyperparameters
-
-- **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]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
+```Python
 
-<!-- This section describes the evaluation protocols and provides the results. -->
+from transformers import AutoTokenizer, MT5ForConditionalGeneration
 
-### Testing Data, Factors & Metrics
+checkpoint = "syubraj/RomanEng2Nep-v2"
+tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+model = MT5ForConditionalGeneration.from_pretrained(checkpoint)
 
-#### Testing Data
+# Set max sequence length
+max_seq_len = 20
 
-<!-- This should link to a Dataset Card if possible. -->
+def translate(text):
+    # Tokenize the input text with a max length of 20
+    inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=max_seq_len)
 
-[More Information Needed]
+    # Generate translation
+    translated = model.generate(**inputs)
 
-#### Factors
+    # Decode the translated tokens back to text
+    translated_text = tokenizer.decode(translated[0], skip_special_tokens=True)
+    return translated_text
 
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+# Example usage
+source_text = "timilai kasto cha?"  # Example Romanized Nepali text
+translated_text = translate(source_text)
+print(f"Translated Text: {translated_text}")
+```
 
-[More Information Needed]
 
-#### 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]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[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. -->
-
-**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]
+### Training Data
 
-## More Information [optional]
+[syubraj/roman2nepali-transliteration](https://huggingface.co/datasets/syubraj/roman2nepali-transliteration)
 
-[More Information Needed]
 
-## Model Card Authors [optional]
+#### Training Hyperparameters
 
-[More Information Needed]
+- **Training regime:**
+```Python
+training_args = Seq2SeqTrainingArguments(
+    output_dir="/content/drive/MyDrive/romaneng2nep_v2/",
+    eval_strategy="steps",
+    learning_rate=2e-5,
+    per_device_train_batch_size=16,
+    per_device_eval_batch_size=8,
+    weight_decay=0.01,
+    save_total_limit=3,
+    num_train_epochs=2,
+    predict_with_generate=True,
+)
+```
+
+## Training and Validation Metrics
+
+| Step | Training Loss | Validation Loss | Gen Len |
+|------|---------------|-----------------|---------|
+| 500  | 21.636200     | 9.776628        | 2.001900 |
+| 1000 | 10.103400     | 6.105016        | 2.077900 |
+| 1500 | 6.830800      | 5.081259        | 3.811600 |
+| 2000 | 6.003100      | 4.702793        | 4.237300 |
+| 2500 | 5.690200      | 4.469123        | 4.700000 |
+| 3000 | 5.443100      | 4.274406        | 4.808300 |
+| 3500 | 5.265300      | 4.121417        | 4.749400 |
+| 4000 | 5.128500      | 3.989708        | 4.782300 |
+| 4500 | 5.007200      | 3.885391        | 4.805100 |
+| 5000 | 4.909600      | 3.787640        | 4.874800 |
+| 5500 | 4.836000      | 3.715750        | 4.855500 |
+| 6000 | 4.733000      | 3.640963        | 4.962000 |
+| 6500 | 4.673500      | 3.587330        | 5.011600 |
+| 7000 | 4.623800      | 3.531883        | 5.068300 |
+| 7500 | 4.567400      | 3.481622        | 5.108500 |
+| 8000 | 4.523200      | 3.445404        | 5.092700 |
+| 8500 | 4.464000      | 3.413630        | 5.132700 |
 
-## Model Card Contact
 
-[More Information Needed]